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

119 lines
3.7 KiB
PHP

<?php
use LibreNMS\RRD\RrdDefinition;
$name = 'postgres';
$options = '-Oqv';
$oid = '.1.3.6.1.4.1.8072.1.3.2.3.1.2.8.112.111.115.116.103.114.101.115';
$postgres = snmp_walk($device, $oid, $options);
[$backends, $commits, $rollbacks, $read, $hit, $idxscan, $idxtupread, $idxtupfetch, $idxblksread,
$idxblkshit, $seqscan, $seqtupread, $ret, $fetch, $ins, $upd, $del] = explode("\n", $postgres);
$rrd_name = ['app', $name, $app->app_id];
$metrics = [];
$rrd_def = RrdDefinition::make()
->addDataset('backends', 'GAUGE', 0)
->addDataset('commits', 'DERIVE', 0)
->addDataset('rollbacks', 'DERIVE', 0)
->addDataset('read', 'DERIVE', 0)
->addDataset('hit', 'DERIVE', 0)
->addDataset('idxscan', 'DERIVE', 0)
->addDataset('idxtupread', 'DERIVE', 0)
->addDataset('idxtupfetch', 'DERIVE', 0)
->addDataset('idxblksread', 'DERIVE', 0)
->addDataset('idxblkshit', 'DERIVE', 0)
->addDataset('seqscan', 'DERIVE', 0)
->addDataset('seqtupread', 'DERIVE', 0)
->addDataset('ret', 'DERIVE', 0)
->addDataset('fetch', 'DERIVE', 0)
->addDataset('ins', 'DERIVE', 0)
->addDataset('upd', 'DERIVE', 0)
->addDataset('del', 'DERIVE', 0);
$fields = [
'backends' => $backends,
'commits' => $commits,
'rollbacks' => $rollbacks,
'read' => $read,
'hit' => $hit,
'idxscan' => $idxscan,
'idxtupread' => $idxtupread,
'idxtupfetch' => $idxtupfetch,
'idxblksread' => $idxblksread,
'idxblkshit' => $idxblkshit,
'seqscan' => $seqscan,
'seqtupread' => $seqtupread,
'ret' => $ret,
'fetch' => $fetch,
'ins' => $ins,
'upd' => $upd,
'del' => $del,
];
$metrics['none'] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
//process each database
$db_lines = explode("\n", $postgres);
$db_lines_int = 17;
$databases = [];
while (isset($db_lines[$db_lines_int])) {
[$backends, $commits, $rollbacks, $read, $hit, $idxscan, $idxtupread, $idxtupfetch, $idxblksread,
$idxblkshit, $seqscan, $seqtupread, $ret, $fetch, $ins, $upd, $del, $dbname] = explode(' ', $db_lines[$db_lines_int]);
$rrd_name = ['app', $name, $app->app_id, $dbname];
$databases[] = $dbname;
$fields = [
'backends' => $backends,
'commits' => $commits,
'rollbacks' => $rollbacks,
'read' => $read,
'hit' => $hit,
'idxscan' => $idxscan,
'idxtupread' => $idxtupread,
'idxtupfetch' => $idxtupfetch,
'idxblksread' => $idxblksread,
'idxblkshit' => $idxblkshit,
'seqscan' => $seqscan,
'seqtupread' => $seqtupread,
'ret' => $ret,
'fetch' => $fetch,
'ins' => $ins,
'upd' => $upd,
'del' => $del,
];
$metrics[$dbname] = $fields;
$tags = ['name' => $name, 'app_id' => $app->app_id, 'rrd_def' => $rrd_def, 'rrd_name' => $rrd_name];
data_update($device, 'app', $tags, $fields);
$db_lines_int++;
}
// check for added or removed databases
$old_databases = $app->data['databases'] ?? [];
$added_databases = array_diff($databases, $old_databases);
$removed_databases = array_diff($old_databases, $databases);
// if we have any database changes, save and log
if (count($added_databases) > 0 || count($removed_databases) > 0) {
$app->data = ['databases' => $databases];
$log_message = 'Postgres Database Change:';
if (count($added_databases)) {
$log_message .= ' Added ' . implode(',', $added_databases);
}
if (count($removed_databases)) {
$log_message .= ' Removed ' . implode(',', $removed_databases);
}
log_event($log_message, $device, 'application');
}
update_application($app, $postgres, $metrics);