add(plugin): Amazon SQS (#2134)
This commit is contained in:
Thibault S
GitHub
parent
733fb7c856
commit
727f2c819d
|
|
@ -727,6 +727,26 @@ sub health_describe_affected_entities {
|
|||
return $all_results;
|
||||
}
|
||||
|
||||
sub sqs_list_queues_set_cmd {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
return if (defined($self->{option_results}->{command_options}) && $self->{option_results}->{command_options} ne '');
|
||||
|
||||
my $cmd_options = "sqs list-queues --region $self->{option_results}->{region} --output json";
|
||||
$cmd_options .= " --endpoint-url $self->{endpoint_url}" if (defined($self->{endpoint_url}) && $self->{endpoint_url} ne '');
|
||||
|
||||
return $cmd_options;
|
||||
}
|
||||
|
||||
sub sqs_list_queues {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
my $cmd_options = $self->sqs_list_queues_set_cmd(%options);
|
||||
my $queues_results = $self->execute(cmd_options => $cmd_options);
|
||||
|
||||
return $queues_results->{QueueUrls};
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
|
|
|||
|
|
@ -646,6 +646,25 @@ sub health_describe_affected_entities {
|
|||
return $entities_results;
|
||||
}
|
||||
|
||||
sub sqs_list_queues {
|
||||
my ($self, %options) = @_;
|
||||
my $queues_results = [];
|
||||
eval {
|
||||
my $lwp_caller = new Paws::Net::LWPCaller();
|
||||
my $queues = Paws->service('SQS', caller => $lwp_caller, region => $self->{option_results}->{region});
|
||||
my $list_queues = $queues->ListQueues();
|
||||
foreach my $queue (@{$list_queues->{QueueUrls}}) {
|
||||
push @{$queues_results}, $queue;
|
||||
};
|
||||
};
|
||||
if ($@) {
|
||||
$self->{output}->add_option_msg(short_msg => "error: $@");
|
||||
$self->{output}->option_exit();
|
||||
}
|
||||
|
||||
return $queues_results;
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
|
|
|||
|
|
@ -0,0 +1,94 @@
|
|||
#
|
||||
# Copyright 2020 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::aws::sqs::mode::listqueues;
|
||||
|
||||
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) = @_;
|
||||
|
||||
$self->{queues} = $options{custom}->sqs_list_queues();
|
||||
}
|
||||
|
||||
sub run {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
$self->manage_selection(%options);
|
||||
foreach my $queue (@{$self->{queues}}) {
|
||||
$queue =~ s/(.*)\///g;
|
||||
$self->{output}->output_add(long_msg => sprintf( "[Name = %s]", $queue ));
|
||||
}
|
||||
|
||||
$self->{output}->output_add(
|
||||
severity => 'OK',
|
||||
short_msg => 'Amazon SQS queues:'
|
||||
);
|
||||
$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 => ['name']);
|
||||
}
|
||||
|
||||
sub disco_show {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
$self->manage_selection(%options);
|
||||
foreach my $queue (@{$self->{queues}}) {
|
||||
$queue =~ s/(.*)\///g;
|
||||
$self->{output}->add_disco_entry( name => $queue );
|
||||
};
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 MODE
|
||||
|
||||
List SQS queues.
|
||||
|
||||
=over 8
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
#
|
||||
# Copyright 2020 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::aws::sqs::mode::queues;
|
||||
|
||||
use base qw(centreon::plugins::templates::counter);
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
my %metrics_mapping = (
|
||||
'ApproximateAgeOfOldestMessage' => {
|
||||
'output' => 'age of oldest message',
|
||||
'label' => 'messages-oldest-age',
|
||||
'nlabel' => 'sqs.queue.messages.oldest.seconds',
|
||||
},
|
||||
'ApproximateNumberOfMessagesDelayed' => {
|
||||
'output' => 'delayed messages',
|
||||
'label' => 'messages-delayed',
|
||||
'nlabel' => 'sqs.queue.messages.delayed.count',
|
||||
},
|
||||
'ApproximateNumberOfMessagesNotVisible' => {
|
||||
'output' => 'approximate number of messages not visible',
|
||||
'label' => 'messages-notvisible',
|
||||
'nlabel' => 'sqs.queue.messages.notvisible.count',
|
||||
},
|
||||
'ApproximateNumberOfMessagesVisible' => {
|
||||
'output' => 'approximate number of messages visible',
|
||||
'label' => 'messages-visible',
|
||||
'nlabel' => 'sqs.queue.messages.visible.count',
|
||||
},
|
||||
'NumberOfEmptyReceives' => {
|
||||
'output' => 'number of empty receives',
|
||||
'label' => 'messages-empty-receives',
|
||||
'nlabel' => 'sqs.queue.messages.empty.count',
|
||||
},
|
||||
'NumberOfMessagesDeleted' => {
|
||||
'output' => 'number of messages deleted',
|
||||
'label' => 'messages-deleted',
|
||||
'nlabel' => 'sqs.queue.messages.deleted.count',
|
||||
},
|
||||
'NumberOfMessagesReceived' => {
|
||||
'output' => 'number of messages received',
|
||||
'label' => 'messages-received',
|
||||
'nlabel' => 'sqs.queue.messages.received.count',
|
||||
},
|
||||
'NumberOfMessagesSent' => {
|
||||
'output' => 'number of messages sent',
|
||||
'label' => 'messages-sent',
|
||||
'nlabel' => 'sqs.queue.messages.sent.count',
|
||||
},
|
||||
);
|
||||
|
||||
|
||||
sub prefix_metric_output {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
return "'" . $options{instance_value}->{display} . "' ";
|
||||
}
|
||||
|
||||
sub prefix_statistics_output {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
return "Statistic '" . $options{instance_value}->{display} . "' ";
|
||||
}
|
||||
|
||||
sub long_output {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
return "SQS Queue'" . $options{instance_value}->{display} . "' ";
|
||||
}
|
||||
|
||||
sub set_counters {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
$self->{maps_counters_type} = [
|
||||
{ name => 'metrics', type => 3, cb_prefix_output => 'prefix_metric_output', cb_long_output => 'long_output',
|
||||
message_multiple => 'All SQS metrics are ok', indent_long_output => ' ', display_ok => 0,
|
||||
group => [
|
||||
{ name => 'statistics', display_long => 1, cb_prefix_output => 'prefix_statistics_output',
|
||||
message_multiple => 'All metrics are ok', type => 1, skipped_code => { -10 => 1 } },
|
||||
]
|
||||
}
|
||||
];
|
||||
|
||||
foreach my $metric (keys %metrics_mapping) {
|
||||
my $entry = {
|
||||
label => $metrics_mapping{$metric}->{label},
|
||||
nlabel => $metrics_mapping{$metric}->{nlabel},
|
||||
set => {
|
||||
key_values => [ { name => $metric }, { name => 'display' } ],
|
||||
output_template => $metrics_mapping{$metric}->{output} . ': %d',
|
||||
display_ok => 0,
|
||||
perfdatas => [
|
||||
{ value => $metric , template => '%d', label_extra_instance => 1 }
|
||||
],
|
||||
}
|
||||
};
|
||||
push @{$self->{maps_counters}->{statistics}}, $entry;
|
||||
}
|
||||
}
|
||||
|
||||
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 => {
|
||||
"queue-name:s@" => { name => 'queue_name' },
|
||||
"filter-metric:s" => { name => 'filter_metric' },
|
||||
});
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub check_options {
|
||||
my ($self, %options) = @_;
|
||||
$self->SUPER::check_options(%options);
|
||||
|
||||
if (!defined($self->{option_results}->{queue_name}) || $self->{option_results}->{queue_name} eq '') {
|
||||
$self->{output}->add_option_msg(short_msg => "Need to specify --queue-name option.");
|
||||
$self->{output}->option_exit();
|
||||
};
|
||||
|
||||
foreach my $instance (@{$self->{option_results}->{queue_name}}) {
|
||||
if ($instance ne '') {
|
||||
push @{$self->{aws_instance}}, $instance;
|
||||
};
|
||||
}
|
||||
|
||||
$self->{aws_timeframe} = defined($self->{option_results}->{timeframe}) ? $self->{option_results}->{timeframe} : 600;
|
||||
$self->{aws_period} = defined($self->{option_results}->{period}) ? $self->{option_results}->{period} : 60;
|
||||
|
||||
$self->{aws_statistics} = ['Average'];
|
||||
if (defined($self->{option_results}->{statistic})) {
|
||||
$self->{aws_statistics} = [];
|
||||
foreach my $stat (@{$self->{option_results}->{statistic}}) {
|
||||
if ($stat ne '') {
|
||||
push @{$self->{aws_statistics}}, ucfirst(lc($stat));
|
||||
}
|
||||
}
|
||||
};
|
||||
foreach my $metric (keys %metrics_mapping) {
|
||||
next if (defined($self->{option_results}->{filter_metric}) && $self->{option_results}->{filter_metric} ne ''
|
||||
&& $metric !~ /$self->{option_results}->{filter_metric}/);
|
||||
push @{$self->{aws_metrics}}, $metric;
|
||||
};
|
||||
}
|
||||
|
||||
sub manage_selection {
|
||||
my ($self, %options) = @_;
|
||||
|
||||
my %metric_results;
|
||||
foreach my $instance (@{$self->{aws_instance}}) {
|
||||
$metric_results{$instance} = $options{custom}->cloudwatch_get_metrics(
|
||||
namespace => 'AWS/SQS',
|
||||
dimensions => [ { Name => 'QueueName', Value => $instance } ],
|
||||
metrics => $self->{aws_metrics},
|
||||
statistics => $self->{aws_statistics},
|
||||
timeframe => $self->{aws_timeframe},
|
||||
period => $self->{aws_period},
|
||||
);
|
||||
|
||||
foreach my $metric (@{$self->{aws_metrics}}) {
|
||||
foreach my $statistic (@{$self->{aws_statistics}}) {
|
||||
next if (!defined($metric_results{$instance}->{$metric}->{lc($statistic)}) &&
|
||||
!defined($self->{option_results}->{zeroed}));
|
||||
|
||||
$self->{metrics}->{$instance}->{display} = $instance;
|
||||
$self->{metrics}->{$instance}->{type} = $self->{option_results}->{type};
|
||||
$self->{metrics}->{$instance}->{statistics}->{lc($statistic)}->{display} = $statistic;
|
||||
$self->{metrics}->{$instance}->{statistics}->{lc($statistic)}->{$metric} =
|
||||
defined($metric_results{$instance}->{$metric}->{lc($statistic)}) ?
|
||||
$metric_results{$instance}->{$metric}->{lc($statistic)} : 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (scalar(keys %{$self->{metrics}}) <= 0) {
|
||||
$self->{output}->add_option_msg(short_msg => 'No metrics. Check your options or use --zeroed option to set 0 on undefined values');
|
||||
$self->{output}->option_exit();
|
||||
}
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 MODE
|
||||
|
||||
Check Amazon SQS queues metrics.
|
||||
|
||||
Example:
|
||||
perl centreon_plugins.pl --plugin=cloud::aws::sqs::plugin --custommode=paws --mode=queues --region='eu-west-1'
|
||||
--queue-name='my_aws_queue_1' --filter-metric='NumberOfMessagesSent' --statistic='average'
|
||||
--critical-messages-sent='200' --verbose
|
||||
|
||||
See 'https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-monitoring-using-cloudwatch.html' for more information.
|
||||
|
||||
Default statistic: 'average' / All satistics are valid.
|
||||
|
||||
=over 8
|
||||
|
||||
=item B<--queue-name>
|
||||
|
||||
Set the SQS queue name (Required) (Can be multiple, one instance per --queue-name option).
|
||||
Example: --queue-name="myqueue1" --queue-name="myqueue2".
|
||||
|
||||
=item B<--filter-metric>
|
||||
|
||||
Filter metrics (Can be: 'ApproximateAgeOfOldestMessage', 'ApproximateNumberOfMessagesDelayed',
|
||||
'ApproximateNumberOfMessagesNotVisible', 'ApproximateNumberOfMessagesVisible', 'NumberOfEmptyReceives',
|
||||
'NumberOfMessagesDeleted', 'NumberOfMessagesReceived', 'NumberOfMessagesSent').
|
||||
(Can be a regexp).
|
||||
|
||||
=item B<--warning-*> B<--critical-*>
|
||||
|
||||
Thresholds warning (Can be 'messages-oldest-age', 'messages-delayed',
|
||||
'messages-notvisible', 'messages-visible', 'messages-empty-receives',
|
||||
'messages-deleted', 'messages-received', 'messages-sent').
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
#
|
||||
# Copyright 2020 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::aws::sqs::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} = '1.0';
|
||||
%{ $self->{modes} } = (
|
||||
'queues' => 'cloud::aws::sqs::mode::queues',
|
||||
'list-queues' => 'cloud::aws::sqs::mode::listqueues'
|
||||
);
|
||||
|
||||
$self->{custom_modes}{paws} = 'cloud::aws::custom::paws';
|
||||
$self->{custom_modes}{awscli} = 'cloud::aws::custom::awscli';
|
||||
return $self;
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 PLUGIN DESCRIPTION
|
||||
|
||||
Check Amazon Simple Queue Service (Amazon SQS).
|
||||
|
||||
=cut
|
||||
Loading…
Reference in New Issue