From 06c075156b1f18ede2d804214e1f7adb4cf8f704 Mon Sep 17 00:00:00 2001 From: garnier-quentin Date: Thu, 5 Dec 2019 15:09:21 +0100 Subject: [PATCH] add couchdb database --- .../cloud/prometheus/restapi/custom/api.pm | 24 +- .../database/couchdb/restapi/custom/api.pm | 229 ++++++++++++++++ .../database/couchdb/restapi/mode/server.pm | 249 ++++++++++++++++++ .../database/couchdb/restapi/plugin.pm | 49 ++++ 4 files changed, 539 insertions(+), 12 deletions(-) create mode 100644 centreon-plugins/database/couchdb/restapi/custom/api.pm create mode 100644 centreon-plugins/database/couchdb/restapi/mode/server.pm create mode 100644 centreon-plugins/database/couchdb/restapi/plugin.pm diff --git a/centreon-plugins/cloud/prometheus/restapi/custom/api.pm b/centreon-plugins/cloud/prometheus/restapi/custom/api.pm index 266d1fda9..1b430ea23 100644 --- a/centreon-plugins/cloud/prometheus/restapi/custom/api.pm +++ b/centreon-plugins/cloud/prometheus/restapi/custom/api.pm @@ -43,18 +43,18 @@ sub new { if (!defined($options{noptions})) { $options{options}->add_options(arguments => { - "hostname:s" => { name => 'hostname' }, - "url-path:s" => { name => 'url_path' }, - "port:s" => { name => 'port' }, - "proto:s" => { name => 'proto' }, - "credentials" => { name => 'credentials' }, - "basic" => { name => 'basic' }, - "username:s" => { name => 'username' }, - "password:s" => { name => 'password' }, - "timeout:s" => { name => 'timeout' }, - "header:s@" => { name => 'header' }, - "timeframe:s" => { name => 'timeframe' }, - "step:s" => { name => 'step' }, + 'hostname:s' => { name => 'hostname' }, + 'url-path:s' => { name => 'url_path' }, + 'port:s' => { name => 'port' }, + 'proto:s' => { name => 'proto' }, + 'credentials' => { name => 'credentials' }, + 'basic' => { name => 'basic' }, + 'username:s' => { name => 'username' }, + 'password:s' => { name => 'password' }, + 'timeout:s' => { name => 'timeout' }, + 'header:s@' => { name => 'header' }, + 'timeframe:s' => { name => 'timeframe' }, + 'step:s' => { name => 'step' }, }); } $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1); diff --git a/centreon-plugins/database/couchdb/restapi/custom/api.pm b/centreon-plugins/database/couchdb/restapi/custom/api.pm new file mode 100644 index 000000000..dcb933247 --- /dev/null +++ b/centreon-plugins/database/couchdb/restapi/custom/api.pm @@ -0,0 +1,229 @@ +# +# Copyright 2019 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 database::couchdb::restapi::custom::api; + +use strict; +use warnings; +use centreon::plugins::http; +use JSON::XS; + +sub new { + my ($class, %options) = @_; + my $self = {}; + bless $self, $class; + + if (!defined($options{output})) { + print "Class Custom: Need to specify 'output' argument.\n"; + exit 3; + } + if (!defined($options{options})) { + $options{output}->add_option_msg(short_msg => "Class Custom: Need to specify 'options' argument."); + $options{output}->option_exit(); + } + + if (!defined($options{noptions})) { + $options{options}->add_options(arguments => { + 'api-username:s' => { name => 'api_username' }, + 'api-password:s' => { name => 'api_password' }, + 'hostname:s' => { name => 'hostname' }, + 'port:s' => { name => 'port' }, + 'proto:s' => { name => 'proto' }, + 'timeout:s' => { name => 'timeout' }, + 'unknown-http-status:s' => { name => 'unknown_http_status' }, + 'warning-http-status:s' => { name => 'warning_http_status' }, + 'critical-http-status:s' => { name => 'critical_http_status' }, + }); + } + $options{options}->add_help(package => __PACKAGE__, sections => 'REST API OPTIONS', once => 1); + + $self->{output} = $options{output}; + $self->{mode} = $options{mode}; + $self->{http} = centreon::plugins::http->new(%options); + + return $self; +} + +sub set_options { + my ($self, %options) = @_; + + $self->{option_results} = $options{option_results}; +} + +sub set_defaults { + my ($self, %options) = @_; + + foreach (keys %{$options{default}}) { + if ($_ eq $self->{mode}) { + for (my $i = 0; $i < scalar(@{$options{default}->{$_}}); $i++) { + foreach my $opt (keys %{$options{default}->{$_}[$i]}) { + if (!defined($self->{option_results}->{$opt}[$i])) { + $self->{option_results}->{$opt}[$i] = $options{default}->{$_}[$i]->{$opt}; + } + } + } + } + } +} + +sub check_options { + my ($self, %options) = @_; + + $self->{hostname} = (defined($self->{option_results}->{hostname})) ? $self->{option_results}->{hostname} : ''; + $self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 5984; + $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'http'; + $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10; + $self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : ''; + $self->{api_password} = (defined($self->{option_results}->{api_password})) ? $self->{option_results}->{api_password} : ''; + $self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? + $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or (%{http_code} >= 300 && %{http_code} != 404)'; + $self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : ''; + $self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : ''; + + if (!defined($self->{hostname}) || $self->{hostname} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option."); + $self->{output}->option_exit(); + } + + return 0; +} + +sub build_options_for_httplib { + my ($self, %options) = @_; + + $self->{option_results}->{hostname} = $self->{hostname}; + $self->{option_results}->{timeout} = $self->{timeout}; + $self->{option_results}->{port} = $self->{port}; + $self->{option_results}->{proto} = $self->{proto}; + $self->{option_results}->{timeout} = $self->{timeout}; + if (defined($self->{api_username}) && $self->{api_username} ne '') { + $self->{option_results}->{credentials} = 1; + $self->{option_results}->{basic} = 1; + $self->{option_results}->{username} = $self->{api_username}; + $self->{option_results}->{password} = $self->{api_password}; + } +} + +sub settings { + my ($self, %options) = @_; + + return if (defined($self->{settings_done})); + $self->build_options_for_httplib(); + $self->{http}->add_header(key => 'Accept', value => 'application/json'); + $self->{http}->add_header(key => 'Content-Type', value => 'application/json'); + $self->{http}->set_options(%{$self->{option_results}}); + $self->{settings_done} = 1; +} + +sub get_hostname { + my ($self, %options) = @_; + + return $self->{hostname}; +} + +sub request_api { + my ($self, %options) = @_; + + $self->settings(); + my $content = $self->{http}->request( + %options, + unknown_status => $self->{unknown_http_status}, + warning_status => $self->{warning_http_status}, + critical_status => $self->{critical_http_status}, + ); + + if (!defined($content) || $content eq '') { + $self->{output}->add_option_msg(short_msg => "API returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']"); + $self->{output}->option_exit(); + } + if ($self->{http}->get_code() == 404) { + $self->{output}->add_option_msg(short_msg => 'Cannot get response: maybe the server is in maintenance mode'); + $self->{output}->option_exit(); + } + + my $decoded; + eval { + $decoded = JSON::XS->new->utf8->decode($content); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)"); + $self->{output}->option_exit(); + } + + return $decoded; +} + +1; + +__END__ + +=head1 NAME + +CouchDB Rest API + +=head1 REST API OPTIONS + +CouchDB Rest API + +=over 8 + +=item B<--hostname> + +CouchDB hostname. + +=item B<--port> + +Port used (Default: 5984) + +=item B<--proto> + +Specify https if needed (Default: 'http') + +=item B<--api-username> + +API username. + +=item B<--api-password> + +API password. + +=item B<--timeout> + +Set timeout in seconds (Default: 10). + +=item B<--unknown-http-status> + +Threshold unknown for http response code (Default: '%{http_code} < 200 or (%{http_code} >= 300 && %{http_code} != 404)') + +=item B<--warning-http-status> + +Threshold warning for http response code + +=item B<--critical-http-status> + +Threshold critical for http response code + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/centreon-plugins/database/couchdb/restapi/mode/server.pm b/centreon-plugins/database/couchdb/restapi/mode/server.pm new file mode 100644 index 000000000..c963c9166 --- /dev/null +++ b/centreon-plugins/database/couchdb/restapi/mode/server.pm @@ -0,0 +1,249 @@ +# +# Copyright 2019 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 database::couchdb::restapi::mode::server; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold catalog_status_calc); +use JSON::XS; + +sub custom_server_output { + my ($self, %options) = @_; + + my $msg = 'server status is ' . $self->{result_values}->{status}; + return $msg; +} + +sub custom_compaction_output { + my ($self, %options) = @_; + + my $msg = 'compaction status is ' . $self->{result_values}->{compaction_status}; + return $msg; +} + + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'global', type => 0 }, + { name => 'database', type => 1, cb_prefix_output => 'prefix_db_output', message_multiple => 'All databases are ok', skipped_code => { -10 => 1 } }, + ]; + + $self->{maps_counters}->{global} = [ + { label => 'status', threshold => 0, set => { + key_values => [ { name => 'status' } ], + closure_custom_calc => \&catalog_status_calc, + closure_custom_output => $self->can('custom_server_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold, + } + }, + ]; + + $self->{maps_counters}->{database} = [ + { label => 'compaction-status', threshold => 0, set => { + key_values => [ { name => 'compaction_status' }, { name => 'display' } ], + closure_custom_calc => \&catalog_status_calc, + closure_custom_output => $self->can('custom_compaction_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold, + } + }, + { label => 'database-size-active', nlabel => 'server.database.size.active.bytes', set => { + key_values => [ { name => 'sizes_active' }, { name => 'display' } ], + output_template => 'live data size: %s %s', + output_change_bytes => 1, + perfdatas => [ + { value => 'sizes_active_absolute', template => '%d', min => 0, + unit => 'B', label_extra_instance => 1, instance_use => 'display_absolute' } + ], + } + }, + { label => 'database-size-file', nlabel => 'server.database.size.file.bytes', set => { + key_values => [ { name => 'sizes_file' }, { name => 'display' } ], + output_template => 'file size: %s %s', + output_change_bytes => 1, + perfdatas => [ + { value => 'sizes_file_absolute', template => '%d', min => 0, + unit => 'B', label_extra_instance => 1, instance_use => 'display_absolute' } + ], + } + }, + { label => 'database-documents-current', nlabel => 'server.database.documents.currrent.count', display_ok => 0, set => { + key_values => [ { name => 'doc_count' }, { name => 'display' } ], + output_template => 'number of documents: %s', + perfdatas => [ + { value => 'doc_count_absolute', template => '%d', min => 0, + label_extra_instance => 1, instance_use => 'display_absolute' } + ], + } + }, + { label => 'database-documents-deleted', nlabel => 'server.database.documents.deleted.count', display_ok => 0, set => { + key_values => [ { name => 'doc_del_count' }, { name => 'display' } ], + output_template => 'number of deleted documents: %s', + perfdatas => [ + { value => 'doc_del_count_absolute', template => '%d', min => 0, + label_extra_instance => 1, instance_use => 'display_absolute' } + ], + } + }, + ]; +} + +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-db-name:s' => { name => 'filter_db_name' }, + 'unknown-status:s' => { name => 'unknown_status', default => '' }, + 'warning-status:s' => { name => 'warning_status', default => '' }, + 'critical-status:s' => { name => 'critical_status', default => '%{status} !~ /^ok/i' }, + 'unknown-compaction-status:s' => { name => 'unknown_compaction_status', default => '' }, + 'warning-compaction-status:s' => { name => 'warning_compaction_status', default => '' }, + 'critical-compaction-status:s' => { name => 'critical_compaction_status', default => '' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->change_macros(macros => [ + 'warning_status', 'critical_status', 'unknown_status', + 'warning_compaction_status', 'critical_compaction_status', 'unknown_compaction_status' + ]); +} + +sub prefix_db_output { + my ($self, %options) = @_; + + return "Database '" . $options{instance_value}->{display} . "' "; +} + +sub manage_selection { + my ($self, %options) = @_; + + my $results = $options{custom}->request_api(url_path => '/_up'); + $self->{global} = { status => $results->{custom_compaction_output} }; + + $results = $options{custom}->request_api(url_path => '/_all_dbs'); + my $db = { + keys => $results + }; + my $encoded; + eval { + $encoded = JSON::XS->new->utf8->encode($db); + }; + if ($@) { + $self->{output}->add_option_msg(short_msg => "Cannot encode json request"); + $self->{output}->option_exit(); + } + + $results = $options{custom}->request_api( + method => 'POST', + url_path => '/_dbs_info', + query_form_post => $encoded + ); + + $self->{database} = {}; + foreach (@$results) { + if (defined($self->{option_results}->{filter_db_name}) && $self->{option_results}->{filter_db_name} ne '' && + $_->{info}->{db_name} !~ /$self->{option_results}->{filter_db_name}/) { + $self->{output}->output_add(long_msg => "skipping database '" . $_->{info}->{db_name} . "': no matching filter.", debug => 1); + next; + } + + $self->{database}->{$_->{info}->{db_name}} = { + display => $_->{info}->{db_name}, + compaction_status => $_->{info}->{compact_running} ? 'running' : 'notrunning', + doc_count => $_->{info}->{doc_count}, + doc_del_count => $_->{info}->{doc_del_count}, + sizes_active => $_->{info}->{sizes}->{active}, + sizes_file => $_->{info}->{sizes}->{file} + }; + } +} + +1; + +__END__ + +=head1 MODE + +Check server status and database stastistics. + +=over 8 + +=item B<--filter-counters> + +Only display some counters (regexp can be used). +Example: --filter-counters='^status$' + +=item B<--filter-db-name> + +Filter database name (can be a regexp). + +=item B<--unknown-status> + +Set unknown threshold for status (Default: ''). +Can used special variables like: %{status} + +=item B<--warning-status> + +Set warning threshold for status (Default: ''). +Can used special variables like: %{status} + +=item B<--critical-status> + +Set critical threshold for status (Default: '%{status} !~ /^ok/i'). +Can used special variables like: %{status} + +=item B<--unknown-compaction-status> + +Set unknown threshold for status (Default: ''). +Can used special variables like: %{compaction_status}, %{display} + +=item B<--warning-compaction-status> + +Set warning threshold for status (Default: ''). +Can used special variables like: %{compaction_status}, %{display} + +=item B<--critical-compaction-status> + +Set critical threshold for status (Default: ''). +Can used special variables like: %{compaction_status}, %{display} + +=item B<--warning-*> B<--critical-*> + +Thresholds. +Can be: 'database-size-active' (B), 'database-size-file' (B), +'database-documents-deleted', 'database-documents-current'. + +=back + +=cut diff --git a/centreon-plugins/database/couchdb/restapi/plugin.pm b/centreon-plugins/database/couchdb/restapi/plugin.pm new file mode 100644 index 000000000..a49c1ceef --- /dev/null +++ b/centreon-plugins/database/couchdb/restapi/plugin.pm @@ -0,0 +1,49 @@ +# +# Copyright 2019 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 database::couchdb::restapi::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->{version} = '0.1'; + %{ $self->{modes} } = ( + 'server' => 'database::couchdb::restapi::mode::server', + ); + + $self->{custom_modes}{api} = 'database::couchdb::restapi::custom::api'; + return $self; +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check CouchDB in Rest API. + +=cut