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

129 lines
4.4 KiB
PHP

<?php
use LibreNMS\RRD\RrdDefinition;
$name = 'proxmox';
if (! function_exists('proxmox_port_exists')) {
/**
* Check if a port on a Proxmox VM exists
*
* @param string $p Port name
* @param string $c Clustername
* @param int $i VM ID
* @return int|bool The port-ID if the port exists, false if it doesn't exist
*/
function proxmox_port_exists($i, $c, $p)
{
if ($row = dbFetchRow('SELECT pmp.id FROM proxmox_ports pmp, proxmox pm WHERE pm.id = pmp.vm_id AND pmp.port = ? AND pm.cluster = ? AND pm.vmid = ?', [$p, $c, $i])) {
return $row['id'];
}
return false;
}
}
if (! function_exists('proxmox_vm_exists')) {
/**
* Check if a Proxmox VM exists
*
* @param int $i VM ID
* @param string $c Clustername
* @param array $pmxcache Reference to the Proxmox VM Cache
* @return bool true if the VM exists, false if it doesn't
*/
function proxmox_vm_exists($i, $c, &$pmxcache)
{
if (isset($pmxcache[$c][$i]) && $pmxcache[$c][$i] > 0) {
return true;
}
if ($row = dbFetchRow('SELECT id FROM proxmox WHERE vmid = ? AND cluster = ?', [$i, $c])) {
$pmxcache[$c][$i] = (int) $row['id'];
return true;
}
return false;
}
}
if (\LibreNMS\Config::get('enable_proxmox') && ! empty($agent_data['app'][$name])) {
$proxmox = $agent_data['app'][$name];
} elseif (\LibreNMS\Config::get('enable_proxmox')) {
$options = '-Oqv';
$oid = '.1.3.6.1.4.1.8072.1.3.2.3.1.2.7.112.114.111.120.109.111.120';
$proxmox = snmp_get($device, $oid, $options);
$proxmox = preg_replace('/^.+\n/', '', $proxmox);
$proxmox = str_replace("<<<app-proxmox>>>\n", '', $proxmox);
}
if ($proxmox) {
$pmxlines = explode("\n", $proxmox);
$pmxcluster = array_shift($pmxlines);
dbUpdate(
['device_id' => $device['device_id'], 'app_type' => $name, 'app_instance' => $pmxcluster],
'applications',
'`device_id` = ? AND `app_type` = ?',
[$device['device_id'], $name]
);
$metrics = [];
if (count($pmxlines) > 0) {
$pmxcache = [];
foreach ($pmxlines as $vm) {
$vm = str_replace('"', '', $vm);
[$vmid, $vmport, $vmpin, $vmpout, $vmdesc] = explode('/', $vm, 5);
echo "Proxmox ($pmxcluster): $vmdesc: $vmpin/$vmpout/$vmport\n";
$rrd_proxmox_name = [
'pmxcluster' => $pmxcluster,
'vmid' => $vmid,
'vmport' => $vmport,
];
$rrd_def = RrdDefinition::make()
->addDataset('INOCTETS', 'DERIVE', 0, 12500000000)
->addDataset('OUTOCTETS', 'DERIVE', 0, 12500000000);
$fields = [
'INOCTETS' => $vmpin,
'OUTOCTETS' => $vmpout,
];
$proxmox_metric_prefix = "pmxcluster{$pmxcluster}_vmid{$vmid}_vmport$vmport";
$metrics[$proxmox_metric_prefix] = $fields;
$tags = compact('name', 'app_id', 'pmxcluster', 'vmid', 'vmport', 'rrd_proxmox_name', 'rrd_def');
data_update($device, 'app', $tags, $fields);
if (proxmox_vm_exists($vmid, $pmxcluster, $pmxcache) === true) {
dbUpdate([
'device_id' => $device['device_id'],
'last_seen' => ['NOW()'],
'description' => $vmdesc,
], $name, '`vmid` = ? AND `cluster` = ?', [$vmid, $pmxcluster]);
} else {
$pmxcache[$pmxcluster][$vmid] = dbInsert([
'cluster' => $pmxcluster,
'vmid' => $vmid,
'description' => $vmdesc,
'device_id' => $device['device_id'],
], $name);
}
if ($portid = proxmox_port_exists($vmid, $pmxcluster, $vmport) !== false) {
dbUpdate(
['last_seen' => ['NOW()']],
'proxmox_ports',
'`vm_id` = ? AND `port` = ?',
[$pmxcache[$pmxcluster][$vmid], $vmport]
);
} else {
dbInsert(['vm_id' => $pmxcache[$pmxcluster][$vmid], 'port' => $vmport], 'proxmox_ports');
}
}
}
update_application($app, $proxmox, $metrics);
}
unset($pmxlines, $pmxcluster, $pmxcdir, $proxmox, $pmxcache);