add quanta.io plugin

This commit is contained in:
Colin Gagnaire 2019-08-22 16:27:48 +02:00
parent d052083aed
commit 8a706e8643
3 changed files with 394 additions and 0 deletions

View File

@ -0,0 +1,202 @@
#
# 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 apps::monitoring::quanta::restapi::custom::api;
use strict;
use warnings;
use centreon::plugins::http;
use DateTime;
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 => {
"hostname:s" => { name => 'hostname' },
"url-path:s" => { name => 'url_path' },
"port:s" => { name => 'port' },
"proto:s" => { name => 'proto' },
"api-token:s" => { name => 'api_token' },
"timeout:s" => { name => 'timeout' },
});
}
$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} : 'app.quanta.io';
$self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 443;
$self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'https';
$self->{url_path} = (defined($self->{option_results}->{url_path})) ? $self->{option_results}->{url_path} : '/api';
$self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10;
$self->{api_token} = (defined($self->{option_results}->{api_token})) ? $self->{option_results}->{api_token} : '';
if (!defined($self->{api_token}) || $self->{api_token} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --api-token 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}->{url_path} = $self->{url_path};
$self->{option_results}->{warning_status} = '';
$self->{option_results}->{critical_status} = '';
}
sub settings {
my ($self, %options) = @_;
$self->build_options_for_httplib();
$self->{http}->add_header(key => 'Accept', value => 'application/json');
$self->{http}->set_options(%{$self->{option_results}});
}
sub get_api_token {
my ($self, %options) = @_;
return $self->{api_token};
}
sub request_api {
my ($self, %options) = @_;
$self->settings;
$self->{output}->output_add(long_msg => "Query URL: '" . $self->{proto} . "://" . $self->{hostname} .
$self->{url_path} . $options{url_path} . "'", debug => 1);
my $content = $self->{http}->request(url_path => $self->{url_path} . $options{url_path});
my $decoded;
eval {
$decoded = JSON::XS->new->utf8->decode($content);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => "Cannot decode json response: $@");
$self->{output}->option_exit();
}
if (defined($decoded->{error})) {
$self->{output}->add_option_msg(short_msg => "API returned error '" . $decoded->{error} . "'");
$self->{output}->option_exit();
}
return $decoded;
}
1;
__END__
=head1 NAME
Quanta Rest API
=head1 SYNOPSIS
Quanta Rest API custom mode
=head1 REST API OPTIONS
Quanta Rest API
=over 8
=item B<--hostname>
Quanta API hostname (Default: 'api.quanta.io')
=item B<--port>
API port (Default: 443)
=item B<--proto>
Specify https if needed (Default: 'https')
=item B<--url-path>
API URL path (Default: '/api')
=item B<--api-token>
API token.
=item B<--timeout>
Set HTTP timeout.
=back
=head1 DESCRIPTION
B<custom>.
=cut

View File

@ -0,0 +1,137 @@
#
# 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 apps::monitoring::quanta::restapi::mode::webscenariosavailability;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'global', type => 1, cb_prefix_output => 'prefix_output' }
];
$self->{maps_counters}->{global} = [
{ label => 'total-response-time', nlabel => 'total.response.time.seconds', set => {
key_values => [ { name => 'response_time' }, { name => 'display' } ],
output_template => 'Total Response Time: %.3fs',
perfdatas => [
{ value => 'response_time_absolute', template => '%.3f',
min => 0, unit => 's', label_extra_instance => 1, instance_use => 'display_absolute' },
],
}
},
{ label => 'availability', nlabel => 'availability.percentage', set => {
key_values => [ { name => 'availability' }, { name => 'display' } ],
output_template => 'Availability: %.2f%%',
perfdatas => [
{ value => 'availability_absolute', template => '%s',
min => 0, max => 100, unit => '%', label_extra_instance => 1, instance_use => 'display_absolute' },
],
}
},
{ label => 'step-response-time', nlabel => 'step.response.time.seconds', set => {
key_values => [ { name => 'avg_step_response_time' }, { name => 'display' } ],
output_template => 'Step Average Response Time: %.3fs',
perfdatas => [
{ value => 'avg_step_response_time_absolute', template => '%.3f',
min => 0, unit => 's', label_extra_instance => 1, instance_use => 'display_absolute' },
],
}
},
];
}
sub prefix_output {
my ($self, %options) = @_;
return "Scenario '" . $options{instance_value}->{display} . "' ";
}
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 => {
"scenario-id:s" => { name => 'scenario_id' },
"timeframe:s" => { name => 'timeframe', default => 900 },
});
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::check_options(%options);
if (!defined($self->{option_results}->{scenario_id}) || $self->{option_results}->{scenario_id} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --scenario-id option.");
$self->{output}->option_exit();
}
}
sub manage_selection {
my ($self, %options) = @_;
$self->{global} = {};
my $from = DateTime->now->subtract(seconds => $self->{option_results}->{timeframe});
my $to = DateTime->now;
my $from_epoch = $from->epoch;
my $to_epoch = $to->epoch;
my $url = '/partners/report/' . $options{custom}->get_api_token .
'?scenario=' . $self->{option_results}->{scenario_id} .
'&from=' . $from_epoch . '&to=' . $to_epoch;
my $results = $options{custom}->request_api(url_path => $url);
$self->{global}->{$results->{site}->{id}}->{display} = $results->{site}->{scenario};
$self->{global}->{$results->{site}->{id}}->{availability} = $results->{site}->{availability} * 100;
$self->{global}->{$results->{site}->{id}}->{avg_step_response_time} = $results->{site}->{avg_step_response_time};
foreach my $response (@{$results->{site}->{scenario_response_times}}) {
$self->{global}->{$results->{site}->{id}}->{response_time} += $response->{value};
}
$self->{global}->{$results->{site}->{id}}->{response_time} /= scalar(@{$results->{site}->{scenario_response_times}})
if (scalar(@{$results->{site}->{scenario_response_times}}) > 0);
}
1;
__END__
=head1 MODE
Check web scenario availability metrics.
=over 8
=item B<--warning-*> B<--critical-*>
Can be: 'total-response-time', 'availability',
'step-response-time'.
=back
=cut

View File

@ -0,0 +1,55 @@
#
# 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 apps::monitoring::quanta::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}} = (
'web-scenarios-availability' => 'apps::monitoring::quanta::restapi::mode::webscenariosavailability',
);
$self->{custom_modes}{api} = 'apps::monitoring::quanta::restapi::custom::api';
return $self;
}
sub init {
my ( $self, %options ) = @_;
$self->SUPER::init(%options);
}
1;
__END__
=head1 PLUGIN DESCRIPTION
Check Quanta.io application probes results.
=cut