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

129 lines
5.5 KiB
PHP

<?php
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppParsingFailedException;
use LibreNMS\RRD\RrdDefinition;
$name = 'fbsd-nfs-client';
try {
$nfs = json_app_get($device, 'fbsdnfsclient', 0);
} catch (JsonAppParsingFailedException $e) {
// Legacy script, build compatible array
$legacy = $e->getOutput();
$nfs = [
'data' => [],
];
[$nfs['data']['Getattr'], $nfs['data']['Setattr'], $nfs['data']['Lookup'], $nfs['data']['Readlink'],
$nfs['data']['Read'], $nfs['data']['Write'], $nfs['data']['Create'], $nfs['data']['Remove'], $nfs['data']['Rename'],
$nfs['data']['Link'], $nfs['data']['Symlink'], $nfs['data']['Mkdir'], $nfs['data']['Rmdir'], $nfs['data']['Readdir'],
$nfs['data']['RdirPlus'], $nfs['data']['Access'], $nfs['data']['Mknod'], $nfs['data']['Fsstat'], $nfs['data']['Fsinfo'],
$nfs['data']['PathConf'], $nfs['data']['Commit'], $nfs['data']['TimedOut'], $nfs['data']['Invalid'], $nfs['data']['XReplies'],
$nfs['data']['Retries'], $nfs['data']['Requests'], $nfs['data']['AttrHits'], $nfs['data']['AttrMisses'], $nfs['data']['LkupHits'],
$nfs['data']['LkupMisses'], $nfs['data']['BioRHits'], $nfs['data']['BioRMisses'], $nfs['data']['BioWHits'],
$nfs['data']['BioWMisses'], $nfs['data']['BioRLHits'], $nfs['data']['BioRLMisses'], $nfs['data']['BioDHits'],
$nfs['data']['BioDMisses'], $nfs['data']['DirEHits'], $nfs['data']['DirEMisses'], $nfs['data']['AccsHits'],
$nfs['data']['AccsMisses']] = explode("\n", $legacy);
} 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('getattr', 'DERIVE', 0)
->addDataset('setattr', 'DERIVE', 0)
->addDataset('lookup', 'DERIVE', 0)
->addDataset('readlink', 'DERIVE', 0)
->addDataset('read', 'DERIVE', 0)
->addDataset('write', 'DERIVE', 0)
->addDataset('create', 'DERIVE', 0)
->addDataset('remove', 'DERIVE', 0)
->addDataset('rename', 'DERIVE', 0)
->addDataset('link', 'DERIVE', 0)
->addDataset('symlink', 'DERIVE', 0)
->addDataset('mkdir', 'DERIVE', 0)
->addDataset('rmdir', 'DERIVE', 0)
->addDataset('readdir', 'DERIVE', 0)
->addDataset('rdirplus', 'DERIVE', 0)
->addDataset('access', 'DERIVE', 0)
->addDataset('mknod', 'DERIVE', 0)
->addDataset('fsstat', 'DERIVE', 0)
->addDataset('fsinfo', 'DERIVE', 0)
->addDataset('pathconf', 'DERIVE', 0)
->addDataset('commit', 'DERIVE', 0)
->addDataset('timedout', 'DERIVE', 0)
->addDataset('invalid', 'DERIVE', 0)
->addDataset('xreplies', 'DERIVE', 0)
->addDataset('retries', 'DERIVE', 0)
->addDataset('requests', 'DERIVE', 0)
->addDataset('attrhits', 'DERIVE', 0)
->addDataset('attrmisses', 'DERIVE', 0)
->addDataset('lkuphits', 'DERIVE', 0)
->addDataset('lkupmisses', 'DERIVE', 0)
->addDataset('biorhits', 'DERIVE', 0)
->addDataset('biormisses', 'DERIVE', 0)
->addDataset('biowhits', 'DERIVE', 0)
->addDataset('biowmisses', 'DERIVE', 0)
->addDataset('biorlhits', 'DERIVE', 0)
->addDataset('biorlmisses', 'DERIVE', 0)
->addDataset('biodhits', 'DERIVE', 0)
->addDataset('biodmisses', 'DERIVE', 0)
->addDataset('direhits', 'DERIVE', 0)
->addDataset('diremisses', 'DERIVE', 0)
->addDataset('accshits', 'DERIVE', 0)
->addDataset('accsmisses', 'DERIVE', 0);
$fields = [
'getattr' => $nfs['data']['Getattr'],
'setattr' => $nfs['data']['Setattr'],
'lookup' => $nfs['data']['Lookup'],
'readlink' => $nfs['data']['Readlink'],
'read' => $nfs['data']['Read'],
'write' => $nfs['data']['Write'],
'create' => $nfs['data']['Create'],
'remove' => $nfs['data']['Remove'],
'rename' => $nfs['data']['Rename'],
'link' => $nfs['data']['Link'],
'symlink' => $nfs['data']['SymLink'],
'mkdir' => $nfs['data']['Mkdir'],
'rmdir' => $nfs['data']['Rmdir'],
'readdir' => $nfs['data']['Readdir'],
'rdirplus' => $nfs['data']['RdirPlus'],
'access' => $nfs['data']['Access'],
'mknod' => $nfs['data']['Mknod'],
'fsstat' => $nfs['data']['Fsstat'],
'fsinfo' => $nfs['data']['Fsinfo'],
'pathconf' => $nfs['data']['PathConf'],
'commit' => $nfs['data']['Commit'],
'timedout' => $nfs['data']['Timedout'],
'invalid' => $nfs['data']['Invalid'],
'xreplies' => $nfs['data']['XReplies'],
'retries' => $nfs['data']['Retries'],
'requests' => $nfs['data']['Requests'],
'attrhits' => $nfs['data']['AttrHits'],
'attrmisses' => $nfs['data']['AttrMisses'],
'lkuphits' => $nfs['data']['LkupHits'],
'lkupmisses' => $nfs['data']['LkupMisses'],
'biorhits' => $nfs['data']['BioRHits'],
'biormisses' => $nfs['data']['BioRMisses'],
'biowhits' => $nfs['data']['BioWHits'],
'biowmisses' => $nfs['data']['BioWMisses'],
'biorlhits' => $nfs['data']['BioRLHits'],
'biorlmisses' => $nfs['data']['BioRLMisses'],
'biodhits' => $nfs['data']['BioDHits'],
'biodmisses' => $nfs['data']['BioDMisses'],
'direhits' => $nfs['data']['DirEHits'],
'diremisses' => $nfs['data']['DirEMisses'],
'accshits' => $nfs['data']['AccsHits'],
'accsmisses' => $nfs['data']['AccsMisses'],
];
$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, 'OK', $nfs['data']);