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

135 lines
4.1 KiB
PHP

<?php
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppMissingKeysException;
use LibreNMS\RRD\RrdDefinition;
$name = 'seafile';
$output = 'OK';
try {
$seafile_data = json_app_get($device, $name, 1)['data'];
} catch (JsonAppMissingKeysException $e) {
$seafile_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;
}
$account_data = $seafile_data['accounts'];
$client_version = $seafile_data['devices']['client_version'];
$client_platform = $seafile_data['devices']['platform'];
$group_data = $seafile_data['groups'];
$sysinfo_data = $seafile_data['sysinfo'];
$rrd_name = ['app', $name, $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('enabled', 'GAUGE', 0)
->addDataset('libraries', 'GAUGE', 0)
->addDataset('trashed_libraries', 'GAUGE', 0)
->addDataset('size_consumption', 'GAUGE', 0);
$category = 'acc';
$metrics = [];
// handling accounts
foreach ($account_data as $data) {
$owner_name = str_replace(' ', '_', $data['owner']);
$enabled = $data['is_active'] ? 1 : 0;
$libraries = $data['repos'];
$trashed_libraries = $data['trash_repos'];
$size_consumption = $data['usage'];
$rrd_name = ['app', $name, $app->app_id, $category, $owner_name];
$fields = [
'enabled' => $enabled,
'libraries' => $libraries,
'trashed_libraries' => $trashed_libraries,
'size_consumption' => $size_consumption,
];
$metrics[$owner_name . '_' . $category] = $fields;
$tags = ['name' => $owner_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
}
// handling groups
$rrd_def = RrdDefinition::make()
->addDataset('count', 'GAUGE', 0);
$category = 'grp';
$group_name = 'groups';
$group_count = $group_data['count'];
$rrd_name = ['app', $name, $app->app_id, $category, $group_name];
$fields = [
'count' => $group_count,
];
$metrics[$group_name . '_' . $category] = $fields;
$tags = ['name' => $group_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
// handling client version
$rrd_def = RrdDefinition::make()
->addDataset('version', 'GAUGE', 0);
$category = 'cltver';
foreach ($client_version as $data) {
$version_name = $data['client_version'];
$version_count = $data['clients'];
$rrd_name = ['app', $name, $app->app_id, $category, $version_name];
$fields = [
'version' => $version_count,
];
$metrics[$version_name . '_' . $category] = $fields;
$tags = ['name' => $version_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
}
// handling client platform
$rrd_def = RrdDefinition::make()
->addDataset('platform', 'GAUGE', 0);
$category = 'cltos';
foreach ($client_platform as $data) {
$os_name = $data['os_name'];
$os_count = $data['clients'];
$rrd_name = ['app', $name, $app->app_id, $category, $os_name];
$fields = [
'platform' => $os_count,
];
$metrics[$os_name . '_' . $category] = $fields;
$tags = ['name' => $os_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
}
// handling sysinfo
$rrd_def = RrdDefinition::make()
->addDataset('connected', 'GAUGE', 0);
$category = 'sysinfo';
$sysinfo_name = 'devices';
$sysinfo_connected_devices = $sysinfo_data['current_connected_devices_count'];
$rrd_name = ['app', $name, $app->app_id, $category, $sysinfo_name];
$fields = [
'connected' => $sysinfo_connected_devices,
];
$metrics[$sysinfo_name . '_' . $category] = $fields;
$tags = ['name' => $sysinfo_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);