centreon-plugins/storage/qnap/snmp/mode/volumes.pm

294 lines
10 KiB
Perl

#
# Copyright 2021 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 storage::qnap::snmp::mode::volumes;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng);
sub custom_status_output {
my ($self, %options) = @_;
return sprintf(
"status: %s",
$self->{result_values}->{status}
);
}
sub custom_space_usage_output {
my ($self, %options) = @_;
my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total});
my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used});
my ($total_free_value, $total_free_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{free});
return sprintf(
"space usage total: %s used: %s (%.2f%%) free: %s (%.2f%%)",
$total_size_value . " " . $total_size_unit,
$total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used},
$total_free_value . " " . $total_free_unit, $self->{result_values}->{prct_free}
);
}
sub volume_long_output {
my ($self, %options) = @_;
return sprintf(
"checking volume '%s'",
$options{instance_value}->{name}
);
}
sub prefix_volume_output {
my ($self, %options) = @_;
return sprintf(
"volume '%s' ",
$options{instance_value}->{name}
);
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'volumes', type => 3, cb_prefix_output => 'prefix_volume_output', cb_long_output => 'volume_long_output',
indent_long_output => ' ', message_multiple => 'All volumes are ok',
group => [
{ name => 'status', type => 0, skipped_code => { -10 => 1 } },
{ name => 'space', type => 0, skipped_code => { -10 => 1 } }
]
}
];
$self->{maps_counters}->{status} = [
{
label => 'volume-status',
type => 2,
warning_default => '%{status} =~ /degraded|warning/i',
critical_default => '%{status} =~ /critical/i',
set => {
key_values => [
{ name => 'status' }, { name => 'name' }
],
closure_custom_output => $self->can('custom_status_output'),
closure_custom_perfdata => sub { return 0; },
closure_custom_threshold_check => \&catalog_status_threshold_ng
}
}
];
$self->{maps_counters}->{space} = [
{ label => 'space-usage', nlabel => 'volume.space.usage.bytes', set => {
key_values => [ { name => 'used' }, { name => 'free' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' }, { name => 'name' } ],
closure_custom_output => $self->can('custom_space_usage_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total', unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'space-usage-free', display_ok => 0, nlabel => 'volume.space.free.bytes', set => {
key_values => [ { name => 'free' }, { name => 'used' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' }, { name => 'name' } ],
closure_custom_output => $self->can('custom_space_usage_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total', unit => 'B', cast_int => 1, label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'space-usage-prct', display_ok => 0, nlabel => 'volume.space.usage.percentage', set => {
key_values => [ { name => 'prct_used' }, { name => 'used' }, { name => 'free' }, { name => 'prct_free' }, { name => 'total' }, { name => 'name' } ],
closure_custom_output => $self->can('custom_space_usage_output'),
perfdatas => [
{ template => '%.2f', min => 0, max => 100, unit => '%', label_extra_instance => 1, instance_use => 'name' }
]
}
}
];
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1);
bless $self, $class;
$options{options}->add_options(arguments => {
'filter-name:s' => { name => 'filter_name' },
'force-counters-legacy' => { name => 'force_counters_legacy' }
});
return $self;
}
sub convert_bytes {
my ($self, %options) = @_;
my $multiple = defined($options{network}) ? 1000 : 1024;
my %units = (K => 1, M => 2, G => 3, T => 4);
if ($options{value} !~ /^\s*([0-9\.\,]+)\s*(.)/) {
$self->{output}->output_add(
severity => 'UNKNOWN',
output => "Cannot convert value '" . $options{value} . "'"
);
$self->{output}->display();
$self->{output}->exit();
}
my ($bytes, $unit) = ($1, uc($2));
for (my $i = 0; $i < $units{$unit}; $i++) {
$bytes *= $multiple;
}
return $bytes;
}
my $mapping = {
legacy => {
name => { oid => '.1.3.6.1.4.1.24681.1.2.17.1.2' }, # sysVolumeDescr
total => { oid => '.1.3.6.1.4.1.24681.1.2.17.1.4' }, # sysVolumeTotalSize
free => { oid => '.1.3.6.1.4.1.24681.1.2.17.1.5' }, # sysVolumeFreeSize
status => { oid => '.1.3.6.1.4.1.24681.1.2.17.1.6' } # sysVolumeStatus
},
ex => {
total => { oid => '.1.3.6.1.4.1.24681.1.4.1.1.1.2.3.2.1.3' }, # volumeCapacity
free => { oid => '.1.3.6.1.4.1.24681.1.4.1.1.1.2.3.2.1.4' }, # volumeFreeSize
status => { oid => '.1.3.6.1.4.1.24681.1.4.1.1.1.2.3.2.1.5' }, # volumeStatus
name => { oid => '.1.3.6.1.4.1.24681.1.4.1.1.1.2.3.2.1.8' } # volumeName
},
qts => {
total => { oid => '.1.3.6.1.4.1.55062.1.10.9.1.3' }, # volumeCapacity
free => { oid => '.1.3.6.1.4.1.55062.1.10.9.1.4' }, # volumeFreeSize
status => { oid => '.1.3.6.1.4.1.55062.1.10.9.1.5' }, # volumeStatus
name => { oid => '.1.3.6.1.4.1.55062.1.10.9.1.8' } # volumeName
}
};
sub check_volumes {
my ($self, %options) = @_;
return 0 if (scalar(keys %{$options{snmp_result}}) <= 0);
foreach (keys %{$options{snmp_result}}) {
next if (! /^$mapping->{ $options{type} }->{name}->{oid}\.(.*)$/);
my $instance = $1;
my $result = $options{snmp}->map_instance(mapping => $mapping->{ $options{type} }, results => $options{snmp_result}, instance => $instance);
if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
$result->{name} !~ /$self->{option_results}->{filter_name}/) {
$self->{output}->output_add(long_msg => "skipping volume $result->{name}", debug => 1);
next;
}
if (defined($options{convert})) {
$result->{total} = $self->convert_bytes(value => $result->{total});
$result->{free} = $self->convert_bytes(value => $result->{free});
}
$self->{volumes}->{$instance} = {
name => $result->{name},
status => {
name => $result->{name},
status => $result->{status}
}
};
if (defined($result->{total}) && $result->{total} > 0) {
$self->{volumes}->{$instance}->{space} = {
name => $result->{name},
total => $result->{total},
free => $result->{free},
used => $result->{total} - $result->{free},
prct_free => $result->{free} * 100 / $result->{total},
prct_used => ($result->{total} - $result->{free}) * 100 / $result->{total}
};
}
}
return 1;
}
sub manage_selection {
my ($self, %options) = @_;
$self->{volumes} = {};
my $snmp_result;
if (!defined($self->{option_results}->{force_counters_legacy})) {
$snmp_result = $options{snmp}->get_table(
oid => '.1.3.6.1.4.1.55062.1.10.9' # volumeTable
);
return if ($self->check_volumes(snmp => $options{snmp}, type => 'qts', snmp_result => $snmp_result));
$snmp_result = $options{snmp}->get_table(
oid => '.1.3.6.1.4.1.24681.1.4.1.1.1.2.3.2' # volumeTable
);
return if ($self->check_volumes(snmp => $options{snmp}, type => 'ex', snmp_result => $snmp_result));
}
$snmp_result = $options{snmp}->get_table(
oid => '.1.3.6.1.4.1.24681.1.2.17', # systemVolumeTable
nothing_quit => 1
);
$self->check_volumes(snmp => $options{snmp}, type => 'legacy', snmp_result => $snmp_result, convert => 1);
}
1;
__END__
=head1 MODE
Check volumes.
=over 8
=item B<--filter-name>
Filter volumes by name (can be a regexp).
=item B<--force-counters-legacy>
Force to use legacy counters. Should be used when EX/QTS counters are buggy.
=item B<--unknown-volume-status>
Set unknown threshold for status.
Can used special variables like: %{status}, %{name}
=item B<--warning-volume-status>
Set warning threshold for status (Default: '%{status} =~ /degraded|warning/i').
Can used special variables like: %{status}, %{name}
=item B<--critical-volume-status>
Set critical threshold for status (Default: '%{status} =~ /critical/i').
Can used special variables like: %{status}, %{name}
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'space-usage-prct', 'space-usage', 'space-usage-free'.
=back
=cut