Files
librenms-librenms/includes/polling/applications/unbound.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

128 lines
4.9 KiB
PHP

<?php
use LibreNMS\RRD\RrdDefinition;
$name = 'unbound';
if (! empty($agent_data['app'][$name])) {
$rawdata = $agent_data['app'][$name];
} else {
$options = '-Oqv';
$oid = '.1.3.6.1.4.1.8072.1.3.2.3.1.2.7.117.110.98.111.117.110.100';
$rawdata = snmp_get($device, $oid, $options);
}
//Format Data
$lines = explode("\n", $rawdata);
$unbound = [];
$metrics = [];
foreach ($lines as $line) {
[$var,$value] = explode('=', $line);
$unbound[strtolower($var)] = $value;
}
//Unbound Queries
$rrd_name = ['app', $name, 'queries', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('type0', 'DERIVE', 0, 125000000000)
->addDataset('A', 'DERIVE', 0, 125000000000)
->addDataset('NS', 'DERIVE', 0, 125000000000)
->addDataset('CNAME', 'DERIVE', 0, 125000000000)
->addDataset('SOA', 'DERIVE', 0, 125000000000)
->addDataset('NULL', 'DERIVE', 0, 125000000000)
->addDataset('WKS', 'DERIVE', 0, 125000000000)
->addDataset('PTR', 'DERIVE', 0, 125000000000)
->addDataset('MX', 'DERIVE', 0, 125000000000)
->addDataset('TXT', 'DERIVE', 0, 125000000000)
->addDataset('AAAA', 'DERIVE', 0, 125000000000)
->addDataset('SRV', 'DERIVE', 0, 125000000000)
->addDataset('NAPTR', 'DERIVE', 0, 125000000000)
->addDataset('DS', 'DERIVE', 0, 125000000000)
->addDataset('DNSKEY', 'DERIVE', 0, 125000000000)
->addDataset('SPF', 'DERIVE', 0, 125000000000)
->addDataset('ANY', 'DERIVE', 0, 125000000000)
->addDataset('other', 'DERIVE', 0, 125000000000);
$fields = [
'type0' => $unbound['num.query.type.type0'],
'A' => $unbound['num.query.type.a'],
'NS' => $unbound['num.query.type.ns'],
'CNAME' => $unbound['num.query.type.cname'],
'SOA' => $unbound['num.query.type.soa'],
'NULL' => $unbound['num.query.type.null'],
'WKS' => $unbound['num.query.type.wks'],
'PTR' => $unbound['num.query.type.ptr'],
'MX' => $unbound['num.query.type.mx'],
'TXT' => $unbound['num.query.type.txt'],
'AAAA' => $unbound['num.query.type.aaaa'],
'SRV' => $unbound['num.query.type.src'],
'NAPTR' => $unbound['num.query.type.naptr'],
'DS' => $unbound['num.query.type.ds'],
'DNSKEY' => $unbound['num.query.type.dnskey'],
'SPF' => $unbound['num.query.type.spf'],
'ANY' => $unbound['num.query.type.any'],
'other' => $unbound['num.query.type.other'],
];
$metrics['queries'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//Unbound Cache
$rrd_name = ['app', $name, 'cache', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('queries', 'DERIVE', 0, 125000000000)
->addDataset('hits', 'DERIVE', 0, 125000000000)
->addDataset('misses', 'DERIVE', 0, 125000000000);
$fields = [
'queries' => $unbound['total.num.queries'],
'hits' => $unbound['total.num.cachehits'],
'misses' => $unbound['total.num.cachemiss'],
];
$metrics['cache'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//Unbound Operations - Total opcodes and three valuable return codes
$rrd_name = ['app', $name, 'operations', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('opcodeQuery', 'DERIVE', 0, 125000000000)
->addDataset('rcodeNOERROR', 'DERIVE', 0, 125000000000)
->addDataset('rcodeNXDOMAIN', 'DERIVE', 0, 125000000000)
->addDataset('rcodeNodata', 'DERIVE', 0, 125000000000);
$fields = [
'opcodeQuery' => $unbound['num.query.opcode.query'],
'rcodeNOERROR' => $unbound['num.answer.rcode.noerror'],
'rcodeNXDOMAIN' => $unbound['num.answer.rcode.nxdomain'],
'rcodeNodata' => $unbound['num.answer.rcode.nodata'],
];
$metrics['operations'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//Unbound requestlist
$rrd_name = ['app', $name, 'requestlist', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('max', 'DERIVE', 0, 125000000000)
->addDataset('overwritten', 'DERIVE', 0, 125000000000)
->addDataset('exceeded', 'DERIVE', 0, 125000000000);
$fields = [
'max' => $unbound['total.requestlist.max'],
'overwritten' => $unbound['total.requestlist.overwritten'],
'exceeded' => $unbound['total.requestlist.exceeded'],
];
$metrics['requestlist'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//Unbound recursiontime
$rrd_name = ['app', $name, 'recursiontime', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('avg', 'GAUGE', 0, 125000000000)
->addDataset('median', 'GAUGE', 0, 125000000000);
$fields = [
'avg' => $unbound['total.recursion.time.avg'],
'median' => $unbound['total.recursion.time.median'],
];
$metrics['recursiontime'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
update_application($app, $rawdata, $metrics);
unset($lines, $unbound, $rrd_name, $rrd_def, $fields, $tags);