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

171 lines
7.9 KiB
PHP

<?php
use LibreNMS\RRD\RrdDefinition;
$name = 'freeradius';
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.10.102.114.101.101.114.97.100.105.117.115';
$rawdata = snmp_get($device, $oid, $options);
}
//Format Data
$lines = explode("\n", $rawdata);
$freeradius = [];
$metrics = [];
foreach ($lines as $line) {
[$var,$value] = explode(' = ', $line);
$freeradius[$var] = $value;
}
//FreeRADIUS-Total-Access
$rrd_name = ['app', $name, 'access', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('requests', 'DERIVE', 0, 125000000000)
->addDataset('accepts', 'DERIVE', 0, 125000000000)
->addDataset('rejects', 'DERIVE', 0, 125000000000)
->addDataset('challenges', 'DERIVE', 0, 125000000000);
$fields = [
'requests' => $freeradius['FreeRADIUS-Total-Access-Requests'],
'accepts' => $freeradius['FreeRADIUS-Total-Access-Accepts'],
'rejects' => $freeradius['FreeRADIUS-Total-Access-Rejects'],
'challenges' => $freeradius['FreeRADIUS-Total-Access-Challenges'],
];
$metrics['access'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Total-Auth
$rrd_name = ['app', $name, 'auth', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('responses', 'DERIVE', 0, 125000000000)
->addDataset('duplicate_requests', 'DERIVE', 0, 125000000000)
->addDataset('malformed_requests', 'DERIVE', 0, 125000000000)
->addDataset('invalid_requests', 'DERIVE', 0, 125000000000)
->addDataset('dropped_requests', 'DERIVE', 0, 125000000000)
->addDataset('unknown_types', 'DERIVE', 0, 125000000000);
$fields = [
'responses' => $freeradius['FreeRADIUS-Total-Auth-Responses'],
'duplicate_requests' => $freeradius['FreeRADIUS-Total-Auth-Duplicate-Requests'],
'malformed_requests' => $freeradius['FreeRADIUS-Total-Auth-Malformed-Requests'],
'invalid_requests' => $freeradius['FreeRADIUS-Total-Auth-Invalid-Requests'],
'dropped_requests' => $freeradius['FreeRADIUS-Total-Auth-Dropped-Requests'],
'unknown_types' => $freeradius['FreeRADIUS-Total-Auth-Unknown-Types'],
];
$metrics['auth'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Total-Acct
$rrd_name = ['app', $name, 'acct', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('requests', 'DERIVE', 0, 125000000000)
->addDataset('responses', 'DERIVE', 0, 125000000000)
->addDataset('duplicate_requests', 'DERIVE', 0, 125000000000)
->addDataset('malformed_requests', 'DERIVE', 0, 125000000000)
->addDataset('invalid_requests', 'DERIVE', 0, 125000000000)
->addDataset('dropped_requests', 'DERIVE', 0, 125000000000)
->addDataset('unknown_types', 'DERIVE', 0, 125000000000);
$fields = [
'requests' => $freeradius['FreeRADIUS-Total-Accounting-Requests'],
'responses' => $freeradius['FreeRADIUS-Total-Accounting-Responses'],
'duplicate_requests' => $freeradius['FreeRADIUS-Total-Acct-Duplicate-Requests'],
'malformed_requests' => $freeradius['FreeRADIUS-Total-Acct-Malformed-Requests'],
'invalid_requests' => $freeradius['FreeRADIUS-Total-Acct-Invalid-Requests'],
'dropped_requests' => $freeradius['FreeRADIUS-Total-Acct-Dropped-Requests'],
'unknown_types' => $freeradius['FreeRADIUS-Total-Acct-Unknown-Types'],
];
$metrics['acct'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Total-Proxy-Access
$rrd_name = ['app', $name, 'proxy_access', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('requests', 'DERIVE', 0, 125000000000)
->addDataset('accepts', 'DERIVE', 0, 125000000000)
->addDataset('rejects', 'DERIVE', 0, 125000000000)
->addDataset('challenges', 'DERIVE', 0, 125000000000);
$fields = [
'requests' => $freeradius['FreeRADIUS-Total-Proxy-Access-Requests'],
'accepts' => $freeradius['FreeRADIUS-Total-Proxy-Access-Accepts'],
'rejects' => $freeradius['FreeRADIUS-Total-Proxy-Access-Rejects'],
'challenges' => $freeradius['FreeRADIUS-Total-Proxy-Access-Challenges'],
];
$metrics['proxy_access'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Total-Proxy-Auth
$rrd_name = ['app', $name, 'proxy_auth', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('responses', 'DERIVE', 0, 125000000000)
->addDataset('duplicate_requests', 'DERIVE', 0, 125000000000)
->addDataset('malformed_requests', 'DERIVE', 0, 125000000000)
->addDataset('invalid_requests', 'DERIVE', 0, 125000000000)
->addDataset('dropped_requests', 'DERIVE', 0, 125000000000)
->addDataset('unknown_types', 'DERIVE', 0, 125000000000);
$fields = [
'responses' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Responses'],
'duplicate_requests' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Duplicate-Requests'],
'malformed_requests' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Malformed-Requests'],
'invalid_requests' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Invalid-Requests'],
'dropped_requests' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Dropped-Requests'],
'unknown_types' => $freeradius['FreeRADIUS-Total-Proxy-Auth-Unknown-Types'],
];
$metrics['proxy_auth'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Total-Proxy-Acct
$rrd_name = ['app', $name, 'proxy_acct', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('requests', 'DERIVE', 0, 125000000000)
->addDataset('responses', 'DERIVE', 0, 125000000000)
->addDataset('duplicate_requests', 'DERIVE', 0, 125000000000)
->addDataset('malformed_requests', 'DERIVE', 0, 125000000000)
->addDataset('invalid_requests', 'DERIVE', 0, 125000000000)
->addDataset('dropped_requests', 'DERIVE', 0, 125000000000)
->addDataset('unknown_types', 'DERIVE', 0, 125000000000);
$fields = [
'requests' => $freeradius['FreeRADIUS-Total-Proxy-Accounting-Requests'],
'responses' => $freeradius['FreeRADIUS-Total-Proxy-Accounting-Responses'],
'duplicate_requests' => $freeradius['FreeRADIUS-Total-Proxy-Acct-Duplicate-Requests'],
'malformed_requests' => $freeradius['FreeRADIUS-Total-Proxy-Acct-Malformed-Requests'],
'invalid_requests' => $freeradius['FreeRADIUS-Total-Proxy-Acct-Invalid-Requests'],
'dropped_requests' => $freeradius['FreeRADIUS-Total-Proxy-Acct-Dropped-Requests'],
'unknown_types' => $freeradius['FreeRADIUS-Total-Proxy-Acct-Unknown-Types'],
];
$metrics['proxy_acct'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
//FreeRADIUS-Queue
$rrd_name = ['app', $name, 'queue', $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('len_internal', 'DERIVE', 0, 125000000000)
->addDataset('len_proxy', 'DERIVE', 0, 125000000000)
->addDataset('len_auth', 'DERIVE', 0, 125000000000)
->addDataset('len_acct', 'DERIVE', 0, 125000000000)
->addDataset('len_detail', 'DERIVE', 0, 125000000000)
->addDataset('pps_in', 'DERIVE', 0, 125000000000)
->addDataset('pps_out', 'DERIVE', 0, 125000000000);
$fields = [
'len_internal' => $freeradius['FreeRADIUS-Queue-Len-Internal'],
'len_proxy' => $freeradius['FreeRADIUS-Queue-Len-Proxy'],
'len_auth' => $freeradius['FreeRADIUS-Queue-Len-Auth'],
'len_acct' => $freeradius['FreeRADIUS-Queue-Len-Acct'],
'len_detail' => $freeradius['FreeRADIUS-Queue-Len-Detail'],
'pps_in' => $freeradius['FreeRADIUS-Queue-PPS-In'],
'pps_out' => $freeradius['FreeRADIUS-Queue-PPS-Out'],
];
$metrics['queue'] = $fields;
$tags = compact('name', 'app_id', 'rrd_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
update_application($app, $rawdata, $metrics);
unset($lines, $freeradius, $rrd_name, $rrd_def, $fields, $tags);