New(plugin)app monitoring alyvix restapi (#2294)

apps/monitoring/alyvix/restapi/custom/api.pm

@@ -0,0 +1,226 @@
+#
+# 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 apps::monitoring::alyvix::restapi::custom::api;
+
+use strict;
+use warnings;
+use centreon::plugins::http;
+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-username:s'         => { name => 'api_username' },
+            'api-password:s'         => { name => 'api_password' },
+            'timeout:s'              => { name => 'timeout' },
+            '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->{http} = centreon::plugins::http->new(%options);
+
+    return $self;
+}
+
+sub set_options {
+    my ($self, %options) = @_;
+
+    $self->{option_results} = $options{option_results};
+}
+
+sub set_defaults {}
+
+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} : 80;
+    $self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'http';
+    $self->{url_path} = (defined($self->{option_results}->{url_path})) ? $self->{option_results}->{url_path} : '/v0/';
+    $self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10;
+    $self->{api_username} = (defined($self->{option_results}->{api_username})) ? $self->{option_results}->{api_username} : undef;
+    $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_status} : '';
+    $self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_status} : '';
+    $self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_status} : '';
+
+    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 settings {
+    my ($self, %options) = @_;
+
+    $self->{http}->add_header(key => 'Content-Type', 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 json_decode {
+    my ($self, %options) = @_;
+
+    my $decoded;
+    eval {
+        $decoded = JSON::XS->new->utf8->decode($options{content});
+    };
+    
+    if ($@) {
+        $self->{output}->add_option_msg(short_msg => "Cannot decode json response: $@");
+        $self->{output}->option_exit();
+    }
+
+    return $decoded;
+}
+
+sub request_api {
+    my ($self, %options) = @_;
+
+    $self->settings();
+    
+    my $content = $self->{http}->request(
+        url_path => $self->{url_path} . $options{endpoint},
+        unknown_status => $self->{unknown_http_status},
+        warning_status => $self->{warning_http_status},
+        critical_status => $self->{critical_http_status}
+    );
+
+    my $decoded = $self->json_decode(content => $content);
+
+    return $decoded;
+}
+
+1;
+
+__END__
+
+=head1 NAME
+
+Alyvix Server Rest API.
+
+=head1 SYNOPSIS
+
+Alyvix Rest API custom mode.
+
+=head1 REST API OPTIONS
+
+Alyvix Server Rest API.
+
+=over 8
+
+=item B<--hostname>
+
+Alyvix Server hostname.
+
+=item B<--url-path>
+
+API url path (Default: '/v0/')
+
+=item B<--port>
+
+API port (Default: 80)
+
+=item B<--proto>
+
+Specify https if needed (Default: 'http')
+
+=item B<--credentials>
+
+Specify this option if you access the API with authentication
+
+=item B<--username>
+
+Specify username for authentication (Mandatory if --credentials is specified)
+
+=item B<--password>
+
+Specify password for authentication (Mandatory if --credentials is specified)
+
+=item B<--basic>
+
+Specify this option if you access the API over basic authentication and don't want a '401 UNAUTHORIZED' error to be logged on your webserver.
+
+Specify this option if you access the API over hidden basic authentication or you'll get a '404 NOT FOUND' error.
+
+(Use with --credentials)
+
+=item B<--timeout>
+
+Set HTTP timeout
+
+=back
+
+=head1 DESCRIPTION
+
+B<custom>.
+
+=cut

apps/monitoring/alyvix/restapi/mode/listtestcases.pm

@@ -0,0 +1,107 @@
+#
+## 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 apps::monitoring::alyvix::restapi::mode::listtestcases;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold);
+
+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-testcase:s'   => { name => 'filter_testcase' },
+    });
+
+    return $self;
+}
+
+sub manage_selection {
+    my ($self, %options) = @_;
+    
+    my $result = $options{custom}->request_api(endpoint => 'testcases');
+    return $result->{testcases};
+}
+
+sub run {
+    my ($self, %options) = @_;
+
+    my $testcases = $self->manage_selection(%options);
+    foreach my $testcase (values $testcases) {
+        next if (defined($self->{option_results}->{filter_testcase})
+            && $self->{option_results}->{filter_testcase} ne ''
+            && $testcase->{testcase_alias} !~ /$self->{option_results}->{filter_testcase}/ );
+
+        $self->{output}->output_add(long_msg =>
+            sprintf(
+                '[name = %s]',$testcase->{testcase_alias} 
+            )
+        );
+    }
+
+    $self->{output}->output_add(
+        severity => 'OK',
+        short_msg => 'List test cases:'
+    );
+
+    $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) = @_;
+
+    my $testcases = $self->manage_selection(%options);
+    foreach my $testcase (values  $testcases) {
+        next if (defined($self->{option_results}->{filter_case})
+            && $self->{option_results}->{filter_case} ne ''
+            && $testcase->{scenario} !~ /$self->{option_results}->{filter_case}/ );
+        $self->{output}->add_disco_entry(name => $testcases->{testcase_alias});
+    }
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+List Alyvix Server test cases.
+
+=over 8
+
+=item B<--filter-testcase>
+
+Filter on specific test case.
+
+=back
+
+=cut

apps/monitoring/alyvix/restapi/mode/testcases.pm

@@ -0,0 +1,188 @@
+#
+## 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 apps::monitoring::alyvix::restapi::mode::testcases;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng);
+
+sub custom_status_output {
+    my ($self, %options) = @_;
+
+    return sprintf(
+        'state: %s',
+        $self->{result_values}->{state},
+    );
+}
+
+sub testcase_long_output {
+    my ($self, %options) = @_;
+
+    return "checking test case '" . $options{instance_value}->{display} . "'";
+}
+
+sub prefix_testcases_output {
+    my ($self, %options) = @_;
+
+    return "test case '" . $options{instance_value}->{display} . "' ";
+}
+
+sub prefix_testcase_output {
+    my ($self, %options) = @_;
+
+    return "transaction '" . $options{instance_value}->{display} . "' ";
+}
+
+sub set_counters {
+    my ($self, %options) = @_;
+
+    $self->{maps_counters_type} = [
+        { name => 'cases', type => 3, cb_prefix_output => 'prefix_testcases_output', cb_long_output => 'testcase_long_output', indent_long_output => '    ', message_multiple => 'All test cases are ok',
+            group => [
+                { name => 'global', type => '0' },
+                { name => 'testcases', display_long => 1, cb_prefix_output => 'prefix_testcase_output',  message_multiple => 'test cases are ok', type => 1, skipped_code => { -10 => 1 } }
+            ]
+        }
+    ];
+
+    $self->{maps_counters}->{global} = [
+        { label => 'testcase-duration', nlabel => 'testcase.duration.milliseconds', set => {
+                key_values => [ { name => 'duration' }, { name => 'display' } ],
+                output_template => 'duration: %s ms',
+                perfdatas => [
+                    { template => '%d', unit => 'ms', min => 0, label_extra_instance => 1},
+                ],
+            }
+        },
+        { label => 'testcase-state', type => 2, critical_default => '%{state} eq "FAILED"', set => {
+                key_values => [ { name => 'state' }, { name => 'display' } ],
+                closure_custom_output => $self->can('custom_status_output'),
+                closure_custom_perfdata => sub { return 0; },
+                closure_custom_threshold_check => \&catalog_status_threshold_ng
+            }
+        },
+    ];
+
+    $self->{maps_counters}->{testcases} = [
+        { label => 'transaction-state', type => 2, critical_default => '%{state} eq "FAILED"', set => {
+                key_values => [ { name => 'state' }, { name => 'display' } ],
+                closure_custom_output => $self->can('custom_status_output'),
+                closure_custom_perfdata => sub { return 0; },
+                closure_custom_threshold_check => \&catalog_status_threshold_ng
+            }
+        },
+        { label => 'transaction-duration',  nlabel => 'transaction.duration.milliseconds', set => {
+                key_values => [ { name => 'duration' }, { name => 'display' } ],
+                output_template => 'duration: %s ms',
+                perfdatas => [
+                    { template => '%s', unit => 'ms', min => 0, label_extra_instance => 1 }
+                ],
+            }
+        }
+    ];
+}
+
+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-testcase:s'   => { name => 'filter_testcase' },
+    });
+
+    return $self;
+}
+
+sub manage_selection {
+    my ($self, %options) = @_;
+
+    my %status = (  0 => 'OK', 2 => 'FAILED' );
+    my $results = $options{custom}->request_api(endpoint => '/testcases/');
+    my $i;
+    foreach (@{$results->{testcases}}) {
+        next if (defined($self->{option_results}->{filter_testcase})
+            && $self->{option_results}->{filter_testcase} ne ''
+            && $_->{testcase_alias} !~ /$self->{option_results}->{filter_testcase}/ );
+
+        my $measures = $options{custom}->request_api(endpoint => '/testcases/' . $_->{testcase_alias} . '/');
+        $i = 1;
+        $self->{cases}->{$_->{testcase_alias}} = {
+                    display => $_->{testcase_alias},
+                    global => {
+                        display => $_->{testcase_alias},
+                        duration => $measures->{measures}[0]->{test_case_duration_ms},
+                        state => $status{$measures->{measures}[0]->{test_case_state}}
+                    },
+                    testcases => {}
+        };
+
+        foreach my $transaction (values $measures->{measures}){
+            my $instance = $i . '_' . $transaction->{transaction_alias};
+            $instance =~ s/ /_/g;
+            $self->{cases}->{$_->{testcase_alias}}->{testcases}->{$instance} = {
+                display => $instance,
+                state => $status{$transaction->{transaction_state}},
+                duration => $transaction->{transaction_performance_ms}
+            };
+        $i++;
+        }
+    }
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+Check Alyvix Server test cases using Alyvix Rest API
+
+Example:
+perl centreon_plugins.pl --plugin=apps::monitoring::alyvix::restapi::plugin --mode=testcases --hostname='10.0.0.1'
+
+=over 8
+
+=item B<--filter-testcase>
+
+Filter on specific test case.
+
+=item B<--warning-*-state>
+
+Set warning status (Default: '') where '*' can be 'testcase' or 'transaction'.
+
+=item B<--critical-*-state>
+
+Set critical status (Default: '%{state} eq "FAILED"') where '*' can be 'testcase' or 'transaction'.
+
+=item B<--warning-*-duration>
+
+Set warning threshold for test cases or transactions duration (Default: '') where '*' can be 'testcase' or 'transaction'. 
+
+=item B<--critical-*-duration>
+
+Set critical threshold for test cases or transactions duration (Default: '') where '*' can be 'testcase' or 'transaction'.
+
+=back
+
+=cut

apps/monitoring/alyvix/restapi/plugin.pm

@@ -0,0 +1,50 @@
+#
+# 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 apps::monitoring::alyvix::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} = { 
+        'list-testcases' => 'apps::monitoring::alyvix::restapi::mode::listtestcases',
+        'testcases' => 'apps::monitoring::alyvix::restapi::mode::testcases',
+    };
+
+    $self->{custom_modes}->{api} = 'apps::monitoring::alyvix::restapi::custom::api';
+    return $self;
+}
+
+1;
+
+__END__
+
+=head1 PLUGIN DESCRIPTION
+
+Check Alyvix Server using REST API.
+
+=cut