Merge pull request #1933 from centreon/tibs_AWS_VPN

add(plugin): AWS VPN

centreon-plugins/cloud/aws/custom/awscli.pm

@@ -411,7 +411,6 @@ sub ec2_list_resources {
                 Tags => join(",", @instance_tags),
                 KeyName => $instance->{KeyName},
             };
-            
         }
     }
 
@@ -524,6 +523,40 @@ sub rds_list_clusters {
     return $cluster_results;
 }
 
+sub vpn_list_connections_set_cmd {
+    my ($self, %options) = @_;
+
+    return if (defined($self->{option_results}->{command_options}) && $self->{option_results}->{command_options} ne '');
+
+    my $cmd_options = "ec2 describe-vpn-connections --region $options{region} --output json";
+    $cmd_options .= " --endpoint-url $self->{endpoint_url}" if (defined($self->{endpoint_url}) && $self->{endpoint_url} ne '');
+
+    return $cmd_options;
+}
+
+sub vpn_list_connections {
+    my ($self, %options) = @_;
+
+    my $cmd_options = $self->vpn_list_connections_set_cmd(%options);
+    my $raw_results = $self->execute(cmd_options => $cmd_options);
+
+    my $connections_results = [];
+    foreach my $connection (@{$raw_results->{VpnConnections}}) {
+        my @name_tags;
+            foreach my $tag (@{$connection->{Tags}}) {
+                if ($tag->{Key} eq "Name" && defined($tag->{Value})) {
+                    push @name_tags, $tag->{Value};
+                }
+            }
+        push @{$connections_results}, {
+            id      => $connection->{VpnConnectionId},
+            name    => join(",", @name_tags),
+            state   => $connection->{State}
+        }
+    };
+    return $connections_results;
+}
+
 1;
 
 __END__

centreon-plugins/cloud/aws/custom/paws.pm

@@ -446,6 +446,35 @@ sub rds_list_clusters {
     return $cluster_results;
 }
 
+sub vpn_list_connections {
+    my ($self, %options) = @_;
+    my $connections_results = [];
+    eval {
+        my $lwp_caller = new Paws::Net::LWPCaller();
+        my $rds = Paws->service('EC2', caller => $lwp_caller, region => $options{region});
+        my $list_vpn = $vpn->DescribeVpnConnections();
+        foreach my $connection (@{$list_vpn->{VpnConnections}}) {
+            my @name_tags;
+                foreach my $tag (@{$connection->{Tags}}) {
+                    if ($tag->{Key} eq "Name" && defined($tag->{Value})) {
+                        push @name_tags, $tag->{Value};
+                    }
+                }
+            push @{$connections_results}, {
+                id      => $connection->{VpnConnectionId},
+                name    => join(",", @name_tags),
+                state   => $connection->{State}
+            }
+        };
+    };
+    if ($@) {
+        $self->{output}->add_option_msg(short_msg => "error: $@");
+        $self->{output}->option_exit();
+    }
+
+    return $connections_results;
+}
+
 1;
 
 __END__
@@ -484,7 +513,8 @@ Set timeframe in seconds.
 
 =item B<--statistic>
 
-Set cloudwatch statistics (Can be: 'minimum', 'maximum', 'average', 'sum').
+Set cloudwatch statistics
+(Can be: 'minimum', 'maximum', 'average', 'sum').
 
 =item B<--zeroed>
 

centreon-plugins/cloud/aws/vpn/mode/listvpn.pm

@@ -0,0 +1,96 @@
+#
+# 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::vpn::mode::listvpn;
+
+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->{connection} = $options{custom}->vpn_list_connections(region => $self->{option_results}->{region});
+}
+
+sub run {
+    my ($self, %options) = @_;
+
+    $self->manage_selection(%options);
+    foreach (@{$self->{connection}}) {
+        $self->{output}->output_add(
+            long_msg => sprintf("[Id = %s][Name = %s][State = %s]",
+            $_->{id}, $_->{name}, $_->{state} ));
+    }
+
+    $self->{output}->output_add(severity => 'OK',
+                                short_msg => 'List VPN connections:');
+    $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 => ['id', 'name', 'state']);
+}
+
+sub disco_show {
+    my ($self, %options) = @_;
+
+    $self->manage_selection(%options);
+    foreach (@{$self->{connection}}) {
+        $self->{output}->add_disco_entry(
+            id => $_->{id},
+            name => $_->{name},
+            state => $_->{state},
+        );
+    };
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+List VPN instances.
+
+=over 8
+
+=back
+
+=cut

centreon-plugins/cloud/aws/vpn/mode/traffic.pm

@@ -0,0 +1,315 @@
+#
+# 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::vpn::mode::traffic;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+
+my %metrics_mapping = (
+    'TunnelState' => {
+        'output'    => 'Tunnel State',
+        'label'     => 'tunnel-state',
+        'nlabel'    => {
+            'absolute' => 'vpn.tunnel.tunnelstate'},
+        'unit'      => ''
+    },
+    'TunnelDataIn' => {
+        'output'    => 'Tunnel Data In',
+        'label'     => 'tunnel-datain',
+        'nlabel'    => {
+            'absolute' => 'vpn.tunnel.datain.bytes',
+            'per_second' => 'vpn.tunnel.datain.bytespersecond',
+        },
+        'unit'      => 'B'
+    },
+    'TunnelDataOut' => {
+        'output'    => 'Tunnel Data Out',
+        'label'     => 'tunnel-dataout',
+        'nlabel'    => {
+            'absolute' => 'vpn.tunnel.dataout.bytes',
+            'per_second' => 'vpn.tunnel.dataout.bytespersecond',
+        },
+        'unit'      => 'B'
+    }
+);
+
+
+sub custom_metric_calc {
+    my ($self, %options) = @_;
+
+    $self->{result_values}->{timeframe} = $options{new_datas}->{$self->{instance} . '_timeframe'};
+    $self->{result_values}->{value} = $options{new_datas}->{$self->{instance} . '_' . $options{extra_options}->{metric}};
+    $self->{result_values}->{value_per_sec} = $self->{result_values}->{value} / $self->{result_values}->{timeframe};
+    $self->{result_values}->{metric} = $options{extra_options}->{metric};
+    return 0;
+}
+
+sub custom_metric_calc_state {
+    my ($self, %options) = @_;
+
+    $self->{result_values}->{timeframe} = $options{new_datas}->{$self->{instance} . '_timeframe'};
+    $self->{result_values}->{value} = $options{new_datas}->{$self->{instance} . '_' . $options{extra_options}->{metric}};
+    $self->{result_values}->{value_per_sec} = $self->{result_values}->{value};
+    $self->{result_values}->{metric} = $options{extra_options}->{metric};
+    return 0;
+}
+
+sub custom_metric_threshold {
+    my ($self, %options) = @_;
+
+    my $exit = $self->{perfdata}->threshold_check(
+        value       => defined($self->{instance_mode}->{option_results}->{per_sec}) ? $self->{result_values}->{value_per_sec} : $self->{result_values}->{value},
+        threshold   => [ { label => 'critical-' . $metrics_mapping{$self->{result_values}->{metric}}->{label} , exit_litteral => 'critical' },
+                       { label => 'warning-' . $metrics_mapping{$self->{result_values}->{metric}}->{label}, exit_litteral => 'warning' } ]
+    );
+    return $exit;
+}
+
+sub custom_metric_perfdata {
+    my ($self, %options) = @_;
+
+    $self->{output}->perfdata_add(
+        instances => $self->{instance},
+        label       => $metrics_mapping{$self->{result_values}->{metric}}->{label},
+        nlabel      => defined($self->{instance_mode}->{option_results}->{per_sec}) ?
+            $metrics_mapping{$self->{result_values}->{metric}}->{nlabel}->{per_second} :
+            $metrics_mapping{$self->{result_values}->{metric}}->{nlabel}->{absolute},
+        unit        => defined($self->{instance_mode}->{option_results}->{per_sec}) ?
+            $metrics_mapping{$self->{result_values}->{metric}}->{unit} . '/s' :
+            $metrics_mapping{$self->{result_values}->{metric}}->{unit},
+        value       => sprintf("%.2f", defined($self->{instance_mode}->{option_results}->{per_sec}) ?
+            $self->{result_values}->{value_per_sec} :
+            $self->{result_values}->{value}),
+        warning     => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $metrics_mapping{$self->{result_values}->{metric}}->{label}),
+        critical    => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $metrics_mapping{$self->{result_values}->{metric}}->{label}),
+    );
+}
+
+sub custom_metric_perfdata_state {
+    my ($self, %options) = @_;
+
+    $self->{output}->perfdata_add(
+        instances   => $self->{instance},
+        label       => $metrics_mapping{$self->{result_values}->{metric}}->{label},
+        nlabel      => $metrics_mapping{$self->{result_values}->{metric}}->{nlabel}->{absolute},
+        unit        => $metrics_mapping{$self->{result_values}->{metric}}->{unit},
+        value       => sprintf("%.2f", $self->{result_values}->{value}),
+        warning     => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $metrics_mapping{$self->{result_values}->{metric}}->{label}),
+        critical    => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $metrics_mapping{$self->{result_values}->{metric}}->{label}),
+    );
+}
+
+sub custom_metric_output {
+    my ($self, %options) = @_;
+    my $msg = "";
+
+    if (defined($self->{instance_mode}->{option_results}->{per_sec})) {
+        my ($value, $unit) = ($metrics_mapping{$self->{result_values}->{metric}}->{unit} eq 'B') ?
+            $self->{perfdata}->change_bytes(value => $self->{result_values}->{value_per_sec}) :
+            ($self->{result_values}->{value_per_sec}, $metrics_mapping{$self->{result_values}->{metric}}->{unit});
+        $msg = sprintf("%s: %.2f %s", $metrics_mapping{$self->{result_values}->{metric}}->{output}, $value, $unit . '/s');
+    } else {
+        my ($value, $unit) = ($metrics_mapping{$self->{result_values}->{metric}}->{unit} eq 'B') ?
+            $self->{perfdata}->change_bytes(value => $self->{result_values}->{value}) :
+            ($self->{result_values}->{value}, $metrics_mapping{$self->{result_values}->{metric}}->{unit});
+        $msg = sprintf("%s: %.2f %s", $metrics_mapping{$self->{result_values}->{metric}}->{output}, $value, $unit);
+    }
+    return $msg;
+}
+
+sub custom_metric_output_state {
+    my ($self, %options) = @_;
+    my $msg = "";
+
+    my $value = $self->{result_values}->{value};
+    $msg = sprintf("%s: %.2f", $metrics_mapping{$self->{result_values}->{metric}}->{output}, $value);
+    return $msg;
+}
+
+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} . "' Metrics ";
+}
+
+sub long_output {
+    my ($self, %options) = @_;
+
+    return "AWS VPN Tunnel'" . $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 VPN metrics are ok', indent_long_output => '    ',
+            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},
+            set => {
+                key_values                          => [ { name => $metric }, { name => 'timeframe' }, { name => 'display' } ],
+                closure_custom_calc                 => ($metric =~ /State/) ? $self->can('custom_metric_calc_state') :  $self->can('custom_metric_calc'),
+                closure_custom_calc_extra_options   => { metric => $metric },
+                closure_custom_output               => ($metric =~ /State/) ? $self->can('custom_metric_output_state') : $self->can('custom_metric_output'),
+                closure_custom_perfdata             => ($metric =~ /State/) ? $self->can('custom_metric_perfdata_state') : $self->can('custom_metric_perfdata'),
+                closure_custom_threshold_check      => $self->can('custom_metric_threshold'),
+            }
+        }
+        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 => {
+        'vpnid:s@'          => { name => 'vpn_id' },
+        'per-sec'           => { name => 'per_sec' },
+        'filter-metric:s'   => { name => 'filter_metric' }
+    });
+
+    return $self;
+}
+
+sub check_options {
+    my ($self, %options) = @_;
+    $self->SUPER::check_options(%options);
+
+    if (!defined($self->{option_results}->{vpn_id}) || $self->{option_results}->{vpn_id} eq '') {
+        $self->{output}->add_option_msg(short_msg => "Need to specify --vpnid option.");
+        $self->{output}->option_exit();
+    };
+
+    foreach my $instance (@{$self->{option_results}->{vpn_id}}) {
+        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(
+            region      => $self->{option_results}->{region},
+            namespace   => 'AWS/VPN',
+            dimensions  => [ { Name => 'VpnId', 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}->{statistics}->{lc($statistic)}->{display} = $statistic;
+                $self->{metrics}->{$instance}->{statistics}->{lc($statistic)}->{timeframe} = $self->{aws_timeframe};
+                $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 AWS VPN Connection.
+
+Example:
+perl centreon_plugins.pl --plugin=cloud::aws::vpn::plugin --custommode=awscli --mode=traffic --region='eu-west-1'
+--vpnid='vpn-1234567890abcdefg' --warning-tunnel-state='1:' --critical-tunnel-state='0.5:' --warning --verbose
+
+See 'https://docs.aws.amazon.com/vpn/latest/s2svpn/monitoring-cloudwatch-vpn.html' for more information.
+
+
+=over 8
+
+=item B<--vpnid>
+
+Set the VpnId (Required).
+
+=item B<--filter-metric>
+
+Filter on a specific metric.
+Can be: TunnelState, TunnelDataIn, TunnelDataOut
+
+=item B<--warning-$metric$>
+
+Warning thresholds ($metric$ can be: 'tunnel-state', 'tunnel-datain', 'tunnel-dataout').
+
+=item B<--critical-$metric$>
+
+Critical thresholds ($metric$ can be: 'tunnel-state', 'tunnel-datain', 'tunnel-dataout').
+
+=back
+
+=cut

centreon-plugins/cloud/aws/vpn/plugin.pm

@@ -0,0 +1,52 @@
+#
+# 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::vpn::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} } = (
+        'traffic'     => 'cloud::aws::vpn::mode::traffic',
+        'listvpn'     => 'cloud::aws::vpn::mode::listvpn',
+        'discovery'   => 'cloud::aws::vpn::mode::discovery'
+    );
+
+    $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 Site-To-Site VPN (Amazon VPN).
+
+=cut