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

99 lines
3.6 KiB
PHP

<?php
// Polls powerdns statistics from script via SNMP
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppParsingFailedException;
use LibreNMS\RRD\RrdDefinition;
$name = 'powerdns';
$powerdns = [];
// unused metrics:
// deferred-packetcache-inserts, deferred-packetcache-lookup, dnsupdate-answers, dnsupdate-changes, dnsupdate-queries, dnsupdate-refused, incoming-notifications
// query-cache-size, overload-drops, rd-queries, recursion-unanswered, security-status, signatures, tcp-answers-bytes, tcp4-answers, tcp4-answers-bytes, tcp4-queries
// tcp6-answers, tcp6-answers-bytes, tcp6-queries, udp-answers-bytes, udp-do-queries, udp4-answers-bytes, udp6-answers-bytes, fd-usage, key-cache-size
// meta-cache-size, real-memory-usage, signature-cache-size, sys-msec, udp-in-errors, udp-noport-errors, udp-recvbuf-errors, udp-sndbuf-errors, uptime, user-msec
$powerdns_metrics = [
'corruptPackets' => 'corrupt-packets',
'def_cacheInserts' => 'deferred-cache-inserts',
'def_cacheLookup' => 'deferred-cache-lookup',
'latency' => 'latency',
'pc_hit' => 'packetcache-hit',
'pc_miss' => 'packetcache-miss',
'pc_size' => 'packetcache-size',
'qsize' => 'qsize-q',
'qc_hit' => 'query-cache-hit',
'qc_miss' => 'query-cache-miss',
'rec_answers' => 'recursing-answers',
'rec_questions' => 'recursing-questions',
'servfailPackets' => 'servfail-packets',
'q_tcpAnswers' => 'tcp-answers',
'q_tcpQueries' => 'tcp-queries',
'q_timedout' => 'timedout-packets',
'q_udpAnswers' => 'udp-answers',
'q_udpQueries' => 'udp-queries',
'q_udp4Answers' => 'udp4-answers',
'q_udp4Queries' => 'udp4-queries',
'q_udp6Answers' => 'udp6-answers',
'q_udp6Queries' => 'udp6-queries',
];
if (isset($agent_data) && isset($agent_data['app'][$name])) {
$legacy = $agent_data['app'][$name];
} else {
try {
$powerdns = json_app_get($device, $name)['data'];
} catch (JsonAppParsingFailedException $e) {
$legacy = $e->getOutput();
} 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;
}
}
if (isset($legacy)) {
// Legacy script, build compatible array
[
$powerdns['corrupt-packets'],
$powerdns['deferred-cache-inserts'],
$powerdns['deferred-cache-lookup'],
$powerdns['latency'],
$powerdns['packetcache-hit'],
$powerdns['packetcache-miss'],
$powerdns['packetcache-size'],
$powerdns['qsize-q'],
$powerdns['query-cache-hit'],
$powerdns['query-cache-miss'],
$powerdns['recursing-answers'],
$powerdns['recursing-questions'],
$powerdns['servfail-packets'],
$powerdns['tcp-answers'],
$powerdns['tcp-queries'],
$powerdns['timedout-packets'],
$powerdns['udp-answers'],
$powerdns['udp-queries'],
$powerdns['udp4-answers'],
$powerdns['udp4-queries'],
$powerdns['udp6-answers'],
$powerdns['udp6-queries'],
] = explode("\n", $legacy);
}
d_echo($powerdns);
$rrd_name = ['app', $name, $app->app_id];
$rrd_def = RrdDefinition::make();
$fields = [];
foreach ($powerdns_metrics as $ds => $metric) {
$rrd_def->addDataset($ds, 'DERIVE', 0, 125000000000);
$fields[$ds] = isset($powerdns[$metric]) ? $powerdns[$metric] : 'U';
}
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
update_application($app, json_encode($powerdns), $fields);