(plugin) apps::protocols::cifs - add mode files (#3702)

This commit is contained in:
qgarnier 2022-06-01 10:25:59 +02:00 committed by GitHub
parent 83c85aeca6
commit 52664b4234
2 changed files with 294 additions and 0 deletions

View File

@ -0,0 +1,293 @@
#
# Copyright 2022 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 apps::protocols::cifs::mode::files;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use Filesys::SmbClient;
use centreon::plugins::misc;
use POSIX;
my $unitdiv = { s => 1, w => 604800, d => 86400, h => 3600, m => 60 };
my $unitdiv_long = { s => 'seconds', w => 'weeks', d => 'days', h => 'hours', m => 'minutes' };
sub custom_mtime_perfdata {
my ($self, %options) = @_;
$self->{output}->perfdata_add(
nlabel => $self->{nlabel} . '.' . $unitdiv_long->{ $self->{instance_mode}->{option_results}->{unit} },
instances => $self->{result_values}->{name},
unit => $self->{instance_mode}->{option_results}->{unit},
value => floor($self->{result_values}->{mtime_seconds} / $unitdiv->{ $self->{instance_mode}->{option_results}->{unit} }),
warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}),
critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}),
min => 0
);
}
sub custom_mtime_threshold {
my ($self, %options) = @_;
return $self->{perfdata}->threshold_check(
value => floor($self->{result_values}->{mtime_seconds} / $unitdiv->{ $self->{instance_mode}->{option_results}->{unit} }),
threshold => [
{ label => 'critical-' . $self->{thlabel}, exit_litteral => 'critical' },
{ label => 'warning-'. $self->{thlabel}, exit_litteral => 'warning' },
{ label => 'unknown-'. $self->{thlabel}, exit_litteral => 'unknown' }
]
);
}
sub prefix_file_output {
my ($self, %options) = @_;
return "File '" . $options{instance} . "' ";
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'global', type => 0, skipped_code => { -10 => 1 } },
{ name => 'files', type => 1, cb_prefix_output => 'prefix_file_output', message_multiple => 'All files are ok', skipped_code => { -10 => 1 } }
];
$self->{maps_counters}->{global} = [
{ label => 'total-files-detected', nlabel => 'files.detected.count', set => {
key_values => [ { name => 'detected' } ],
output_template => 'number of files: %s',
perfdatas => [
{ template => '%s', min => 0 }
]
}
}
];
$self->{maps_counters}->{files} = [
{ label => 'mtime-last', nlabel => 'file.mtime.last', set => {
key_values => [ { name => 'mtime_seconds' }, { name => 'mtime_human' }, { name => 'name' } ],
output_template => 'last modified %s',
output_use => 'mtime_human',
closure_custom_perfdata => $self->can('custom_mtime_perfdata'),
closure_custom_threshold_check => $self->can('custom_mtime_threshold')
}
},
{ label => 'size', nlabel => 'file.size.bytes', set => {
key_values => [ { name => 'size' } ],
output_template => 'size: %s%s',
output_change_bytes => 1,
perfdatas => [
{ template => '%d', unit => 'B', min => 0, label_extra_instance => 1 }
]
}
},
{ label => 'files-detected', nlabel => 'file.detected.count', set => {
key_values => [ { name => 'detected' } ],
output_template => 'number of files: %s',
perfdatas => [
{ template => '%s', min => 0, label_extra_instance => 1 }
]
}
}
];
}
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 => {
'directory:s@' => { name => 'directory' },
'file:s@' => { name => 'file' },
'max-depth:s' => { name => 'max_depth', default => 0 },
'timezone:s' => { name => 'timezone' },
'unit:s' => { name => 'unit', default => 's' }
});
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::check_options(%options);
if (defined($self->{option_results}->{timezone}) && $self->{option_results}->{timezone} ne '') {
centreon::plugins::misc::mymodule_load(
module => 'DateTime',
error_msg => "Cannot load module 'DateTime'."
);
}
if ($self->{option_results}->{unit} eq '' || !defined($unitdiv->{$self->{option_results}->{unit}})) {
$self->{option_results}->{unit} = 's';
}
my $dirs = [];
if (defined($self->{option_results}->{directory})) {
foreach my $dir (@{$self->{option_results}->{directory}}) {
push @$dirs, $dir if ($dir ne '');
}
}
my $files = [];
if (defined($self->{option_results}->{file})) {
foreach my $file (@{$self->{option_results}->{file}}) {
push @$files, $file if ($file ne '');
}
}
if (scalar(@$files) == 0 && scalar(@$dirs) == 0) {
$self->{output}->add_option_msg(short_msg => 'Set --file and/or --directory option');
$self->{output}->option_exit();
}
$self->{option_results}->{directory} = $dirs;
$self->{option_results}->{file} = $files;
}
sub check_directory {
my ($self, %options) = @_;
my @listings = [ { name => $options{dir}, level => 0 } ];
my @build_name = ();
foreach my $list (@listings) {
while (@$list) {
my @files;
my $hash = pop(@$list);
my $dir = $hash->{name};
my $level = $hash->{level};
my ($rv, $message, $files) = $options{custom}->list_directory(directory => $dir);
if ($rv != 0) {
# Cannot list we skip
next;
}
foreach my $file (@$files) {
next if ($file->[0] != SMBC_FILE && $file->[0] != SMBC_DIR);
next if ($file->[1] eq '.' || $file->[1] eq '..');
my $name = $dir . '/' . $file->[1];
if ($file->[0] == SMBC_DIR) {
if (defined($self->{option_results}->{max_depth}) && $level + 1 <= $self->{option_results}->{max_depth}) {
push @$list, { name => $name, level => $level + 1 };
}
} else {
my $rv = $options{custom}->stat_file(file => $name);
$self->{files}->{ $options{dir} }->{size} += $rv->{size};
$self->{files}->{ $options{dir} }->{detected}++;
}
}
}
}
}
sub manage_selection {
my ($self, %options) = @_;
my $ctime = time();
$self->{global} = { detected => 0 };
$self->{files} = {};
foreach my $dir (@{$self->{option_results}->{directory}}) {
my $rv = $options{custom}->stat_file(file => $dir);
if ($rv->{code} != 0) {
$self->{output}->add_option_msg(short_msg => "cannot stat file '" . $dir . "': " . $rv->{message});
$self->{output}->option_exit();
}
$self->{files}->{$dir} = {
name => $dir,
mtime_seconds => $ctime - $rv->{mtime},
mtime_human => centreon::plugins::misc::change_seconds(
value => $ctime - $rv->{mtime}
),
size => 0,
detected => 0
};
$self->check_directory(custom => $options{custom}, dir => $dir);
$self->{global}->{detected} += $self->{files}->{$dir}->{detected};
}
foreach my $file (@{$self->{option_results}->{file}}) {
my $rv = $options{custom}->stat_file(file => $file);
if ($rv->{code} != 0) {
$self->{output}->add_option_msg(short_msg => "cannot stat file '" . $file . "': " . $rv->{message});
$self->{output}->option_exit();
}
$self->{files}->{$file} = {
name => $file,
mtime_seconds => $ctime - $rv->{mtime},
mtime_human => centreon::plugins::misc::change_seconds(
value => $ctime - $rv->{mtime}
),
size => $rv->{size}
};
$self->{global}->{detected}++;
}
}
1;
__END__
=head1 MODE
Check files.
=over 8
=item B<--directory>
Check directory (Multiple option)
=item B<--max-depth>
Don't check fewer levels (Default: '0'. Means current dir only). Used for directory counting files and size.
=item B<--file>
Check file (Multiple option)
=item B<--timezone>
Set the timezone of display date.
Can use format: 'Europe/London' or '+0100'.
=item B<--unit>
Select the unit for modified time threshold. May be 's' for seconds, 'm' for minutes,
'h' for hours, 'd' for days, 'w' for weeks. Default is seconds.
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'total-files-detected', 'mtime-last', 'size', 'files-detected'.
=back
=cut

View File

@ -31,6 +31,7 @@ sub new {
$self->{modes} = {
'connection' => 'apps::protocols::cifs::mode::connection',
'files' => 'apps::protocols::cifs::mode::files',
'files-count' => 'apps::protocols::cifs::mode::filescount',
'files-date' => 'apps::protocols::cifs::mode::filesdate',
'files-size' => 'apps::protocols::cifs::mode::filessize',