tyler.durden
/
centreon-plugins
mirror of https://github.com/centreon/centreon-plugins.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

wip polycom trio rest api

This commit is contained in:
garnier-quentin 2020-01-27 16:42:26 +01:00
parent 3a64ae0e7c
commit d8126a979e
4 changed files with 496 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hardware/devices/cisco/ces/restapi/mode/callsrt.pm
View File

@ -160,7 +160,7 @@ sub set_counters {
closure_custom_output => $self->can('custom_loss_output'),
threshold_use => 'packets_loss_prct',
perfdatas => [
{ value => 'packets_loss_prct', template => '%d',
{ value => 'packets_loss_prct', template => '%.2f',
unit => '%', min => 0, max => 100, label_extra_instance => 1, instance_use => 'display' },
],
}

259
hardware/devices/polycom/trio/restapi/custom/api.pm Normal file
View File

@ -0,0 +1,259 @@
#
# 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 hardware::devices::polycom::trio::restapi::custom::api;
use base qw(centreon::plugins::mode);
use strict;
use warnings;
use centreon::plugins::http;
use JSON::XS;
use Digest::MD5 qw(md5_hex);
use Fcntl qw(:flock);
use POSIX;
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
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' },
'port:s' => { name => 'port'},
'proto:s' => { name => 'proto' },
'api-username:s' => { name => 'api_username', default => 'Polycom' },
'api-password:s' => { name => 'api_password' },
'timeout:s' => { name => 'timeout', default => 30 },
'lockfile-dir:s' => { name => 'lockfile_dir', default => '/var/lib/centreon/centplugins' },
'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} : undef;
$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->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 30;
$self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : 'Polycom';
$self->{api_password} = (defined($self->{option_results}->{api_password})) ? $self->{option_results}->{api_password} : undef;
$self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300';
$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} : '';
$self->{lockfile_dir} = (defined($self->{option_results}->{lockfile_dir})) ? $self->{option_results}->{lockfile_dir} : '/var/lib/centreon/centplugins';
$self->{timeout} = $1 if ($self->{timeout} =~ /(\d+)/);
if (!defined($self->{hostname}) || $self->{hostname} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --hostname option.");
$self->{output}->option_exit();
}
if (!defined($self->{api_username}) || $self->{api_username} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --api-username option.");
$self->{output}->option_exit();
}
if (!defined($self->{api_password}) || $self->{api_password} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --api-password 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};
$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 request_api {
my ($self, %options) = @_;
=for comment
my $tutu = do {
local $/ = undef;
if (!open my $fh, "<", '/tmp/plop.txt') {
$self->{output}->add_option_msg(short_msg => "Could not open file /tmp/plop.txt : $!");
$self->{output}->option_exit();
}
<$fh>;
};
my $tutu2;
eval {
$tutu2 = JSON::XS->new->utf8->decode($tutu);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => "cannot decode response (add --debug option to display returned content)");
$self->{output}->option_exit();
}
return $tutu2;
=cut
$self->settings();
my ($fh, $content);
my $lockfile = $self->{lockfile_dir} . '/polycom_trio_' . md5_hex($self->{hostname}) . '.lock';
if (!sysopen($fh, $lockfile, O_WRONLY | O_CREAT)) {
$self->{output}->add_option_msg(short_msg => "cannot open/create lock file '" . $lockfile . "': $!");
$self->{output}->option_exit();
}
eval {
local $SIG{ALRM} = sub { die 'timeout' };
alarm($self->{timeout} + 5);
flock($fh, LOCK_EX);
$content = $self->{http}->request(
method => 'GET',
url_path => $options{url_path},
unknown_status => $self->{unknown_http_status},
warning_status => $self->{warning_http_status},
critical_status => $self->{critical_http_status},
);
alarm(0);
flock($fh, LOCK_UN);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => 'plugin timeout: ' . $@);
$self->{output}->option_exit();
}
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();
}
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
Polycom Trio Rest API
=head1 REST API OPTIONS
=over 8
=item B<--hostname>
Set hostname.
=item B<--port>
Set port (Default: '443').
=item B<--proto>
Specify https if needed (Default: 'https').
=item B<--api-username>
Set username.
=item B<--api-password>
Set password.
=item B<--lockfile-dir>
Specify the lock file directory (Default: '/var/lib/centreon/centplugins').
=item B<--timeout>
Threshold for HTTP timeout (Default: '30').
=back
=cut

183
hardware/devices/polycom/trio/restapi/mode/callsrt.pm Normal file
View File

@ -0,0 +1,183 @@
#
# 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 hardware::devices::polycom::trio::restapi::mode::callsrt;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use Digest::MD5 qw(md5_hex);
sub custom_loss_calc {
my ($self, %options) = @_;
$self->{result_values}->{display_absolute} = $options{new_datas}->{$self->{instance} . '_display'};
my $diff_pkts = ($options{new_datas}->{$self->{instance} . '_packets'} - $options{old_datas}->{$self->{instance} . '_packets'});
my $diff_loss = ($options{new_datas}->{$self->{instance} . '_loss'} - $options{old_datas}->{$self->{instance} . '_loss'});
$self->{result_values}->{packets_loss} = $diff_loss;
$self->{result_values}->{packets_loss_prct} = 0;
$self->{result_values}->{packets} = $diff_pkts;
if ($diff_pkts > 0) {
$self->{result_values}->{packets_loss_prct} = ($diff_loss * 100) / $diff_pkts;
}
return 0;
}
sub custom_loss_output {
my ($self, %options) = @_;
return sprintf(
"packets loss: %.2f%% (%s on %s)",
$self->{result_values}->{packets_loss_prct},
$self->{result_values}->{packets_loss},
$self->{result_values}->{packets}
);
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'channels', type => 1, cb_prefix_output => 'prefix_channels_output', message_multiple => 'All call channels are ok', skipped_code => { -10 => 1 } }
];
$self->{maps_counters}->{channels} = [
{ label => 'channel-traffic-in', nlabel => 'call.channel.traffic.in.bytes', set => {
key_values => [ { name => 'traffic_in', diff => 1 }, { name => 'display' } ],
per_second => 1, output_change_bytes => 1,
output_template => 'traffic in: %s %s/s',
perfdatas => [
{ value => 'traffic_in_per_second', template => '%d',
unit => 'B/s', min => 0, label_extra_instance => 1 },
],
}
},
{ label => 'channel-traffic-out', nlabel => 'call.channel.traffic.out.bytes', set => {
key_values => [ { name => 'traffic_out', diff => 1 }, { name => 'display' } ],
per_second => 1, output_change_bytes => 1,
output_template => 'traffic out: %s %s/s',
perfdatas => [
{ value => 'traffic_out_per_second', template => '%d',
unit => 'B/s', min => 0, label_extra_instance => 1 },
],
}
},
{ label => 'channel-maxjitter', nlabel => 'call.channel.maxjitter.milliseconds', set => {
key_values => [ { name => 'max_jitter' }, { name => 'display' } ],
output_template => 'max jitter: %s ms',
perfdatas => [
{ value => 'max_jitter_absolute', template => '%d',
unit => 'ms', min => 0, label_extra_instance => 1 },
],
}
},
{ label => 'channel-packetloss', nlabel => 'call.channel.packetloss.count', set => {
key_values => [ { name => 'loss', diff => 1 }, { name => 'packets', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_loss_calc'),
closure_custom_output => $self->can('custom_loss_output'),
threshold_use => 'packets_loss',
perfdatas => [
{ value => 'packets_loss', template => '%d',
min => 0, label_extra_instance => 1 },
],
}
},
{ label => 'channel-packetloss-prct', nlabel => 'call.channel.packetloss.percentage', display_ok => 0, set => {
key_values => [ { name => 'loss', diff => 1 }, { name => 'packets', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_loss_calc'),
closure_custom_output => $self->can('custom_loss_output'),
threshold_use => 'packets_loss_prct',
perfdatas => [
{ value => 'packets_loss_prct', template => '%.2f',
unit => '%', min => 0, max => 100, label_extra_instance => 1 },
],
}
},
];
}
sub prefix_channels_output {
my ($self, %options) = @_;
return "Channel '" . $options{instance_value}->{display} ."' ";
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, force_new_perfdata => 1, statefile => 1);
bless $self, $class;
$self->{version} = '1.0';
$options{options}->add_options(arguments => {
});
return $self;
}
sub manage_selection {
my ($self, %options) = @_;
$self->{cache_name} = 'polycom_trio_' . $options{custom}->{hostname} . '_' . $self->{mode} . '_' .
(defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : md5_hex('all'));
my $result = $options{custom}->request_api(url_path => '/api/v1/mgmt/media/sessionStats');
$self->{channels} = {};
if (!defined($result->{data}->[0]->{Streams})) {
$self->{output}->output_add(
severity => 'OK',
short_msg => ' no audio/video call running'
);
return ;
}
foreach (@{$result->{data}->[0]->{Streams}}) {
$self->{channels}->{lc($_->{Category})} = {
display => lc($_->{Category}),
traffic_in => $_->{OctetsReceived},
traffic_out => $_->{OctetsSent},
max_jitter => $_->{MaxJitter},
loss => $_->{PacketsLost},
packets => $_->{PacketsReceived}
};
}
}
1;
__END__
=head1 MODE
Check call audio/video channels in real-time.
=over 8
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'channel-traffic-in', 'channel-traffic-out', 'channel-maxjitter'
'channel-packetloss', 'channel-packetloss-prct'.
=back
=cut

53
hardware/devices/polycom/trio/restapi/plugin.pm Normal file
View File

@ -0,0 +1,53 @@
#
# 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 hardware::devices::polycom::trio::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} = '1.0';
%{$self->{modes}} = (
'calls-rt' => 'hardware::devices::polycom::trio::restapi::mode::callsrt',
);
$self->{custom_modes}{api} = 'hardware::devices::polycom::trio::restapi::custom::api';
return $self;
}
1;
__END__
=head1 PLUGIN DESCRIPTION
Check Polycom Trio (8300, 8500, 8800) through HTTP/REST API.
=over 8
=back
=cut