From d92d4309b61697475a8ed89ca6eaabf1214aae2b Mon Sep 17 00:00:00 2001 From: itoussies <65223458+itoussies@users.noreply.github.com> Date: Wed, 5 May 2021 21:50:21 +0200 Subject: [PATCH] add(plugin): Azure Management ApiManagement (#2766) --- .../apimanagement/mode/discovery.pm | 60 ++++++ .../management/apimanagement/mode/duration.pm | 149 ++++++++++++++ .../management/apimanagement/mode/events.pm | 193 ++++++++++++++++++ .../management/apimanagement/mode/requests.pm | 141 +++++++++++++ .../azure/management/apimanagement/plugin.pm | 64 ++++++ 5 files changed, 607 insertions(+) create mode 100644 centreon-plugins/cloud/azure/management/apimanagement/mode/discovery.pm create mode 100644 centreon-plugins/cloud/azure/management/apimanagement/mode/duration.pm create mode 100644 centreon-plugins/cloud/azure/management/apimanagement/mode/events.pm create mode 100644 centreon-plugins/cloud/azure/management/apimanagement/mode/requests.pm create mode 100644 centreon-plugins/cloud/azure/management/apimanagement/plugin.pm diff --git a/centreon-plugins/cloud/azure/management/apimanagement/mode/discovery.pm b/centreon-plugins/cloud/azure/management/apimanagement/mode/discovery.pm new file mode 100644 index 000000000..07abaaf41 --- /dev/null +++ b/centreon-plugins/cloud/azure/management/apimanagement/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::management::apimanagement::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.ApiManagement'; + $self->{type} = 'service'; +} + +1; + +__END__ + +=head1 MODE + +Azure API Management service discovery. + +=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/centreon-plugins/cloud/azure/management/apimanagement/mode/duration.pm b/centreon-plugins/cloud/azure/management/apimanagement/mode/duration.pm new file mode 100644 index 000000000..748e6b333 --- /dev/null +++ b/centreon-plugins/cloud/azure/management/apimanagement/mode/duration.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::management::apimanagement::mode::duration; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'backendduration' => { + 'output' => 'Duration of Backend Requests', + 'label' => 'requests-backend-duration', + 'nlabel' => 'apimanagement.requests.backend.duration.milliseconds', + 'unit' => 'ms', + 'min' => '0' + }, + 'duration' => { + 'output' => 'Overall Duration of Gateway Requests', + 'label' => 'requests-duration', + 'nlabel' => 'apimanagement.requests.duration.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\.ApiManagement\/service\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'service'; + $self->{az_resource_namespace} = 'Microsoft.ApiManagement'; + $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 API Management requests duration statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=duration --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-requests-duration='1000' --critical-requests-duration='2000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=requests --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service/' +--aggregation='average' --warning-requests-duration='1000' --critical-requests-duration='2000' + +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: +''requests-backend-duration', 'requests-duration'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'requests-backend-duration', 'requests-duration'. + +=back + +=cut diff --git a/centreon-plugins/cloud/azure/management/apimanagement/mode/events.pm b/centreon-plugins/cloud/azure/management/apimanagement/mode/events.pm new file mode 100644 index 000000000..54d91ae11 --- /dev/null +++ b/centreon-plugins/cloud/azure/management/apimanagement/mode/events.pm @@ -0,0 +1,193 @@ +# +# 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::management::apimanagement::mode::events; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'eventhubdroppedevents' => { + 'output' => 'Dropped EventHub Events', + 'label' => 'dropped-events', + 'nlabel' => 'apimanagement.events.dropped.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubrejectedevents' => { + 'output' => 'Rejected EventHub Events', + 'label' => 'rejected-events', + 'nlabel' => 'apimanagement.events.rejected.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubsuccessfulevents' => { + 'output' => 'Successful EventHub Events', + 'label' => 'successful-events', + 'nlabel' => 'apimanagement.events.successful.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubthrottledevents' => { + 'output' => 'Throttled EventHub Events', + 'label' => 'throttled-events', + 'nlabel' => 'apimanagement.events.throttled.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubtimedoutevents' => { + 'output' => 'Timed Out EventHub Events', + 'label' => 'timedout-events', + 'nlabel' => 'apimanagement.events.timedout.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubtotalbytessent' => { + 'output' => 'Size of EventHub Events', + 'label' => 'events-usage', + 'nlabel' => 'apimanagement.events.total.usage.bytes', + 'unit' => 'B', + 'min' => '0' + }, + 'eventhubtotalevents' => { + 'output' => 'Total EventHub Events', + 'label' => 'total-events', + 'nlabel' => 'apimanagement.events.total.count', + 'unit' => '', + 'min' => '0' + }, + 'eventhubtotalfailedevents' => { + 'output' => 'Failed EventHub Events', + 'label' => 'failed-events', + 'nlabel' => 'apimanagement.events.failed.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\.ApiManagement\/service\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'service'; + $self->{az_resource_namespace} = 'Microsoft.ApiManagement'; + $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 API Management events statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=events --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-total-events='1000' --critical-total-events='2000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=events --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service/' +--aggregation='average' --warning-total-events='1000' --critical-total-events='2000' + +Default aggregation: 'total' / 'average', '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: +'dropped-events', 'rejected-events', 'successful-events', 'throttled-events', +'timedout-events', 'events-usage', 'failed-events', 'total-events'. + +=item B<--critical-*> + +Critical threshold where '*' can be: +'dropped-events', 'rejected-events', 'successful-events', 'throttled-events', +'timedout-events', 'events-usage', 'failed-events', 'total-events'. + +=back + +=cut diff --git a/centreon-plugins/cloud/azure/management/apimanagement/mode/requests.pm b/centreon-plugins/cloud/azure/management/apimanagement/mode/requests.pm new file mode 100644 index 000000000..5b6016ac0 --- /dev/null +++ b/centreon-plugins/cloud/azure/management/apimanagement/mode/requests.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::management::apimanagement::mode::requests; + +use base qw(cloud::azure::custom::mode); + +use strict; +use warnings; + +sub get_metrics_mapping { + my ($self, %options) = @_; + + my $metrics_mapping = { + 'requests' => { + 'output' => 'Requests', + 'label' => 'requests', + 'nlabel' => 'apimanagement.requests.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\.ApiManagement\/service\/(.*)$/) { + $resource_group = $1; + $resource = $2; + } + + $self->{az_resource} = $resource; + $self->{az_resource_group} = $resource_group; + $self->{az_resource_type} = 'service'; + $self->{az_resource_namespace} = 'Microsoft.ApiManagement'; + $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 API Management requests statistics. + +Example: + +Using resource name : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=requests --custommode=api +--resource= --resource-group= --aggregation='average' +--warning-requests='1000' --critical-requests='2000' + +Using resource id : + +perl centreon_plugins.pl --plugin=cloud::azure::management::apimanagement::plugin --mode=requests --custommode=api +--resource='/subscriptions//resourceGroups//providers/Microsoft.ApiManagement/service/' +--aggregation='average' --warning-requests='1000' --critical-requests='2000' + +Default aggregation: 'total' / 'average', '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-requests> + +Warning threshold for the number of requests. + +=item B<--critical-requests> + +Critical threshold for the number of requests. + +=back + +=cut diff --git a/centreon-plugins/cloud/azure/management/apimanagement/plugin.pm b/centreon-plugins/cloud/azure/management/apimanagement/plugin.pm new file mode 100644 index 000000000..461ee517b --- /dev/null +++ b/centreon-plugins/cloud/azure/management/apimanagement/plugin.pm @@ -0,0 +1,64 @@ +# +# 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::management::apimanagement::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} = { + 'events' => 'cloud::azure::management::apimanagement::mode::events', + 'discovery' => 'cloud::azure::management::apimanagement::mode::discovery', + 'health' => 'cloud::azure::management::apimanagement::mode::health', + 'requests' => 'cloud::azure::management::apimanagement::mode::requests', + 'duration' => 'cloud::azure::management::apimanagement::mode::duration' + }; + + $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 API Management service. + +=cut