From 2834ac766ef6cd6d9e228287eeb06351340667ba Mon Sep 17 00:00:00 2001
From: garnier-quentin <garnier.quentin@gmail.com>
Date: Tue, 19 Feb 2019 09:48:57 +0100
Subject: [PATCH] add plugin squid snmp

---
 apps/squid/snmp/mode/cacheusage.pm    | 136 ++++++++++++++
 apps/squid/snmp/mode/protocolstats.pm | 251 ++++++++++++++++++++++++++
 apps/squid/snmp/plugin.pm             |  49 +++++
 3 files changed, 436 insertions(+)
 create mode 100644 apps/squid/snmp/mode/cacheusage.pm
 create mode 100644 apps/squid/snmp/mode/protocolstats.pm
 create mode 100644 apps/squid/snmp/plugin.pm

diff --git a/apps/squid/snmp/mode/cacheusage.pm b/apps/squid/snmp/mode/cacheusage.pm
new file mode 100644
index 000000000..d2a435361
--- /dev/null
+++ b/apps/squid/snmp/mode/cacheusage.pm
@@ -0,0 +1,136 @@
+#
+# 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::squid::snmp::mode::cacheusage;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+
+sub set_counters {
+    my ($self, %options) = @_;
+    
+    $self->{maps_counters_type} = [
+        { name => 'global', type => 0, message_separator => ' - ', skipped_code => { -10 => 1 } }
+    ];
+        
+    $self->{maps_counters}->{global} = [
+        { label => 'cpu', set => {
+                key_values => [ { name => 'cacheCpuUsage' } ],
+                output_template => 'Cpu usage : %s %%',
+                perfdatas => [
+                    { label => 'cpu', value => 'cacheCpuUsage_absolute', template => '%s',
+                      min => 0, max => 100, unit => '%' },
+                ],
+            }
+        },
+        { label => 'memory', set => {
+                key_values => [ { name => 'cacheMemUsage' } ],
+                output_template => 'Memory usage : %s %s',
+                output_change_bytes => 1,
+                perfdatas => [
+                    { label => 'memory', value => 'cacheMemUsage_absolute', template => '%s',
+                      min => 0, unit => 'B' },
+                ],
+            }
+        },
+        { label => 'fd', set => {
+                key_values => [ { name => 'cacheCurrentFileDescrCnt' } ],
+                output_template => 'Number of file descriptors : %s',
+                perfdatas => [
+                    { label => 'fd', value => 'cacheCurrentFileDescrCnt_absolute', template => '%s',
+                      min => 0 },
+                ],
+            }
+        },
+        { label => 'object', set => {
+                key_values => [ { name => 'cacheNumObjCount' } ],
+                output_template => 'Number of object stored : %s',
+                perfdatas => [
+                    { label => 'objects', value => 'cacheNumObjCount_absolute', template => '%s',
+                      min => 0 },
+                ],
+            }
+        },
+    ];
+}
+
+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 =>
+                                { 
+                                });
+    
+    return $self;
+}
+
+sub manage_selection {
+    my ($self, %options) = @_;
+
+    my %oids = (
+        cacheMemUsage => '.1.3.6.1.4.1.3495.1.3.1.3.0',
+        cacheCpuUsage => '.1.3.6.1.4.1.3495.1.3.1.5.0',
+        cacheNumObjCount => '.1.3.6.1.4.1.3495.1.3.1.7.0',
+        cacheCurrentFileDescrCnt => '.1.3.6.1.4.1.3495.1.3.1.12.0',
+    );
+    my $snmp_result = $options{snmp}->get_leef(oids => [
+            values %oids
+        ], nothing_quit => 1);
+
+    $snmp_result->{$oids{cacheMemUsage}} *= 1024;
+    $self->{global} = {};
+    foreach (keys %oids) {
+        $self->{global}->{$_} = $snmp_result->{$oids{$_}} if (defined($snmp_result->{$oids{$_}}));
+    }
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+Check cache usage.
+
+=over 8
+
+=item B<--filter-counters>
+
+Only display some counters (regexp can be used).
+Example: --filter-counters='^(cpu)$'
+
+=item B<--warning-*>
+
+Threshold warning.
+Can be: 'cpu', 'memory', 'fd', 'object'.
+
+=item B<--critical-*>
+
+Threshold critical.
+Can be: 'cpu', 'memory', 'fd', 'object'.
+
+=back
+
+=cut
diff --git a/apps/squid/snmp/mode/protocolstats.pm b/apps/squid/snmp/mode/protocolstats.pm
new file mode 100644
index 000000000..16df25af3
--- /dev/null
+++ b/apps/squid/snmp/mode/protocolstats.pm
@@ -0,0 +1,251 @@
+#
+# 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::squid::snmp::mode::protocolstats;
+
+use base qw(centreon::plugins::templates::counter);
+
+use strict;
+use warnings;
+use Digest::MD5 qw(md5_hex);
+
+sub custom_data_calc {
+    my ($self, %options) = @_;
+
+    my $delta_value = $options{new_datas}->{$self->{instance} . '_cacheHttpHits'} - $options{old_datas}->{$self->{instance} . '_cacheHttpHits'};
+    my $delta_total = $options{new_datas}->{$self->{instance} . '_cacheProtoClientHttpRequests'} - $options{old_datas}->{$self->{instance} . '_cacheProtoClientHttpRequests'};
+
+    $self->{result_values}->{hits_prct} = 100;
+    if ($delta_total > 0) {
+        $self->{result_values}->{hits_prct} = $delta_value * 100 / $delta_total;
+    }
+    return 0;
+}
+
+
+sub set_counters {
+    my ($self, %options) = @_;
+    
+    $self->{maps_counters_type} = [
+        { name => 'global_http', type => 0, , cb_prefix_output => 'prefix_http_output', skipped_code => { -10 => 1 } },
+        { name => 'global_icq', type => 0, , cb_prefix_output => 'prefix_icq_output', skipped_code => { -10 => 1 } },
+        { name => 'global', type => 0, , cb_prefix_output => 'prefix_server_output', skipped_code => { -10 => 1 } }
+    ];
+    
+    $self->{maps_counters}->{global_http} = [
+         { label => 'http-hits-rate', set => {
+                key_values => [ { name => 'cacheProtoClientHttpRequests', diff => 1 }, { name => 'cacheHttpHits', diff => 1 } ],
+                closure_custom_calc => $self->can('custom_data_calc'),
+                output_template => 'hits rate : %.2f %%', output_use => 'hits_prct',
+                perfdatas => [
+                    { label => 'http_hits_rate', value => 'hits_prct', template => '%.2f', min => 0, max => 100, unit => '%' },
+                ],
+            }
+        },
+        { label => 'http-errors', set => {
+                key_values => [ { name => 'cacheHttpErrors', diff => 1 } ],
+                output_template => 'errors : %s',
+                perfdatas => [
+                    { label => 'http_errors', value => 'cacheHttpErrors_absolute', template => '%s',
+                      min => 0 },
+                ],
+            }
+        },
+        { label => 'http-traffic-in', set => {
+                key_values => [ { name => 'cacheHttpInKb', diff => 1 } ],
+                output_template => 'traffic in : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'http_traffic_in', value => 'cacheHttpInKb_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+        { label => 'http-traffic-out', set => {
+                key_values => [ { name => 'cacheHttpOutKb', diff => 1 } ],
+                output_template => 'traffic Out : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'http_traffic_out', value => 'cacheHttpOutKb_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+    ];
+
+    $self->{maps_counters}->{global_icq} = [
+        { label => 'icq-traffic-in', set => {
+                key_values => [ { name => 'cacheIcpKbRecv', diff => 1 } ],
+                output_template => 'traffic in : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'icq_traffic_in', value => 'cacheIcpKbRecv_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+        { label => 'icq-traffic-out', set => {
+                key_values => [ { name => 'cacheIcpKbSent', diff => 1 } ],
+                output_template => 'traffic Out : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'icq_traffic_out', value => 'cacheIcpKbSent_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+    ];
+        
+    $self->{maps_counters}->{global} = [
+        { label => 'server-traffic-in', set => {
+                key_values => [ { name => 'cacheServerInKb', diff => 1 } ],
+                output_template => 'traffic in : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'server_traffic_in', value => 'cacheServerInKb_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+        { label => 'server-traffic-out', set => {
+                key_values => [ { name => 'cacheServerOutKb', diff => 1 } ],
+                output_template => 'traffic Out : %s %s/s',
+                per_second => 1, output_change_bytes => 2,
+                perfdatas => [
+                    { label => 'server_traffic_out', value => 'cacheServerOutKb_per_second', template => '%s',
+                      min => 0, unit => 'b/s' },
+                ],
+            }
+        },
+        { label => 'clients', set => {
+                key_values => [ { name => 'cacheClients' } ],
+                output_template => 'current number of clients : %s',
+                perfdatas => [
+                    { label => 'clients', value => 'cacheClients_absolute', template => '%s',
+                      min => 0 },
+                ],
+            }
+        },
+    ];
+}
+
+sub prefix_http_output {
+    my ($self, %options) = @_;
+
+    return "HTTP ";
+}
+
+sub prefix_icq_output {
+    my ($self, %options) = @_;
+
+    return "ICQ ";
+}
+
+sub prefix_server_output {
+    my ($self, %options) = @_;
+
+    return "Server ";
+}
+
+sub new {
+    my ($class, %options) = @_;
+    my $self = $class->SUPER::new(package => __PACKAGE__, %options, statefile => 1);
+    bless $self, $class;
+    
+    $self->{version} = '1.0';
+    $options{options}->add_options(arguments =>
+                                { 
+                                });
+    
+    return $self;
+}
+
+sub manage_selection {
+    my ($self, %options) = @_;
+
+    my %oids = (
+        cacheProtoClientHttpRequests => '.1.3.6.1.4.1.3495.1.3.2.1.1.0',
+        cacheHttpHits => '.1.3.6.1.4.1.3495.1.3.2.1.2.0',
+        cacheHttpErrors => '.1.3.6.1.4.1.3495.1.3.2.1.3.0',
+        cacheHttpInKb => '.1.3.6.1.4.1.3495.1.3.2.1.4.0',
+        cacheHttpOutKb => '.1.3.6.1.4.1.3495.1.3.2.1.5.0',
+        cacheIcpKbSent => '.1.3.6.1.4.1.3495.1.3.2.1.8.0',
+        cacheIcpKbRecv => '.1.3.6.1.4.1.3495.1.3.2.1.9.0',
+        cacheServerInKb => '.1.3.6.1.4.1.3495.1.3.2.1.12.0',
+        cacheServerOutKb => '.1.3.6.1.4.1.3495.1.3.2.1.13.0',
+        cacheClients => '.1.3.6.1.4.1.3495.1.3.2.1.15.0',
+    );
+    my $snmp_result = $options{snmp}->get_leef(oids => [
+            values %oids
+        ], nothing_quit => 1);
+
+    $self->{global_http} = {
+        cacheProtoClientHttpRequests => $snmp_result->{$oids{cacheProtoClientHttpRequests}},
+        cacheHttpHits => $snmp_result->{$oids{cacheHttpHits}},
+        cacheHttpErrors => $snmp_result->{$oids{cacheHttpErrors}},
+        cacheHttpInKb => $snmp_result->{$oids{cacheHttpInKb}} * 1024 * 8,
+        cacheHttpOutKb => $snmp_result->{$oids{cacheHttpOutKb}} * 1024 * 8,
+    };
+    $self->{global_icq} = {
+        cacheIcpKbSent => $snmp_result->{$oids{cacheIcpKbSent}} * 1024 * 8,
+        cacheIcpKbRecv => $snmp_result->{$oids{cacheIcpKbRecv}} * 1024 * 8,
+    };
+    $self->{global} = {
+        cacheServerInKb => $snmp_result->{$oids{cacheServerInKb}} * 1024 * 8,
+        cacheServerOutKb => $snmp_result->{$oids{cacheServerOutKb}} * 1024 * 8,
+        cacheClients => $snmp_result->{$oids{cacheClients}},
+    };
+    
+    $self->{cache_name} = "squid_" . $self->{mode} . '_' . $options{snmp}->get_hostname()  . '_' . $options{snmp}->get_port() . '_' .
+        (defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : md5_hex('all'));
+}
+
+1;
+
+__END__
+
+=head1 MODE
+
+Check protocol statistics.
+
+=over 8
+
+=item B<--filter-counters>
+
+Only display some counters (regexp can be used).
+Example: --filter-counters='http'
+
+=item B<--warning-*>
+
+Threshold warning.
+Can be: 'http-hits-rate', 'http-errors', 'http-traffic-in', 'http-traffic-out',
+'icp-traffic-in', 'icp-traffic-out', 'server-traffic-in', 'server-traffic-out',
+'clients'.
+
+=item B<--critical-*>
+
+Threshold critical.
+Can be: 'http-hits-rate', 'http-errors', 'http-traffic-in', 'http-traffic-out',
+'icp-traffic-in', 'icp-traffic-out', 'server-traffic-in', 'server-traffic-out',
+'clients'.
+
+=back
+
+=cut
diff --git a/apps/squid/snmp/plugin.pm b/apps/squid/snmp/plugin.pm
new file mode 100644
index 000000000..ae0c4b96e
--- /dev/null
+++ b/apps/squid/snmp/plugin.pm
@@ -0,0 +1,49 @@
+#
+# 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::squid::snmp::plugin;
+
+use strict;
+use warnings;
+use base qw(centreon::plugins::script_snmp);
+
+sub new {
+    my ($class, %options) = @_;
+    my $self = $class->SUPER::new(package => __PACKAGE__, %options);
+    bless $self, $class;
+
+    $self->{version} = '1.0';
+    %{$self->{modes}} = (
+        'cache-usage'       => 'apps::squid::snmp::mode::cacheusage',
+        'protocol-stats'    => 'apps::squid::snmp::mode::protocolstats',
+    );
+
+    return $self;
+}
+
+1;
+
+__END__
+
+=head1 PLUGIN DESCRIPTION
+
+Check Squid proxy in SNMP.
+
+=cut