Files
librenms-librenms/includes/polling/applications/puppet-agent.inc.php
Zane C. Bowers-Hadley 0bbcde1227 add the ability for storing app data to prevent spamming of the event log via via component usage (#14087)
* initial work on add the ability to save/fetch app data

* update to use get_app_data for ZFS

* update the poller for the new app_data stuff

* ZFS now logs changes to pools

* add schema update for app_data stuff

* small formatting fix

* add a missing \

* now adds a column

* sql-schema is no longer used, so remove the file that was added here

* misc cleanups

* rename the method in database/migrations/2022_07_03_1947_add_app_data.php

* hopefully fix the migration bit

* add the column to misc/db_schema.yaml

* more misc small DB fixes

* update the test as the json column uses collat of utf8mb4_bin

* revert the last change and try manually setting it to what is expected

* remove a extra ;

* update suricata as well

* correct the instance -> instances in one location to prevent the old instance list from being stomped

* remove a extra ;

* update fail2ban to use it as well

* remove two unused functions as suricata and fail2ban no longer use components

* style cleanup

* postgres poller updated to use it

* update html side of the postgres bits

* chronyd now uses app data bits now as well

* portactivity now uses it as well

* style fix

* sort the returned arrays from app_data

* correct log message for port activity

* collocation change

* try re-ordering it

* add in the new data column to the tests

* remove a extra ,

* hmm... ->collate('utf8mb4_unicode_ci') is not usable as apparently collate does not exist

* change the column type from json to longtext

* mv chronyd stuff while I sort out the rest of the tests... damn thing is always buggy

* hmm... fix a missing line then likely move stuff back

* style fix

* add fillable

* add the expexcted data for fail2ban json

* escape a " I missed

* add data for portactivity

* add suricata app data

* add app data to zfs legacy test

* put the moved tests back into place and update zfs-v1 test

* add app data for chronyd test

* add app data for fail2ban legacy test

* update zfs v1 app data

* add some notes on application dev work

* add Developing/Application-Notes.md to mkdocs.yml

* add data column to it

* added various suggestions from bennet-esyoil

* convert from isset to sizeof

* type fix

* fully remove the old save app data function and move it into a helper function... the other still needs cleaned up prior to removal

* update docs

* get_app_data is fully removed now as well

* a few style fixes

* add $casts

* update chronyd test

* attempt to fix the data

* more doc cleanup and try changing the cast

* style fix

* revert the changes to the chronyd test

* apply a few of murrant's suggestions

* document working with ->data as json and non-josn

* remove two no-longer used in this PR exceptions

* ->data now operates transparently

* style fix

* update data tests

* fix json

* test fix

* update the app notes to reflect how app data now works

* app test fix

* app data fix for linux_lsi

* json fix

* minor doc cleanup

* remove duplicate querty and use json_decode instead

* style fix

* modelize the app poller

* use a anon func instead of foreach

* test update

* style cleanup

* style cleanup

* another test cleanup

* more test cleanup

* reverse the test changes and add in some more glue code

* revert one of the test changes

* another small test fix

* Make things use models
Left some array access, but those will still work just fine.

* missed chronyd and portactivity

* rename poll to avoid make it any confusion

* Remove extra save and fix timestamp

* save any changes made to app->data

* nope, that was not it

* What are magic methods and how do they work?

* fix two typos

* update linux_lsi test

* change quote type

Co-authored-by: Tony Murray <murraytony@gmail.com>
2022-07-22 16:01:55 -05:00

140 lines
4.5 KiB
PHP

<?php
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppMissingKeysException;
use LibreNMS\RRD\RrdDefinition;
$name = 'puppet-agent';
$output = 'OK';
try {
$puppet_agent_data = json_app_get($device, $name, 1)['data'];
} catch (JsonAppMissingKeysException $e) {
$puppet_agent_data = $e->getParsedJson();
} catch (JsonAppException $e) {
echo PHP_EOL . $name . ':' . $e->getCode() . ':' . $e->getMessage() . PHP_EOL;
update_application($app, $e->getCode() . ':' . $e->getMessage(), []); // Set empty metrics and error message
return;
}
$puppet_changes = $puppet_agent_data['changes'];
$puppet_events = $puppet_agent_data['events'];
$puppet_resources = $puppet_agent_data['resources'];
$puppet_time = $puppet_agent_data['time'];
$metrics = [];
//
// Changes Processing
//
$rrd_name = ['app', $name, $app->app_id, 'changes'];
$rrd_def = RrdDefinition::make()
->addDataset('total', 'GAUGE', 0);
$fields = [
'total' => $puppet_changes['total'],
];
$metrics['changes'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
//
// Events Processing
//
$rrd_name = ['app', $name, $app->app_id, 'events'];
$rrd_def = RrdDefinition::make()
->addDataset('success', 'GAUGE', 0)
->addDataset('failure', 'GAUGE', 0)
->addDataset('total', 'GAUGE', 0);
$fields = [
'success' => $puppet_events['success'],
'failure' => $puppet_events['failure'],
'total' => $puppet_events['total'],
];
$metrics['events'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
//
// Resources Processing
//
$rrd_name = ['app', $name, $app->app_id, 'resources'];
$rrd_def = RrdDefinition::make()
->addDataset('changed', 'GAUGE', 0)
->addDataset('corrective_change', 'GAUGE', 0)
->addDataset('failed', 'GAUGE', 0)
->addDataset('failed_to_restart', 'GAUGE', 0)
->addDataset('out_of_sync', 'GAUGE', 0)
->addDataset('restarted', 'GAUGE', 0)
->addDataset('scheduled', 'GAUGE', 0)
->addDataset('skipped', 'GAUGE', 0)
->addDataset('total', 'GAUGE', 0);
$fields = [
'changed' => $puppet_resources['changed'],
'corrective_change' => $puppet_resources['corrective_change'],
'failed' => $puppet_resources['failed'],
'failed_to_restart' => $puppet_resources['failed_to_restart'],
'out_of_sync' => $puppet_resources['out_of_sync'],
'restarted' => $puppet_resources['restarted'],
'scheduled' => $puppet_resources['scheduled'],
'skipped' => $puppet_resources['skipped'],
'total' => $puppet_resources['total'],
];
$metrics['resources'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
//
// Time Processing
//
$rrd_name = ['app', $name, $app->app_id, 'time'];
$rrd_def = RrdDefinition::make()
->addDataset('catalog_application', 'GAUGE', 0)
->addDataset('config_retrieval', 'GAUGE', 0)
->addDataset('convert_catalog', 'GAUGE', 0)
->addDataset('fact_generation', 'GAUGE', 0)
->addDataset('node_retrieval', 'GAUGE', 0)
->addDataset('plugin_sync', 'GAUGE', 0)
->addDataset('schedule', 'GAUGE', 0)
->addDataset('transaction_evaluation', 'GAUGE', 0)
->addDataset('total', 'GAUGE', 0);
$fields = [
'catalog_application' => $puppet_time['catalog_application'],
'config_retrieval' => $puppet_time['config_retrieval'],
'convert_catalog' => $puppet_time['convert_catalog'],
'fact_generation' => $puppet_time['fact_generation'],
'node_retrieval' => $puppet_time['node_retrieval'],
'plugin_sync' => $puppet_time['plugin_sync'],
'schedule' => $puppet_time['schedule'],
'transaction_evaluation' => $puppet_time['transaction_evaluation'],
'total' => $puppet_time['total'],
];
$metrics['time'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
//
// Last Rung Processing
//
$rrd_name = ['app', $name, $app->app_id, 'last_run'];
$rrd_def = RrdDefinition::make()
->addDataset('last_run', 'GAUGE', 0);
$fields = [
'last_run' => round(intval($puppet_time['last_run']) / 60, 0), // diff seconds to minutes
];
$metrics['last_run'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
update_application($app, $output, $metrics);