From 7c123811d0a50e5ae0f563af74007e3e9cf927b3 Mon Sep 17 00:00:00 2001 From: Simon Bomm Date: Mon, 6 May 2019 11:43:41 +0200 Subject: [PATCH] + add new openweathermap plugin (#1491) --- apps/openweathermap/restapi/custom/api.pm | 226 ++++++++++++++++++ .../restapi/mode/cityweather.pm | 185 ++++++++++++++ apps/openweathermap/restapi/plugin.pm | 55 +++++ 3 files changed, 466 insertions(+) create mode 100644 apps/openweathermap/restapi/custom/api.pm create mode 100644 apps/openweathermap/restapi/mode/cityweather.pm create mode 100644 apps/openweathermap/restapi/plugin.pm diff --git a/apps/openweathermap/restapi/custom/api.pm b/apps/openweathermap/restapi/custom/api.pm new file mode 100644 index 000000000..337529ead --- /dev/null +++ b/apps/openweathermap/restapi/custom/api.pm @@ -0,0 +1,226 @@ +# +# 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::openweathermap::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} : 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->{url_path} = (defined($self->{option_results}->{url_path})) ? $self->{option_results}->{url_path} : '/data/2.5'; + $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->{hostname}) || $self->{hostname} eq '') { + $self->{output}->add_option_msg(short_msg => "Need to specify --hostname option."); + $self->{output}->option_exit(); + } + 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_connection_info { + my ($self, %options) = @_; + + return $self->{hostname} . ":" . $self->{port}; +} + +sub get_hostname { + my ($self, %options) = @_; + + return $self->{hostname}; +} + +sub get_port { + my ($self, %options) = @_; + + return $self->{port}; +} + +sub set_token { + my ($self, %options) = @_; + push @{$self->{get_param}}, 'APPID=' . $self->{api_token}; +} + +sub request_api { + my ($self, %options) = @_; + + $self->set_token(); + $self->settings; + + $self->{output}->output_add(long_msg => "Query URL: '" . $self->{proto} . "://" . $self->{hostname} . + $self->{url_path} . $options{url_path} . "'", debug => 1); + + foreach my $get_param (@{$options{get_param}}) { + push @{$self->{get_param}}, $get_param; + } + my $content = $self->{http}->request(url_path => $self->{url_path} . $options{url_path}, + get_param => \@{$self->{get_param}} + ); + + 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->{cod}) || $decoded->{cod} != 200) { + $self->{output}->output_add(long_msg => "Error message : " . $decoded->{errorDetails}, debug => 1); + $self->{output}->add_option_msg(short_msg => "API return error code '" . $decoded->{result} . "' (add --debug option for detailed message)"); + $self->{output}->option_exit(); + } + return $decoded; +} + +1; + +__END__ + +=head1 NAME + +Rudder Rest API + +=head1 SYNOPSIS + +Rudder Rest API custom mode + +=head1 REST API OPTIONS + +Rudder Rest API + +=over 8 + +=item B<--hostname> + +Rudder API hostname (api.openweathermap.org + +=item B<--port> + +API port (Default: 443) + +=item B<--proto> + +Specify https if needed (Default: 'https') + +=item B<--url-path> + +API URL path (Default: '/data/2.5') + +=item B<--timeout> + +Set HTTP timeout + +=back + +=head1 DESCRIPTION + +B. + +=cut diff --git a/apps/openweathermap/restapi/mode/cityweather.pm b/apps/openweathermap/restapi/mode/cityweather.pm new file mode 100644 index 000000000..e4f0e0b7c --- /dev/null +++ b/apps/openweathermap/restapi/mode/cityweather.pm @@ -0,0 +1,185 @@ +# +# 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::openweathermap::restapi::mode::cityweather; + +use base qw(centreon::plugins::templates::counter); + +use strict; +use warnings; +use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold); + +sub custom_status_output { + my ($self, %options) = @_; + + return sprintf("Weather: '%s'", $self->{result_values}->{weather}); +} + +sub custom_status_calc { + my ($self, %options) = @_; + + $self->{result_values}->{weather} = $options{new_datas}->{$self->{instance} . '_weather'}; + + return 0; +} + +sub set_counters { + my ($self, %options) = @_; + + $self->{maps_counters_type} = [ + { name => 'city', type => 0, cb_prefix_output => 'prefix_city_output' } + ]; + + $self->{maps_counters}->{city} = [ + { label => 'weather', set => { + key_values => [ { name => 'weather' } ], + closure_custom_calc => $self->can('custom_status_calc'), + closure_custom_output => $self->can('custom_status_output'), + closure_custom_perfdata => sub { return 0; }, + closure_custom_threshold_check => \&catalog_status_threshold, + } + }, + { label => 'temperature', nlabel => 'temperature.celsius', set => { + key_values => [ { name => 'temperature' } ], + output_template => 'Temperature: %d C°', + perfdatas => [ + { label => 'temperature', value => 'temperature_absolute', template => '%d', + unit => 'C' } + ], + } + }, + { label => 'humidity', nlabel => 'humidity.percentage', set => { + key_values => [ { name => 'humidity' } ], + output_template => 'Humidity: %.2f%%', + perfdatas => [ + { label => 'humidity', value => 'humidity_absolute', template => '%.1f', + min => 0, max => 100, unit => '%' } + ], + } + }, + { label => 'clouds', nlabel => 'clouds.percentage', set => { + key_values => [ { name => 'clouds' } ], + output_template => 'Clouds: %.2f%%', + perfdatas => [ + { label => 'clouds', value => 'clouds_absolute', template => '%.1f', + min => 0, max => 100, unit => '%' } + ], + } + }, + { label => 'wind', nlabel => 'wind.speed.meterspersecond', set => { + key_values => [ { name => 'wind' } ], + output_template => 'Wind: %.2f m/s', + perfdatas => [ + { label => 'wind', value => 'wind_absolute', template => '%.1f', + min => 0, unit => 'm/s' } + ], + } + } + ]; +} + +sub prefix_city_output { + my ($self, %options) = @_; + + return $self->{option_results}->{city_name} . " "; +} + +sub new { + my ($class, %options) = @_; + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + + $self->{version} = '1.0'; + $options{options}->add_options(arguments => { + "city-name:s" => { name => 'city_name' }, + "warning-weather:s" => { name => 'warning_weather', default => '' }, + "critical-weather:s" => { name => 'critical_weather', default => '' }, + }); + + return $self; +} + +sub check_options { + my ($self, %options) = @_; + $self->SUPER::check_options(%options); + + $self->change_macros(macros => ['warning_weather', 'critical_weather']); +} + +sub manage_selection { + my ($self, %options) = @_; + + $self->{city} = {}; + + my $results = $options{custom}->request_api(url_path => "/weather?", + get_param => ["q=" . $self->{option_results}->{city_name}]); + + $self->{city} = { + wind => $results->{wind}->{speed}, + humidity => $results->{main}->{humidity}, + temperature => $results->{main}->{temp} - 273.15, + clouds => $results->{clouds}->{all}, + weather => @{$results->{weather}->[0]}{main} + }; + + if (scalar(keys %{$self->{city}}) <= 0) { + $self->{output}->add_option_msg(short_msg => "No city found."); + $self->{output}->option_exit(); + } +} + +1; + +__END__ + +=head1 MODE + +Check city weather + +=over 8 + +=item B<--city-name> + +Filter node name (regexp can be used) + +=item B<--warning-weather> + +Set warning threshold on node compliance. + +=item B<--critical-weather> + +Set critical threshold on node compliance. + +=item B<--warning-status> + +Set warning threshold for status of rule compliance (Default: ''). +Can used special variables like: %{rule}, %{compliance} + +=item B<--critical-status> + +Set critical threshold for status of rule compliance (Default: ''). +Can used special variables like: %{rule}, %{compliance} + +Example : + --critical-status='%{rule} eq "Global configuration for all nodes" && %{compliance} < 95' + +=back + +=cut diff --git a/apps/openweathermap/restapi/plugin.pm b/apps/openweathermap/restapi/plugin.pm new file mode 100644 index 000000000..ee325863f --- /dev/null +++ b/apps/openweathermap/restapi/plugin.pm @@ -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::openweathermap::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}} = ( + 'city-weather' => 'apps::openweathermap::restapi::mode::cityweather', + ); + + $self->{custom_modes}{api} = 'apps::openweathermap::restapi::custom::api'; + return $self; +} + +sub init { + my ( $self, %options ) = @_; + + $self->SUPER::init(%options); +} + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check Openweathermap data + +=cut