From 6dda5bfe0de5bd0bf68027a2da1044584ab78c5d Mon Sep 17 00:00:00 2001 From: Thibault S <48209914+thibaults-centreon@users.noreply.github.com> Date: Wed, 5 May 2021 21:46:52 +0200 Subject: [PATCH] add(plugin): Azure Cosmos DB account (#2770) --- .../database/cosmosdb/mode/availability.pm | 141 +++++++++++++++ cloud/azure/database/cosmosdb/mode/cache.pm | 164 ++++++++++++++++++ .../azure/database/cosmosdb/mode/discovery.pm | 60 +++++++ .../azure/database/cosmosdb/mode/document.pm | 149 ++++++++++++++++ cloud/azure/database/cosmosdb/mode/health.pm | 76 ++++++++ cloud/azure/database/cosmosdb/mode/latency.pm | 149 ++++++++++++++++ .../database/cosmosdb/mode/throughput.pm | 149 ++++++++++++++++ cloud/azure/database/cosmosdb/mode/units.pm | 140 +++++++++++++++ cloud/azure/database/cosmosdb/mode/usage.pm | 150 ++++++++++++++++ cloud/azure/database/cosmosdb/plugin.pm | 68 ++++++++ 10 files changed, 1246 insertions(+) create mode 100644 cloud/azure/database/cosmosdb/mode/availability.pm create mode 100644 cloud/azure/database/cosmosdb/mode/cache.pm create mode 100644 cloud/azure/database/cosmosdb/mode/discovery.pm create mode 100644 cloud/azure/database/cosmosdb/mode/document.pm create mode 100644 cloud/azure/database/cosmosdb/mode/health.pm create mode 100644 cloud/azure/database/cosmosdb/mode/latency.pm create mode 100644 cloud/azure/database/cosmosdb/mode/throughput.pm create mode 100644 cloud/azure/database/cosmosdb/mode/units.pm create mode 100644 cloud/azure/database/cosmosdb/mode/usage.pm create mode 100644 cloud/azure/database/cosmosdb/plugin.pm diff --git a/cloud/azure/database/cosmosdb/mode/availability.pm b/cloud/azure/database/cosmosdb/mode/availability.pm new file mode 100644 index 000000000..f87d99035 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/availability.pm @@ -0,0 +1,141 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::availability; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'serviceavailability' => { + 'output' => 'Service Availability', + 'label' => 'service-availability-percentage', + 'nlabel' => 'cosmosdb.account.service.availability.percentage', + 'unit' => '%', + 'min' => '0', + 'max' => '100' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 3600; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT1H'; + $self->{az_aggregations} = ['Average']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts availability statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=availability --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-service-availability-percentage='90:' --critical-service-availability-percentage='80:' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=availability --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='average' --warning-service-availability-percentage='90:' --critical-service-availability-percentage='80:' + +Default aggregation: 'average' / 'total', 'minimum' and 'maximum' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-service-availability-percentage> + +Warning threshold. + +=item B<--critical-service-availability-percentage> + +Critical threshold. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/cache.pm b/cloud/azure/database/cosmosdb/mode/cache.pm new file mode 100644 index 000000000..9ec25f761 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/cache.pm @@ -0,0 +1,164 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::cache; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'integratedcacheevictedentriessize' => { + 'output' => 'Integrated Cache Evicted Entries Size', + 'label' => 'cache-evicted-size', + 'nlabel' => 'cosmosdb.account.integratedcache.evicted.size.bytes', + 'unit' => 'B', + 'min' => '0' + }, + 'integratedcachehitrate' => { + 'output' => 'Integrated Cache Hit Rate', + 'label' => 'cache-hitrate-percentage', + 'nlabel' => 'cosmosdb.account.integratedcache.hitrate.percentage', + 'unit' => '%', + 'min' => '0', + 'max' => '100' + }, + 'integratedcachesize' => { + 'output' => 'Integrated Cache Size', + 'label' => 'cache-size', + 'nlabel' => 'cosmosdb.account.integratedcache.size.bytes', + 'unit' => 'B', + 'min' => '0' + }, + 'integratedcachettlexpirationcount' => { + 'output' => 'Integrated Cache TTL Expiration Count', + 'label' => 'cache-ttl-expiration', + 'nlabel' => 'cosmosdb.account.integratedcache.ttlexpiration.count', + 'unit' => '', + 'min' => '0' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT5M'; + $self->{az_aggregations} = ['Average']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts integrated cache statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=cache --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-cache-hitrate-percentage='90:' --critical-cache-hitrate-percentage='80:' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=cache --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='average' --warning-cache-hitrate-percentage='90:' --critical-cache-hitrate-percentage='80:' + +Default aggregation: 'average' / 'total', 'minimum' and 'maximum' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-*> + +Warning threshold where '*' can be: +'cache-hitrate-percentage', 'cache-size', 'cache-ttl-expiration', 'cache-evicted-size'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'cache-hitrate-percentage', 'cache-size', 'cache-ttl-expiration', 'cache-evicted-size'. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/discovery.pm b/cloud/azure/database/cosmosdb/mode/discovery.pm new file mode 100644 index 000000000..3d9d85f22 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/discovery.pm @@ -0,0 +1,60 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::discovery; + +use base qw(cloud::azure::management::monitor::mode::discovery); + +use strict; +use warnings; + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->{namespace} = 'Microsoft.DocumentDB'; + $self->{type} = 'databaseAccounts'; +} + +1; + +__END__ + +=head1 MODE + +Discover Azure Cosmos DB Accounts resources. + +=over 8 + +=item B<--resource-group> + +Specify resource group. + +=item B<--location> + +Specify location. + +=item B<--prettify> + +Prettify JSON output. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/document.pm b/cloud/azure/database/cosmosdb/mode/document.pm new file mode 100644 index 000000000..343f9afd8 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/document.pm @@ -0,0 +1,149 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::document; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'documentcount' => { + 'output' => 'Document Count', + 'label' => 'document-count', + 'nlabel' => 'cosmosdb.account.document.count', + 'unit' => '', + 'min' => '0' + }, + 'documentquota' => { + 'output' => 'Document Quota', + 'label' => 'document-quota', + 'nlabel' => 'cosmosdb.account.document.quota.bytes', + 'unit' => 'B', + 'min' => '0' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT5M'; + $self->{az_aggregations} = ['Total']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts document statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=document --custommode=api +--resource= --resource-group= --aggregation='total' +--warning-document-count='80000' --critical-document-count='90000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=document --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='total' --warning-document-count='80000' --critical-document-count='90000' + +Default aggregation: 'total' / 'minimum', 'maximum' and 'average' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-*> + +Warning threshold where '*' can be: +'document-count', 'document-quota'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'document-count', 'document-quota'. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/health.pm b/cloud/azure/database/cosmosdb/mode/health.pm new file mode 100644 index 000000000..d3675bda8 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/health.pm @@ -0,0 +1,76 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::health; + +use base qw(cloud::azure::management::monitor::mode::health); + +use strict; +use warnings; + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_resource_type} = 'databaseAccounts'; +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts health status. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-status> + +Set warning threshold for status (Default: ''). +Can used special variables like: %{status}, %{summary} + +=item B<--critical-status> + +Set critical threshold for status (Default: '%{status} =~ /^Unavailable$/'). +Can used special variables like: %{status}, %{summary} + +=item B<--unknown-status> + +Set unknown threshold for status (Default: '%{status} =~ /^Unknown$/'). +Can used special variables like: %{status}, %{summary} + +=item B<--ok-status> + +Set ok threshold for status (Default: '%{status} =~ /^Available$/'). +Can used special variables like: %{status}, %{summary} + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/latency.pm b/cloud/azure/database/cosmosdb/mode/latency.pm new file mode 100644 index 000000000..2d942b283 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/latency.pm @@ -0,0 +1,149 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::latency; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'replicationlatency' => { + 'output' => 'P99 Replication Latency', + 'label' => 'replication-latency', + 'nlabel' => 'cosmosdb.account.latency.replication.milliseconds', + 'unit' => 'ms', + 'min' => '0' + }, + 'serversidelatency' => { + 'output' => 'Server Side Latency', + 'label' => 'serverside-latency', + 'nlabel' => 'cosmosdb.account.latency.serverside.milliseconds', + 'unit' => 'ms', + 'min' => '0' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT1M'; + $self->{az_aggregations} = ['Average']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts latency statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=latency --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-serverside-latency='800' --critical-serverside-latency='900' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=latency --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='average' --warning-serverside-latency='800' --critical-serverside-latency='900' + +Default aggregation: 'average' / 'total', 'minimum' and 'maximum' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-*> + +Warning threshold where '*' can be: +'serverside-latency', 'replication-latency'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'serverside-latency', 'replication-latency'. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/throughput.pm b/cloud/azure/database/cosmosdb/mode/throughput.pm new file mode 100644 index 000000000..8d962e35b --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/throughput.pm @@ -0,0 +1,149 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::throughput; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'autoscalemaxthroughput' => { + 'output' => 'Autoscale Max Throughput', + 'label' => 'autoscale-max-throughput', + 'nlabel' => 'cosmosdb.account.troughput.autoscale.count', + 'unit' => '', + 'min' => '0' + }, + 'provisionedthroughput' => { + 'output' => 'Provisioned Throughput', + 'label' => 'provisioned-throughput', + 'nlabel' => 'cosmosdb.account.troughput.provisioned.count', + 'unit' => '', + 'min' => '0' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT5M'; + $self->{az_aggregations} = ['Maximum']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts throughput statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=throughput --custommode=api +--resource= --resource-group= --aggregation='maximum' +--warning-provisioned-throughput='800' --critical-provisioned-throughput='900' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=throughput --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='maximum' --warning-provisioned-throughput='800' --critical-provisioned-throughput='900' + +Default aggregation: 'maximum' / 'total', 'minimum' and 'average' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-*> + +Warning threshold where '*' can be: +'provisioned-throughput', 'autoscale-max-throughput'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'provisioned-throughput', 'autoscale-max-throughput'. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/units.pm b/cloud/azure/database/cosmosdb/mode/units.pm new file mode 100644 index 000000000..5c24b6eb8 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/units.pm @@ -0,0 +1,140 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::units; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'totalrequestunits' => { + 'output' => 'Total Request Units', + 'label' => 'total-request-units', + 'nlabel' => 'cosmosdb.account.requestunits.total.count', + 'unit' => '', + 'min' => '0' + } + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT5M'; + $self->{az_aggregations} = ['Total']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts request units statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=units --custommode=api +--resource= --resource-group= --aggregation='total' +--warning-total-request-units='8000' --critical-total-request-units='9000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=units --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='total' --warning-total-request-units='8000' --critical-total-request-units='9000' + +Default aggregation: 'total' / 'minimum', 'maximum' and 'average' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-total-request-units> + +Warning threshold. + +=item B<--critical-total-request-units> + +Critical threshold. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/mode/usage.pm b/cloud/azure/database/cosmosdb/mode/usage.pm new file mode 100644 index 000000000..f57795061 --- /dev/null +++ b/cloud/azure/database/cosmosdb/mode/usage.pm @@ -0,0 +1,150 @@ +# +# 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 cloud::azure::database::cosmosdb::mode::usage; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'datausage' => { + 'output' => 'Data Usage', + 'label' => 'data-usage', + 'nlabel' => 'cosmosdb.account.data.usage.bytes', + 'unit' => 'B', + 'min' => '0' + }, + 'indexusage' => { + 'output' => 'Index Usage', + 'label' => 'index-usage', + 'nlabel' => 'cosmosdb.account.index.usage.bytes', + 'unit' => 'B', + 'min' => '0' + } + + }; + + return $metrics_mapping; +} + +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-metric:s' => { name => 'filter_metric' }, + 'resource:s' => { name => 'resource' }, + 'resource-group:s' => { name => 'resource_group' } + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + if (!defined($self->{option_results}->{resource}) || $self->{option_results}->{resource} eq '') { + $self->{output}->add_option_msg(short_msg => 'Need to specify either --resource with --resource-group option or --resource .'); + $self->{output}->option_exit(); + } + my $resource = $self->{option_results}->{resource}; + my $resource_group = defined($self->{option_results}->{resource_group}) ? $self->{option_results}->{resource_group} : ''; + if ($resource =~ /^\/subscriptions\/.*\/resourceGroups\/(.*)\/providers\/Microsoft\.DocumentDB\/databaseAccounts\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'databaseAccounts'; + $self->{az_resource_namespace} = 'Microsoft.DocumentDB'; + $self->{az_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 900; + $self->{az_interval} = defined($self->{option_results}->{interval}) ? $self->{option_results}->{interval} : 'PT5M'; + $self->{az_aggregations} = ['Total']; + if (defined($self->{option_results}->{aggregation})) { + $self->{az_aggregations} = []; + foreach my $stat (@{$self->{option_results}->{aggregation}}) { + if ($stat ne '') { + push @{$self->{az_aggregations}}, ucfirst(lc($stat)); + } + } + } + + foreach my $metric (keys %{$self->{metrics_mapping}}) { + next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne '' + && $metric !~ /$self->{option_results}->{filter_metric}/); + push @{$self->{az_metrics}}, $metric; + } +} + +1; + +__END__ + +=head1 MODE + +Check Azure Cosmos DB Accounts usage statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=usage --custommode=api +--resource= --resource-group= --aggregation='total' +--warning-data-usage='80000' --critical-data-usage='90000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::database::cosmosdb::plugin --mode=usage --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/' +--aggregation='total' --warning-data-usage='80000' --critical-data-usage='90000' + +Default aggregation: 'total' / 'minimum', 'maximum' and 'average' are valid. + +=over 8 + +=item B<--resource> + +Set resource name or id (Required). + +=item B<--resource-group> + +Set resource group (Required if resource's name is used). + +=item B<--warning-*> + +Warning threshold where '*' can be: +'data-usage', 'index-usage'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'data-usage', 'index-usage'. + +=back + +=cut diff --git a/cloud/azure/database/cosmosdb/plugin.pm b/cloud/azure/database/cosmosdb/plugin.pm new file mode 100644 index 000000000..e1235f390 --- /dev/null +++ b/cloud/azure/database/cosmosdb/plugin.pm @@ -0,0 +1,68 @@ +# +# 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 cloud::azure::database::cosmosdb::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} } = ( + 'availability' => 'cloud::azure::database::cosmosdb::mode::availability', + 'cache' => 'cloud::azure::database::cosmosdb::mode::cache', + 'discovery' => 'cloud::azure::database::cosmosdb::mode::discovery', + 'document' => 'cloud::azure::database::cosmosdb::mode::document', + 'health' => 'cloud::azure::database::cosmosdb::mode::health', + 'latency' => 'cloud::azure::database::cosmosdb::mode::latency', + 'throughput' => 'cloud::azure::database::cosmosdb::mode::throughput', + 'units' => 'cloud::azure::database::cosmosdb::mode::units', + 'usage' => 'cloud::azure::database::cosmosdb::mode::usage' + ); + + $self->{custom_modes}->{azcli} = 'cloud::azure::custom::azcli'; + $self->{custom_modes}->{api} = 'cloud::azure::custom::api'; + return $self; +} + +sub init { + my ($self, %options) = @_; + + $self->{options}->add_options(arguments => { + 'api-version:s' => { name => 'api_version', default => '2018-01-01' }, + }); + + $self->SUPER::init(%options); +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check Microsoft Azure Cosmos DB Accounts. + +=cut