mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Systemd Application Code Cleanup and new Systemd Unit State Metrics. (#15848)

Browse Source
This commit is contained in:
bnerickson
2024-03-04 14:58:28 -08:00
committed by GitHub
parent c83d362e59
commit 0998592e1f
13 changed files with 508 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

166
includes/polling/applications/systemd.inc.php
View File

@@ -27,10 +27,31 @@ if (! function_exists('systemd_data_update_helper')) {
* @param string $state_type
* @return $metrics
*/
function systemd_data_update_helper($device, $app_id, $fields, $metrics, $name, $polling_type, $rrd_def, $state_type)
{
$rrd_name = [$polling_type, $name, $app_id, $state_type];
$metrics[$state_type] = $fields;
function systemd_data_update_helper(
$device,
$app_id,
$fields,
$metrics,
$name,
$polling_type,
$rrd_def,
$state_type,
$rrd_flattened_name
) {
$rrd_flattened_name = is_null($rrd_flattened_name)
? $state_type
: $rrd_flattened_name;
$rrd_name = [$polling_type, $name, $app_id, $rrd_flattened_name];
// This if block allows metric names to be kept consistent
// regardless of whether the metric is stored in an shared
// or individual RRD.
if (isset($metrics[$state_type])) {
$metrics[$state_type] = array_merge($metrics[$state_type], $fields);
} else {
$metrics[$state_type] = $fields;
}
$tags = [
'name' => $name,
'app_id' => $app_id,
@@ -50,7 +71,13 @@ try {
} catch (JsonAppMissingKeysException $e) {
$systemd_data = $e->getParsedJson();
} catch (JsonAppException $e) {
echo PHP_EOL . $name . ':' . $e->getCode() . ':' . $e->getMessage() . PHP_EOL;
echo PHP_EOL .
$name .
':' .
$e->getCode() .
':' .
$e->getMessage() .
PHP_EOL;
update_application($app, $e->getCode() . ':' . $e->getMessage(), $metrics);
return;
@@ -59,62 +86,85 @@ try {
// Use the mapping variable in systemd-shared.inc.php to parse
// the json data received from the systemd.py script.
foreach ($systemd_mapper as $state_type => $state_statuses) {
if (! in_array($state_type, $state_type_ternary_depth)) {
// Process systemd states that do not have three
// levels of depth (load and active)
$shared_rrd_def = RrdDefinition::make();
$shared_fields = [];
$sub_state_type = null;
$flattened_type = $state_type;
$rrd_def = RrdDefinition::make();
$fields = [];
// Iterate through unit state type's statuses.
foreach ($systemd_mapper[$state_type] as $state_status) {
$field_name = $state_status;
$field_value = $systemd_data[$state_type][$state_status] ?? null;
// Verify data passed by application script is valid.
// Update fields and rrd definition.
if (is_int($field_value) || is_null($field_value)) {
$fields[$field_name] = $field_value;
} else {
$log_message = 'Systemd Polling Warning: Invalid data returned by application for systemd unit ' .
$state_type . ' state with' . $state_status . ' state status: ' . $field_value;
log_event($log_message, $device, 'application');
continue;
}
$rrd_def->addDataset($field_name, 'GAUGE', 0);
}
$metrics = systemd_data_update_helper($device, $app->app_id, $fields, $metrics, $name, $polling_type, $rrd_def, $state_type);
} else {
// Process systemd states that have three
// levels of depth (sub)
// Iterate through unit sub state types.
foreach ($systemd_mapper[$state_type] as $sub_state_type => $sub_state_statuses) {
$rrd_def = RrdDefinition::make();
$fields = [];
// Iterate through unit sub state type's statuses.
foreach ($sub_state_statuses as $sub_state_status) {
$field_name = $sub_state_status;
$field_value = $systemd_data[$state_type][$sub_state_type][$sub_state_status] ?? null;
// Verify data passed by application script is valid.
// Update fields and rrd definition.
if (is_int($field_value) || is_null($field_value)) {
$fields[$field_name] = $field_value;
} else {
$log_message = 'Systemd Polling Warning: Invalid data returned by application for systemd unit ' .
$state_type . ' state with ' . $sub_state_type . ' sub state type with ' . $sub_state_status .
' sub state status: ' . $field_value;
log_event($log_message, $device, 'application');
continue;
}
$rrd_def->addDataset($field_name, 'GAUGE', 0);
}
$flat_type = $state_type . '_' . $sub_state_type;
$metrics = systemd_data_update_helper($device, $app->app_id, $fields, $metrics, $name, $polling_type, $rrd_def, $flat_type);
// Ternary-depth systemd type check.
if (preg_match('/^(.+)_(.+)$/', $state_type, $regex_matches)) {
if (! in_array($regex_matches[1], $state_type_ternary_depth)) {
continue;
}
$state_type = $regex_matches[1];
$sub_state_type = $regex_matches[2];
}
// Iterate through unit state type's statuses.
foreach ($state_statuses as $state_status => $rrd_location) {
$field_value = null;
$field_name = $state_status;
if (is_null($sub_state_type)) {
$field_value = $systemd_data[$state_type][$state_status] ?? null;
} else {
$field_value =
$systemd_data[$state_type][$sub_state_type][$state_status] ??
null;
}
// Verify data passed by application script is valid.
if (! is_int($field_value) && ! is_null($field_value)) {
$log_message =
'Systemd Polling Warning: Invalid data returned by application for systemd unit ' .
$flattened_type .
' state with' .
$state_status .
' state status: ' .
$field_value;
log_event($log_message, $device, 'application');
continue;
}
// New metrics MUST use the 'individual' type because
// it is not possible to automatically update 'shared'
// RRDs with new metrics.
if ($rrd_location === 'individual') {
$individual_fields = [];
$individual_rrd_def = RrdDefinition::make();
$individual_fields[$field_name] = $field_value;
$individual_rrd_def->addDataset($field_name, 'GAUGE', 0);
$rrd_flattened_type = $flattened_type . '-' . $field_name;
$metrics = systemd_data_update_helper(
$device,
$app->app_id,
$individual_fields,
$metrics,
$name,
$polling_type,
$individual_rrd_def,
$flattened_type,
$rrd_flattened_type
);
continue;
}
// Update shared_fields and rrd definition.
$shared_fields[$field_name] = $field_value;
$shared_rrd_def->addDataset($field_name, 'GAUGE', 0);
}
$metrics = systemd_data_update_helper(
$device,
$app->app_id,
$shared_fields,
$metrics,
$name,
$polling_type,
$shared_rrd_def,
$flattened_type,
null
);
}
update_application($app, $output, $metrics);