tyler.durden
/
centreon-plugins
mirror of https://github.com/centreon/centreon-plugins.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

(plugin) cloud::docker::local - new (#4580) 

Co-authored-by: Colin Gagnaire <gagnaire.colin@gmail.com>
This commit is contained in:
qgarnier 2023-09-27 10:16:28 +02:00 committed by GitHub
parent dbabeeac20
commit c603ed5476
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 602 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packaging/centreon-plugin-Applications-Docker-Ssh/deb.json Normal file
View File

@ -0,0 +1,5 @@
{
"dependencies": [
"libssh-session-perl"
]
}

12
packaging/centreon-plugin-Applications-Docker-Ssh/pkg.json Normal file
View File

@ -0,0 +1,12 @@
{
"pkg_name": "centreon-plugin-Applications-Docker-Ssh",
"pkg_summary": "Centreon Plugin to monitor Docker",
"plugin_name": "centreon_docker_ssh.pl",
"files": [
"centreon/plugins/script_custom.pm",
"centreon/plugins/script_custom/cli.pm",
"centreon/plugins/backend/ssh/",
"centreon/plugins/ssh.pm",
"cloud/docker/local/"
]
}

5
packaging/centreon-plugin-Applications-Docker-Ssh/rpm.json Normal file
View File

@ -0,0 +1,5 @@
{
"dependencies": [
"perl(Libssh::Session)"
]
}

135
src/cloud/docker/local/mode/containerstatus.pm Normal file
View File

@ -0,0 +1,135 @@
#
# Copyright 2023 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 cloud::docker::local::mode::containerstatus;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng);
sub prefix_containers_output {
my ($self, %options) = @_;
return "Container '" . $options{instance_value}->{name} . "' ";
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'containers', type => 1, cb_prefix_output => 'prefix_containers_output', message_multiple => 'All containers are ok' }
];
$self->{maps_counters}->{containers} = [
{ label => 'status', type => 2, critical_default => '%{status} !~ /up/i', set => {
key_values => [ { name => 'status' }, { name => 'name' } ],
output_template => "status is '%s'",
closure_custom_perfdata => sub { return 0; },
closure_custom_threshold_check => \&catalog_status_threshold_ng
}
}
];
}
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' },
'filter-id:s' => { name => 'filter_id' }
});
return $self;
}
sub manage_selection {
my ($self, %options) = @_;
my ($stdout) = $options{custom}->execute_command(
command => 'docker ps',
command_options => '-a'
);
$self->{containers} = {};
my @lines = split(/\n/, $stdout);
# Header not needed
# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
# 543c8edfea2b registry/mariadb:10.7 "docker-entrypoint.s…" 5 months ago Up 12 days 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp db
shift(@lines);
foreach my $line (@lines) {
next if ($line !~ /^(\S+)\s{3,}(\S+)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(\S+)$/);
my ($id, $image, $command, $created, $status, $ports, $name) = ($1, $2, $3, $4, $5, $6, $7);
next if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
$name !~ /$self->{option_results}->{filter_name}/);
next if (defined($self->{option_results}->{filter_id}) && $self->{option_results}->{filter_id} ne '' &&
$id !~ /$self->{option_results}->{filter_id}/);
$self->{containers}->{$id} = {
name => $name,
status => $status
};
}
if (scalar(keys %{$self->{containers}}) <= 0) {
$self->{output}->add_option_msg(short_msg => "No container found.");
$self->{output}->option_exit();
}
}
1;
__END__
=head1 MODE
Check container status.
Command used: docker ps -a
=over 8
=item B<--filter-name>
Filter by container name (can be a regexp).
=item B<--filter-id>
Filter by container ID (can be a regexp).
=item B<--warning-status>
Define the conditions to match for the status to be WARNING.
You can use the following variables: %{status}, %{name}
=item B<--critical-status>
Define the conditions to match for the status to be CRITICAL (default: '%{status} !~ /up/i').
You can use the following variables: %{status}, %{name}
=back
=cut

272
src/cloud/docker/local/mode/containerusage.pm Normal file
View File

@ -0,0 +1,272 @@
#
# Copyright 2023 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 cloud::docker::local::mode::containerusage;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use Digest::MD5 qw(md5_hex);
sub custom_memory_perfdata {
my ($self, %options) = @_;
$self->{output}->perfdata_add(
nlabel => 'container.memory.usage.bytes',
unit => 'B',
instances => $self->use_instances(extra_instance => $options{extra_instance}) ? $self->{result_values}->{name} : undef,
value => int($self->{result_values}->{used}),
warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}, total => $self->{result_values}->{total}, cast_int => 1),
critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}, total => $self->{result_values}->{total}, cast_int => 1),
min => 0,
max => int($self->{result_values}->{total})
);
}
sub custom_memory_threshold {
my ($self, %options) = @_;
return $self->{perfdata}->threshold_check(
value => $self->{result_values}->{prct_used}, threshold => [
{ label => 'critical-' . $self->{thlabel}, exit_litteral => 'critical' },
{ label => 'warning-' . $self->{thlabel}, exit_litteral => 'warning' }
]
);
}
sub custom_memory_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(
"memory 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 custom_memory_calc {
my ($self, %options) = @_;
$self->{result_values}->{name} = $options{new_datas}->{$self->{instance} . '_name'};
$self->{result_values}->{total} = $options{new_datas}->{$self->{instance} . '_memory_total'};
$self->{result_values}->{used} = $options{new_datas}->{$self->{instance} . '_memory_usage'};
# container is not running
return -10 if ($self->{result_values}->{used} == 0);
$self->{result_values}->{free} = $self->{result_values}->{total} - $self->{result_values}->{used};
$self->{result_values}->{prct_free} = $self->{result_values}->{free} * 100 / $self->{result_values}->{total};
$self->{result_values}->{prct_used} = $self->{result_values}->{used} * 100 / $self->{result_values}->{total};
return 0;
}
sub prefix_containers_output {
my ($self, %options) = @_;
return "Container '" . $options{instance_value}->{name} . "' ";
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'containers', type => 1, cb_prefix_output => 'prefix_containers_output',
message_multiple => 'All containers are ok', skipped_code => { -10 => 1, -11 => 1 } }
];
$self->{maps_counters}->{containers} = [
{ label => 'cpu', nlabel => 'container.cpu.utilization.percentage', set => {
key_values => [ { name => 'cpu_prct' }, { name => 'name' } ],
output_template => 'cpu usage: %.2f %%',
perfdatas => [
{ template => '%.2f', unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'memory', nlabel => 'container.memory.usage.bytes', set => {
key_values => [ { name => 'memory_usage' }, { name => 'memory_total' }, { name => 'name' } ],
closure_custom_calc => $self->can('custom_memory_calc'),
closure_custom_output => $self->can('custom_memory_output'),
closure_custom_perfdata => $self->can('custom_memory_perfdata'),
closure_custom_threshold_check => $self->can('custom_memory_threshold')
}
},
{ label => 'read-throughput', nlabel => 'container.disk.throughput.read.bytespersecond', set => {
key_values => [ { name => 'read_throughput', per_second => 1 }, { name => 'name' } ],
output_template => 'disk read throughput: %s %s/s',
output_change_bytes => 1,
perfdatas => [
{ template => '%d', unit => 'B/s', min => 0, label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'write-throughput', nlabel => 'container.disk.throughput.write.bytespersecond', set => {
key_values => [ { name => 'write_throughput', per_second => 1 }, { name => 'name' } ],
output_template => 'disk write throughput: %s %s/s',
output_change_bytes => 1,
perfdatas => [
{ template => '%d', unit => 'B/s', min => 0, label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'traffic-in', nlabel => 'container.traffic.in.bitspersecond', set => {
key_values => [ { name => 'traffic_in', per_second => 1 }, { name => 'name' } ],
output_template => 'traffic in: %s %s/s',
output_change_bytes => 2,
perfdatas => [
{ template => '%d', min => 0, unit => 'b/s', label_extra_instance => 1, instance_use => 'name' }
]
}
},
{ label => 'traffic-out', nlabel => 'container.traffic.out.bitspersecond', set => {
key_values => [ { name => 'traffic_out', per_second => 1 }, { name => 'name' } ],
output_template => 'traffic out: %s %s/s',
output_change_bytes => 2,
perfdatas => [
{ template => '%d', min => 0, unit => 'b/s', label_extra_instance => 1, instance_use => 'name' }
]
}
}
];
}
sub get_bytes {
my ($self, %options) = @_;
return undef if ($options{value} !~ /(\d+(?:\.\d+)?)\s*([a-zA-Z]+)/);
my ($value, $unit) = ($1, $2);
if ($unit =~ /KiB*/i) {
$value = $value * 1024;
} elsif ($unit =~ /MiB*/i) {
$value = $value * 1024 * 1024;
} elsif ($unit =~ /GiB*/i) {
$value = $value * 1024 * 1024 * 1024;
} elsif ($unit =~ /TiB*/i) {
$value = $value * 1024 * 1024 * 1024 * 1024;
} elsif ($unit =~ /KB*/i) {
$value = $value * 1000;
} elsif ($unit =~ /MB*/i) {
$value = $value * 1000 * 1000;
} elsif ($unit =~ /GB*/i) {
$value = $value * 1000 * 1000 * 1000;
} elsif ($unit =~ /TB*/i) {
$value = $value * 1000 * 1000 * 1000 * 1000;
}
return $value;
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, statefile => 1, force_new_perfdata => 1);
bless $self, $class;
$options{options}->add_options(arguments => {
'filter-name:s' => { name => 'filter_name' },
'filter-id:s' => { name => 'filter_id' }
});
return $self;
}
sub manage_selection {
my ($self, %options) = @_;
my ($stdout) = $options{custom}->execute_command(
command => 'docker stats',
command_options => '-a --no-stream'
);
$self->{containers} = {};
my @lines = split(/\n/, $stdout);
# Header not needed
# CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
# fe954c63d9ba portainer 4.82% 72.14MiB / 7.79GiB 0.90% 387MB / 261MB 4.1kB / 0B 11
shift(@lines);
foreach my $line (@lines) {
next if ($line !~ /^(\S+)\s{3,}(\S+)\s{3,}(\S+)\s{3,}(\S+)\s\/\s(\S+)\s{3,}\S+\s{3,}(\S+)\s\/\s(\S+)\s{3,}(\S+)\s\/\s(\S+).*$/);
my ($id, $name, $cpu, $mem_usage, $mem_limit, $net_in, $net_out, $block_in, $block_out) = ($1, $2, $3, $4, $5, $6, $7, $8, $9);
next if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
$name !~ /$self->{option_results}->{filter_name}/);
next if (defined($self->{option_results}->{filter_id}) && $self->{option_results}->{filter_id} ne '' &&
$id !~ /$self->{option_results}->{filter_id}/);
$self->{containers}->{$id} = {
name => $name,
cpu_prct => substr($cpu, 0, -1),
memory_usage => $self->get_bytes(value => $mem_usage),
memory_total => $self->get_bytes(value => $mem_limit),
read_throughput => $self->get_bytes(value => $block_in),
write_throughput => $self->get_bytes(value => $block_out),
traffic_in => $self->get_bytes(value => $net_in),
traffic_out => $self->get_bytes(value => $net_out)
};
}
if (scalar(keys %{$self->{containers}}) <= 0) {
$self->{output}->add_option_msg(short_msg => "No container found.");
$self->{output}->option_exit();
}
$self->{cache_name} = 'docker_' . $self->{mode} . '_' .
(defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : md5_hex('all')) . '_' .
(defined($self->{option_results}->{filter_name}) ? md5_hex($self->{option_results}->{filter_name}) : md5_hex('all')). '_' .
(defined($self->{option_results}->{filter_id}) ? md5_hex($self->{option_results}->{filter_id}) : md5_hex('all'));
}
1;
__END__
=head1 MODE
Check container usage.
Command used: docker stats -a --no-stream
Because values are scaled, statistics are not very
precise (except for CPU).
=over 8
=item B<--filter-name>
Filter by container name (can be a regexp).
=item B<--filter-id>
Filter by container ID (can be a regexp).
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'cpu' (%), 'memory' (%), 'read-throughput',
'write-throughput', 'traffic-in', 'traffic-out'.
=back
=cut

122
src/cloud/docker/local/mode/listcontainers.pm Normal file
View File

@ -0,0 +1,122 @@
#
# Copyright 2023 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 cloud::docker::local::mode::listcontainers;
use base qw(centreon::plugins::mode);
use strict;
use warnings;
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class;
$options{options}->add_options(arguments => {});
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::init(%options);
}
sub manage_selection {
my ($self, %options) = @_;
my ($stdout) = $options{custom}->execute_command(
command => 'docker ps',
command_options => '-a'
);
$self->{containers} = {};
my @lines = split(/\n/, $stdout);
# Header not needed
# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
# 543c8edfea2b registry/mariadb:10.7 "docker-entrypoint.s…" 5 months ago Up 12 days 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp db
shift(@lines);
foreach my $line (@lines) {
next if ($line !~ /^(\S+)\s{3,}(\S+)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(.*?)\s{3,}(\S+)$/);
my ($id, $image, $command, $created, $status, $ports, $name) = ($1, $2, $3, $4, $5, $6, $7);
$self->{containers}->{$id} = {
name => $name,
status => $status
};
}
}
sub run {
my ($self, %options) = @_;
$self->manage_selection(%options);
foreach my $id (sort keys %{$self->{containers}}) {
$self->{output}->output_add(
long_msg => '[id: ' . $id . "] [name: " . $self->{containers}->{$id}->{name} . "]" .
" [status: " . $self->{containers}->{$id}->{status} . "]"
);
}
$self->{output}->output_add(
severity => 'OK',
short_msg => 'List containers:'
);
$self->{output}->display(nolabel => 1, force_ignore_perfdata => 1, force_long_output => 1);
$self->{output}->exit();
}
sub disco_format {
my ($self, %options) = @_;
$self->{output}->add_disco_format(elements => ['id', 'name', 'status']);
}
sub disco_show {
my ($self, %options) = @_;
$self->manage_selection(%options);
foreach my $id (sort keys %{$self->{containers}}) {
$self->{output}->add_disco_entry(
id => $id,
name => $self->{containers}->{$id}->{name},
status => $self->{containers}->{$id}->{status}
);
}
}
1;
__END__
=head1 MODE
List containers.
Command used: docker ps -a
=over 8
=back
=cut

51
src/cloud/docker/local/plugin.pm Normal file
View File

@ -0,0 +1,51 @@
#
# Copyright 2023 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 cloud::docker::local::plugin;
use strict;
use warnings;
use base qw(centreon::plugins::script_custom);
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class;
$self->{modes} = {
'container-status' => 'cloud::docker::local::mode::containerstatus',
'container-usage' => 'cloud::docker::local::mode::containerusage',
'list-containers' => 'cloud::docker::local::mode::listcontainers'
};
$self->{custom_modes}->{cli} = 'centreon::plugins::script_custom::cli';
return $self;
}
1;
__END__
=head1 PLUGIN DESCRIPTION
Check Docker through local commands (the plugin can use SSH).
=cut