feat(f5-bigip-snmp): add cpuusage mode + tests (#5471)

Refs: CTOR-427
This commit is contained in:
sfarouq-ext 2025-03-28 11:11:11 +01:00 committed by David Boucher
parent 7baab38df6
commit 82074e5f9e
4 changed files with 2562 additions and 1 deletions

View File

@ -0,0 +1,290 @@
#
# Copyright 2025 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
# service performance.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
package network::f5::bigip::snmp::mode::cpuusage;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use Digest::MD5 qw(md5_hex);
sub custom_usage_perfdata {
my ($self, %options) = @_;
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'cpu', type => 1, cb_prefix_output => 'prefix_cpu_output', message_multiple => 'All CPU are ok', skipped_code => { -10 => 1 } },
];
$self->{maps_counters}->{cpu} = [
{ label => 'usage-5s', set => {
key_values => [ { name => 'sysMultiHostCpuUsageRatio5s' }, { name => 'display' } ],
output_template => 'CPU Usage 5sec : %s %%', output_error_template => "CPU Usage 5sec : %s",
perfdatas => [
{ label => 'usage_5s', value => 'sysMultiHostCpuUsageRatio5s', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'usage-1m', set => {
key_values => [ { name => 'sysMultiHostCpuUsageRatio1m' }, { name => 'display' } ],
output_template => 'CPU Usage 1min : %s %%', output_error_template => "CPU Usage 1min : %s",
perfdatas => [
{ label => 'usage_1m', value => 'sysMultiHostCpuUsageRatio1m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'usage-5m', set => {
key_values => [ { name => 'sysMultiHostCpuUsageRatio5m' }, { name => 'display' } ],
output_template => 'CPU Usage 5min : %s %%', output_error_template => "CPU Usage 5min : %s",
perfdatas => [
{ label => 'usage_5m', value => 'sysMultiHostCpuUsageRatio5m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'user-5s', set => {
key_values => [ { name => 'sysMultiHostCpuUser5s' }, { name => 'display' } ],
output_template => 'CPU User 5sec : %s %%', output_error_template => "CPU User 5sec : %s",
perfdatas => [
{ label => 'user_5s', value => 'sysMultiHostCpuUser5s', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'user-1m', set => {
key_values => [ { name => 'sysMultiHostCpuUser1m' }, { name => 'display' } ],
output_template => 'CPU User 1min : %s %%', output_error_template => "CPU User 1min : %s",
perfdatas => [
{ label => 'user_1m', value => 'sysMultiHostCpuUser1m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'user-5m', set => {
key_values => [ { name => 'sysMultiHostCpuUser5m' }, { name => 'display' } ],
output_template => 'CPU User 5min : %s %%', output_error_template => "CPU User 5min : %s",
perfdatas => [
{ label => 'user_5m', value => 'sysMultiHostCpuUser5m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'iowait-5s', set => {
key_values => [ { name => 'sysMultiHostCpuIowait5s' }, { name => 'display' } ],
output_template => 'CPU IO Wait 5sec : %s %%', output_error_template => "CPU IO Wait 5sec : %s",
perfdatas => [
{ label => 'iowait_5s', value => 'sysMultiHostCpuIowait5s', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'iowait-1m', set => {
key_values => [ { name => 'sysMultiHostCpuIowait1m' }, { name => 'display' } ],
output_template => 'CPU IO Wait 1min : %s %%', output_error_template => "CPU IO Wait 1min : %s",
perfdatas => [
{ label => 'iowait_1m', value => 'sysMultiHostCpuIowait1m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'iowait-5m', set => {
key_values => [ { name => 'sysMultiHostCpuIowait5m' }, { name => 'display' } ],
output_template => 'CPU IO Wait 5min : %s %%', output_error_template => "CPU IO Wait 5min : %s",
perfdatas => [
{ label => 'iowait_5m', value => 'sysMultiHostCpuIowait5m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'system-5s', set => {
key_values => [ { name => 'sysMultiHostCpuSystem5s' }, { name => 'display' } ],
output_template => 'CPU System 5sec : %s %%', output_error_template => "CPU System 5sec : %s",
perfdatas => [
{ label => 'system_5s', value => 'sysMultiHostCpuSystem5s', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'system-1m', set => {
key_values => [ { name => 'sysMultiHostCpuSystem1m' }, { name => 'display' } ],
output_template => 'CPU System 1min : %s %%', output_error_template => "CPU System 1min : %s",
perfdatas => [
{ label => 'system_1m', value => 'sysMultiHostCpuSystem1m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'system-5m', set => {
key_values => [ { name => 'sysMultiHostCpuSystem5m' }, { name => 'display' } ],
output_template => 'CPU System 5min : %s %%', output_error_template => "CPU System 5min : %s",
perfdatas => [
{ label => 'system_5m', value => 'sysMultiHostCpuSystem5m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'idle-5s', set => {
key_values => [ { name => 'sysMultiHostCpuIdle5s' }, { name => 'display' } ],
output_template => 'CPU Idle 5sec : %s %%', output_error_template => "CPU Idle 5sec : %s",
perfdatas => [
{ label => 'idle_5s', value => 'sysMultiHostCpuIdle5s', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'idle-1m', set => {
key_values => [ { name => 'sysMultiHostCpuIdle1m' }, { name => 'display' } ],
output_template => 'CPU Idle 1min : %s %%', output_error_template => "CPU Idle 1min : %s",
perfdatas => [
{ label => 'idle_1m', value => 'sysMultiHostCpuIdle1m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
{ label => 'idle-5m', set => {
key_values => [ { name => 'sysMultiHostCpuIdle5m' }, { name => 'display' } ],
output_template => 'CPU Idle 5min : %s %%', output_error_template => "CPU Idle 5min : %s",
perfdatas => [
{ label => 'idle_5m', value => 'sysMultiHostCpuIdle5m', template => '%s',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}
},
];
}
sub prefix_cpu_output {
my ($self, %options) = @_;
return "CPU '" . $options{instance_value}->{display} . "' ";
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, statefile => 1);
bless $self, $class;
$options{options}->add_options(arguments => {
'filter-name:s' => { name => 'filter_name' },
});
return $self;
}
my $mapping = {
sysMultiHostCpuId => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.3' },
sysMultiHostCpuUsageRatio5s => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.19' },
sysMultiHostCpuUsageRatio1m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.27' },
sysMultiHostCpuUsageRatio5m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.35' },
sysMultiHostCpuUser5s => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.12' },
sysMultiHostCpuUser1m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.20' },
sysMultiHostCpuUser5m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.28' },
sysMultiHostCpuIowait5s => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.18' },
sysMultiHostCpuIowait1m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.26' },
sysMultiHostCpuIowait5m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.34' },
sysMultiHostCpuSystem5s => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.14' },
sysMultiHostCpuSystem1m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.22' },
sysMultiHostCpuSystem5m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.30' },
sysMultiHostCpuIdle5s => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.15' },
sysMultiHostCpuIdle1m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.23' },
sysMultiHostCpuIdle5m => { oid => '.1.3.6.1.4.1.3375.2.1.7.5.2.1.31' },
};
my $oid_sysMultiHostCpuEntry = '.1.3.6.1.4.1.3375.2.1.7.5.2.1';
sub manage_selection {
my ($self, %options) = @_;
if ($options{snmp}->is_snmpv1()) {
$self->{output}->add_option_msg(short_msg => "Need to use SNMP v2c or v3.");
$self->{output}->option_exit();
}
my $results = $options{snmp}->get_table(
oid => $oid_sysMultiHostCpuEntry,
nothing_quit => 1
);
$self->{cpu} = {};
foreach my $oid (keys %$results) {
next if ($oid !~ /^$mapping->{sysMultiHostCpuId}->{oid}\.(.*)$/);
my $instance = $1;
my $result = $options{snmp}->map_instance(mapping => $mapping, results => $results, instance => $instance);
if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
$result->{sysMultiHostCpuId} !~ /$self->{option_results}->{filter_name}/) {
$self->{output}->output_add(long_msg => "skipping '" . $result->{sysMultiHostCpuId} . "': no matching filter name.", debug => 1);
next;
}
$self->{cpu}->{$result->{sysMultiHostCpuId}} = {
display => $result->{sysMultiHostCpuId},
%$result
};
}
if (scalar(keys %{$self->{cpu}}) <= 0) {
$self->{output}->add_option_msg(short_msg => "No CPU found.");
$self->{output}->option_exit();
}
$self->{cache_name} = "f5_bipgip_" . $options{snmp}->get_hostname() . '_' . $options{snmp}->get_port() . '_' . $self->{mode} . '_' .
(defined($self->{option_results}->{filter_name}) ? md5_hex($self->{option_results}->{filter_name}) : md5_hex('all')) . '_' .
(defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : md5_hex('all'));
}
1;
__END__
=head1 MODE
Check CPU usages.
=over 8
=item B<--filter-counters>
Only display some counters (regexp can be used).
Example : --filter-counters='^usage$'
=item B<--filter-name>
Filter by CPU id (regexp can be used).
Example : --filter-name='2'
=item B<--warning-*>
Warning threshold.
Can be: 'usage-1m', 'usage-5m', 'iowait-5s'.
=item B<--critical-*>
Critical threshold.
Can be: 'usage-1m', 'usage-5m', 'iowait-5s'.
=back
=cut

View File

@ -1,5 +1,5 @@
#
# Copyright 2024 Centreon (http://www.centreon.com/)
# Copyright 2025 Centreon (http://www.centreon.com/)
#
# Centreon is a full-fledged industry-strength solution that meets
# the needs in IT infrastructure and application monitoring for
@ -42,6 +42,7 @@ sub new {
'node-status' => 'network::f5::bigip::snmp::mode::nodestatus',
'pool-status' => 'network::f5::bigip::snmp::mode::poolstatus',
'tmm-usage' => 'network::f5::bigip::snmp::mode::tmmusage',
'cpu-usage' => 'network::f5::bigip::snmp::mode::cpuusage',
'trunks' => 'network::f5::bigip::snmp::mode::trunks',
'virtualserver-status' => 'network::f5::bigip::snmp::mode::virtualserverstatus'
};

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,30 @@
*** Settings ***
Resource ${CURDIR}${/}..${/}..${/}..${/}..${/}resources/import.resource
Suite Setup Ctn Generic Suite Setup
Test Timeout 120s
*** Variables ***
${CMD} ${CENTREON_PLUGINS} --plugin=network::f5::bigip::snmp::plugin
*** Test Cases ***
cpu-usage ${tc}
[Tags] network
${command} Catenate
... ${CMD}
... --mode=cpu-usage
... --hostname=${HOSTNAME}
... --snmp-version=${SNMPVERSION}
... --snmp-port=${SNMPPORT}
... --snmp-community=network/f5/bigip/snmp/cpu
... ${extra_options}
Ctn Run Command And Check Result As Strings ${command} ${expected_result}
Examples: tc extra_options expected_result --
... 1 ${EMPTY} --filter-counters='^usage-5s' --filter-name='10' OK: CPU '10' CPU Usage 5sec : 35 % | 'usage_5s'=35%;;;0;100
... 2 --filter-name='12' OK: CPU '12' CPU Usage 5sec : 36 %, CPU Usage 1min : 36 %, CPU Usage 5min : 36 %, CPU User 5sec : 31 %, CPU User 1min : 31 %, CPU User 5min : 32 %, CPU IO Wait 5sec : 0 %, CPU IO Wait 1min : 0 %, CPU IO Wait 5min : 0 %, CPU System 5sec : 3 %, CPU System 1min : 4 %, CPU System 5min : 3 %, CPU Idle 5sec : 62 %, CPU Idle 1min : 62 %, CPU Idle 5min : 62 % | 'usage_5s'=36%;;;0;100 'usage_1m'=36%;;;0;100 'usage_5m'=36%;;;0;100 'user_5s'=31%;;;0;100 'user_1m'=31%;;;0;100 'user_5m'=32%;;;0;100 'iowait_5s'=0%;;;0;100 'iowait_1m'=0%;;;0;100 'iowait_5m'=0%;;;0;100 'system_5s'=3%;;;0;100 'system_1m'=4%;;;0;100 'system_5m'=3%;;;0;100 'idle_5s'=62%;;;0;100 'idle_1m'=62%;;;0;100 'idle_5m'=62%;;;0;100
... 3 --warning-usage-1m='30' --filter-counters='^usage-1m' --filter-name='0' WARNING: CPU '0' CPU Usage 1min : 39 % - CPU '10' CPU Usage 1min : 35 % - CPU '20' CPU Usage 1min : 38 % - CPU '30' CPU Usage 1min : 31 % | 'usage_1m_0'=39%;0:30;;0;100 'usage_1m_10'=35%;0:30;;0;100 'usage_1m_20'=38%;0:30;;0;100 'usage_1m_30'=31%;0:30;;0;100 'usage_1m_40'=29%;0:30;;0;100 'usage_1m_50'=30%;0:30;;0;100
... 4 --critical-usage-5m='32' --filter-counters='^usage-5m' --filter-name='0' CRITICAL: CPU '0' CPU Usage 5min : 39 % - CPU '10' CPU Usage 5min : 37 % - CPU '20' CPU Usage 5min : 38 % | 'usage_5m_0'=39%;;0:32;0;100 'usage_5m_10'=37%;;0:32;0;100 'usage_5m_20'=38%;;0:32;0;100 'usage_5m_30'=31%;;0:32;0;100 'usage_5m_40'=29%;;0:32;0;100 'usage_5m_50'=30%;;0:32;0;100