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

146 lines
4.6 KiB
PHP

<?php
use LibreNMS\Exceptions\JsonAppException;
use LibreNMS\Exceptions\JsonAppMissingKeysException;
use LibreNMS\RRD\RrdDefinition;
$snmp_extend_name = 'dhcpstats';
$name = 'dhcp-stats';
$options = '-Oqv';
$mib = 'NET-SNMP-EXTEND-MIB';
$oid = '.1.3.6.1.4.1.8072.1.3.2.4.1.2.9.100.104.99.112.115.116.97.116.115';
$version = 1;
$output = 'OK';
try {
$dhcp_data = json_app_get($device, $snmp_extend_name, 1);
$dhcpstats = $dhcp_data['data'];
$version = $dhcp_data['version'];
} catch (JsonAppMissingKeysException $e) {
$dhcpstats = $e->getParsedJson();
$output = 'ERROR';
} catch (JsonAppException $e) {
$dhcpstats = snmp_walk($device, $oid, $options, $mib);
}
$version = intval($version);
if ($version == 1) {
$output = 'LEGACY';
} elseif ($version == 2) {
$output = 'OK';
} else {
$output = 'UNSUPPORTED';
}
$metrics = [];
$category = 'stats';
if (intval($version) == 1) {
[$dhcp_total, $dhcp_active, $dhcp_expired, $dhcp_released, $dhcp_abandoned, $dhcp_reset, $dhcp_bootp, $dhcp_backup, $dhcp_free] = explode("\n", $dhcpstats);
} elseif ($version == 2) {
$lease_data = $dhcpstats['leases'];
$dhcp_total = $lease_data['total'];
$dhcp_active = $lease_data['active'];
$dhcp_expired = $lease_data['expired'];
$dhcp_released = $lease_data['released'];
$dhcp_abandoned = $lease_data['abandoned'];
$dhcp_reset = $lease_data['reset'];
$dhcp_bootp = $lease_data['bootp'];
$dhcp_backup = $lease_data['backup'];
$dhcp_free = $lease_data['free'];
}
$rrd_name = ['app', $name, $app->app_id];
$rrd_def = RrdDefinition::make()
->addDataset('dhcp_total', 'GAUGE', 0)
->addDataset('dhcp_active', 'GAUGE', 0)
->addDataset('dhcp_expired', 'GAUGE', 0)
->addDataset('dhcp_released', 'GAUGE', 0)
->addDataset('dhcp_abandoned', 'GAUGE', 0)
->addDataset('dhcp_reset', 'GAUGE', 0)
->addDataset('dhcp_bootp', 'GAUGE', 0)
->addDataset('dhcp_backup', 'GAUGE', 0)
->addDataset('dhcp_free', 'GAUGE', 0);
$fields = [
'dhcp_total' => $dhcp_total,
'dhcp_active' => $dhcp_active,
'dhcp_expired' => $dhcp_expired,
'dhcp_released' => $dhcp_released,
'dhcp_abandoned' => $dhcp_abandoned,
'dhcp_reset' => $dhcp_reset,
'dhcp_bootp' => $dhcp_bootp,
'dhcp_backup' => $dhcp_backup,
'dhcp_free' => $dhcp_free,
];
$metrics[$name . '_' . $category] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
if ($version == 2) {
$category = 'pools';
$pool_data = $dhcpstats['pools'];
$rrd_def = RrdDefinition::make()
->addDataset('current', 'GAUGE', 0)
->addDataset('max', 'GAUGE', 0)
->addDataset('percent', 'GAUGE', 0);
foreach ($pool_data as $data) {
$dhcp_pool_name = $data['first_ip'] . '_-_' . $data['last_ip'];
$dhcp_current = $data['cur'];
$dhcp_max = $data['max'];
$dhcp_percent = $data['percent'];
$rrd_name = ['app', $name, $app->app_id, $category, $dhcp_pool_name];
$fields = [
'current' => $dhcp_current,
'max' => $dhcp_max,
'percent' => $dhcp_percent,
];
$metrics[$dhcp_pool_name . '_' . $category] = $fields;
$tags = ['name' => $dhcp_pool_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
}
$category = 'networks';
$network_data = $dhcpstats['networks'];
$rrd_def = RrdDefinition::make()
->addDataset('current', 'GAUGE', 0)
->addDataset('max', 'GAUGE', 0)
->addDataset('percent', 'GAUGE', 0);
foreach ($network_data as $data) {
$dhcp_network_name = str_replace('/', '_', $data['network']);
$dhcp_current = $data['cur'];
$dhcp_max = $data['max'];
$dhcp_percent = $data['percent'] == 'nan' ? '0' : $data['percent'];
$rrd_name = ['app', $name, $app->app_id, $category, $dhcp_network_name];
$fields = [
'current' => $dhcp_current,
'max' => $dhcp_max,
'percent' => $dhcp_percent,
];
$metrics[$dhcp_network_name . '_' . $category] = $fields;
$tags = ['name' => $dhcp_network_name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
}
}
if ($version == 1) {
$app_state = $dhcp_active . '/' . $dhcp_total;
} else {
$app_state = $dhcpstats['all_networks']['cur'] . '/' . $dhcpstats['all_networks']['max'];
}
update_application($app, $output, $metrics, $app_state);