Files
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

112 lines
4.8 KiB
PHP

<?php
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\RRD\RrdDefinition;
$name = 'chronyd';
try {
$chronyd = json_app_get($device, $name, 1)['data'];
} 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;
}
$rrd_name = ['app', $name, $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('stratum', 'GAUGE', 0, 15)
->addDataset('reference_time', 'DCOUNTER', 0.0, 10000000000) // good until year 2286
->addDataset('system_time', 'GAUGE', -10000.0, 10000.0)
->addDataset('last_offset', 'GAUGE', -1000.0, 1000.0)
->addDataset('rms_offset', 'GAUGE', -1000.0, 1000.0)
->addDataset('frequency', 'GAUGE', -1000.0, 1000.0)
->addDataset('residual_frequency', 'GAUGE', -1000.0, 1000.0)
->addDataset('skew', 'GAUGE', -1000.0, 1000.0)
->addDataset('root_delay', 'GAUGE', -1000.0, 1000.0)
->addDataset('root_dispersion', 'GAUGE', -1000.0, 1000.0)
->addDataset('update_interval', 'GAUGE', 0, 4096); // good for >1h
$fields = [
'stratum' => $chronyd['tracking']['stratum'],
'reference_time' => $chronyd['tracking']['reference_time'],
'system_time' => $chronyd['tracking']['system_time'],
'last_offset' => $chronyd['tracking']['last_offset'],
'rms_offset' => $chronyd['tracking']['rms_offset'],
'frequency' => $chronyd['tracking']['frequency'],
'residual_frequency' => $chronyd['tracking']['residual_frequency'],
'skew' => $chronyd['tracking']['skew'],
'root_delay' => $chronyd['tracking']['root_delay'],
'root_dispersion' => $chronyd['tracking']['root_dispersion'],
'update_interval' => $chronyd['tracking']['update_interval'],
];
// $tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
// process sources data
$sources = [];
$source_rrd_def = RrdDefinition::make()
->addDataset('stratum', 'GAUGE', 0, 15)
->addDataset('polling_rate', 'GAUGE', 0, 4096) // good for >1h
->addDataset('last_rx', 'GAUGE', 0, 777)
->addDataset('adjusted_offset', 'GAUGE', -10000, 10000)
->addDataset('measured_offset', 'GAUGE', -10000, 10000)
->addDataset('estimated_error', 'GAUGE', -10000, 10000)
->addDataset('number_samplepoints', 'GAUGE', 0, 4096)
->addDataset('number_runs', 'GAUGE', 0, 100)
->addDataset('span', 'GAUGE', 0, 10000)
->addDataset('frequency', 'GAUGE', -1000, 1000)
->addDataset('frequency_skew', 'GAUGE', -1000, 1000)
->addDataset('offset', 'GAUGE', -1000, 1000)
->addDataset('stddev', 'GAUGE', -1000, 1000);
$metrics = $chronyd;
unset($metrics['sources']);
foreach ($chronyd['sources'] as $source) {
$sources[] = $source['source_name'];
$rrd_name = ['app', $name, $app->app_id, $source['source_name']];
$fields = [
'stratum' => $source['stratum'],
'polling_rate' => $source['polling_rate'],
'last_rx' => $source['last_rx'],
'adjusted_offset' => $source['adjusted_offset'],
'measured_offset' => $source['measured_offset'],
'estimated_error' => $source['estimated_error'],
'number_samplepoints' => $source['number_samplepoints'],
'number_runs' => $source['number_runs'],
'span' => $source['span'],
'frequency' => $source['frequency'],
'frequency_skew' => $source['frequency_skew'],
'offset' => $source['offset'],
'stddev' => $source['stddev'],
];
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $source_rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
// insert flattened source metrics into the metrics array
foreach ($fields as $field => $value) {
$metrics['source_' . $source['source_name'] . '_' . $field] = $value;
}
}
// check for added or removed sources
$old_sources = $app->data['sources'] ?? [];
$added_sources = array_diff($sources, $old_sources);
$removed_sources = array_diff($old_sources, $sources);
// if we have any source changes, save and log
if (count($added_sources) > 0 || count($removed_sources) > 0) {
$app->data = ['sources' => $sources]; // save sources
$log_message = 'Chronyd Source Change:';
$log_message .= count($added_sources) > 0 ? ' Added ' . implode(',', $added_sources) : '';
$log_message .= count($removed_sources) > 0 ? ' Removed ' . implode(',', $added_sources) : '';
log_event($log_message, $device, 'application');
}
update_application($app, 'OK', $metrics);