centreon-plugins/network/athonet/epc/snmp/mode/license.pm

377 lines
15 KiB
Perl

#
# Copyright 2021 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 network::athonet::epc::snmp::mode::license;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use centreon::plugins::misc;
use DateTime;
use POSIX;
use centreon::plugins::templates::catalog_functions qw(catalog_status_threshold_ng);
my $unitdiv = { s => 1, w => 604800, d => 86400, h => 3600, m => 60 };
my $unitdiv_long = { s => 'seconds', w => 'weeks', d => 'days', h => 'hours', m => 'minutes' };
sub custom_expires_perfdata {
my ($self, %options) = @_;
$self->{output}->perfdata_add(
nlabel => $self->{nlabel} . '.' . $unitdiv_long->{ $self->{instance_mode}->{option_results}->{unit} },
unit => $self->{instance_mode}->{option_results}->{unit},
value => floor($self->{result_values}->{expires_seconds} / $unitdiv->{ $self->{instance_mode}->{option_results}->{unit} }),
warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}),
critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}),
min => 0
);
}
sub custom_expires_threshold {
my ($self, %options) = @_;
return $self->{perfdata}->threshold_check(
value => floor($self->{result_values}->{expires_seconds} / $unitdiv->{ $self->{instance_mode}->{option_results}->{unit} }),
threshold => [
{ label => 'critical-' . $self->{thlabel}, exit_litteral => 'critical' },
{ label => 'warning-'. $self->{thlabel}, exit_litteral => 'warning' },
{ label => 'unknown-'. $self->{thlabel}, exit_litteral => 'unknown' }
]
);
}
sub custom_status_output {
my ($self, %options) = @_;
return sprintf('status is %s', $self->{result_values}->{status});
}
sub custom_license_users_output {
my ($self, %options) = @_;
return sprintf(
'active users total: %s used: %s (%.2f%%) free: %s (%.2f%%)',
$self->{result_values}->{total},
$self->{result_values}->{used},
$self->{result_values}->{prct_used},
$self->{result_values}->{free},
$self->{result_values}->{prct_free}
);
}
sub custom_license_sessions_output {
my ($self, %options) = @_;
return sprintf(
'active sessions total: %s used: %s (%.2f%%) free: %s (%.2f%%)',
$self->{result_values}->{total},
$self->{result_values}->{used},
$self->{result_values}->{prct_used},
$self->{result_values}->{free},
$self->{result_values}->{prct_free}
);
}
sub custom_license_usim_output {
my ($self, %options) = @_;
return sprintf(
'provisioned usim total: %s used: %s (%.2f%%) free: %s (%.2f%%)',
$self->{result_values}->{total},
$self->{result_values}->{used},
$self->{result_values}->{prct_used},
$self->{result_values}->{free},
$self->{result_values}->{prct_free}
);
}
sub license_long_output {
my ($self, %options) = @_;
return 'checking license';
}
sub prefix_license_output {
my ($self, %options) = @_;
return 'license ';
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'license', type => 3, cb_long_output => 'license_long_output', indent_long_output => ' ',
group => [
{ name => 'expire', type => 0, display_short => 0, cb_prefix_output => 'prefix_license_output', skipped_code => { -10 => 1 } },
{ name => 'users', type => 0, display_short => 0, skipped_code => { -10 => 1 } },
{ name => 'sessions', type => 0, display_short => 0, skipped_code => { -10 => 1 } },
{ name => 'usim', type => 0, display_short => 0, skipped_code => { -10 => 1 } }
]
}
];
$self->{maps_counters}->{expire} = [
{
label => 'status',
type => 2,
critical_default => '%{status} =~ /expired|invalid/i',
set => {
key_values => [ { name => 'status' } ],
closure_custom_output => $self->can('custom_status_output'),
closure_custom_perfdata => sub { return 0; },
closure_custom_threshold_check => \&catalog_status_threshold_ng
}
},
{ label => 'expires', nlabel => 'license.expires', set => {
key_values => [ { name => 'expires_seconds' }, { name => 'expires_human' } ],
output_template => 'expires in %s',
output_use => 'expires_human',
closure_custom_perfdata => $self->can('custom_expires_perfdata'),
closure_custom_threshold_check => $self->can('custom_expires_threshold')
}
}
];
$self->{maps_counters}->{users} = [
{ label => 'license-users-usage', nlabel => 'license.users.active.usage.count', set => {
key_values => [ { name => 'used' }, { name => 'free' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_users_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-users-free', display_ok => 0, nlabel => 'license.users.active.free.count', set => {
key_values => [ { name => 'free' }, { name => 'used' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_users_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-users-usage-prct', display_ok => 0, nlabel => 'license.users.active.usage.percentage', set => {
key_values => [ { name => 'prct_used' }, { name => 'used' }, { name => 'free' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_users_output'),
perfdatas => [
{ template => '%.2f', min => 0, max => 100, unit => '%' }
]
}
}
];
$self->{maps_counters}->{sessions} = [
{ label => 'license-sessions-usage', nlabel => 'license.sessions.active.usage.count', set => {
key_values => [ { name => 'used' }, { name => 'free' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_sessions_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-sessions-free', display_ok => 0, nlabel => 'license.sessions.active.free.count', set => {
key_values => [ { name => 'free' }, { name => 'used' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_sessions_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-sessions-usage-prct', display_ok => 0, nlabel => 'license.sessions.active.usage.percentage', set => {
key_values => [ { name => 'prct_used' }, { name => 'used' }, { name => 'free' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_sessions_output'),
perfdatas => [
{ template => '%.2f', min => 0, max => 100, unit => '%' }
]
}
}
];
$self->{maps_counters}->{usim} = [
{ label => 'license-usim-usage', nlabel => 'license.usim.usage.count', set => {
key_values => [ { name => 'used' }, { name => 'free' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_usim_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-usim-free', display_ok => 0, nlabel => 'license.usim.free.count', set => {
key_values => [ { name => 'free' }, { name => 'used' }, { name => 'prct_used' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_usim_output'),
perfdatas => [
{ template => '%d', min => 0, max => 'total' }
]
}
},
{ label => 'license-usim-usage-prct', display_ok => 0, nlabel => 'license.usim.usage.percentage', set => {
key_values => [ { name => 'prct_used' }, { name => 'used' }, { name => 'free' }, { name => 'prct_free' }, { name => 'total' } ],
closure_custom_output => $self->can('custom_license_usim_output'),
perfdatas => [
{ template => '%.2f', min => 0, max => 100, unit => '%' }
]
}
}
];
}
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 => {
'unit:s' => { name => 'unit', default => 'd' }
});
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::check_options(%options);
if ($self->{option_results}->{unit} eq '' || !defined($unitdiv->{$self->{option_results}->{unit}})) {
$self->{option_results}->{unit} = 'd';
}
}
my $map_status = { 0 => 'ok', 1 => 'expired', 2 => 'invalid' };
my $mapping = {
users_connected => { oid => '.1.3.6.1.4.1.35805.10.2.99.1' }, # usersConnected
users_idle => { oid => '.1.3.6.1.4.1.35805.10.2.99.2' }, # usersIdle
active_connections => { oid => '.1.3.6.1.4.1.35805.10.2.99.4' }, # activeConnections
hss_provisioned_users => { oid => '.1.3.6.1.4.1.35805.10.2.99.7' }, # hssProvisionedUsers
max_active_users => { oid => '.1.3.6.1.4.1.35805.10.4.1' }, # maxActiveUsers
max_active_sessions => { oid => '.1.3.6.1.4.1.35805.10.4.2' }, # maxActiveSessions
expire_time => { oid => '.1.3.6.1.4.1.35805.10.4.4' }, # licenseExpireTime
max_provisioned_usim => { oid => '.1.3.6.1.4.1.35805.10.4.6' }, # maxProvisionedUSIM
status => { oid => '.1.3.6.1.4.1.35805.10.4.5', map => $map_status } # licenseStatus
};
sub manage_selection {
my ($self, %options) = @_;
my $snmp_result = $options{snmp}->get_leef(
oids => [ map($_->{oid} . '.0', values(%$mapping)) ],
nothing_quit => 1
);
my $result = $options{snmp}->map_instance(mapping => $mapping, results => $snmp_result, instance => 0);
$self->{output}->output_add(short_msg => 'License is ok');
$self->{license} = {
global => {
expire => { status => $result->{status} },
users => {},
sessions => {},
usim => {}
}
};
if (defined($result->{expire_time})) {
my @date = unpack('n C6 a C2', $result->{expire_time});
my $tz;
if (defined($date[7])) {
$tz = sprintf('%s%02d%02d', $date[7], $date[8], $date[9]);
}
my $dt = DateTime->new(
year => $date[0],
month => $date[1],
day => $date[2],
hour => $date[3],
minute => $date[4],
second => $date[5],
time_zone => $tz
);
$self->{license}->{global}->{expire}->{expires_seconds} = $dt->epoch() - time();
$self->{license}->{global}->{expire}->{expires_human} = centreon::plugins::misc::change_seconds(
value => $self->{license}->{global}->{expire}->{expires_seconds}
);
}
if ($result->{max_active_users} > 0) {
$self->{license}->{global}->{users}->{used} = $result->{users_connected} + $result->{users_idle};
$self->{license}->{global}->{users}->{total} = $result->{max_active_users};
$self->{license}->{global}->{users}->{free} = $result->{max_active_users} - $self->{license}->{global}->{users}->{used};
$self->{license}->{global}->{users}->{prct_used} = $self->{license}->{global}->{users}->{used} * 100 / $result->{max_active_users};
$self->{license}->{global}->{users}->{prct_free} = 100 - $self->{license}->{global}->{users}->{prct_used};
}
if ($result->{max_active_sessions} > 0) {
$self->{license}->{global}->{sessions}->{used} = $result->{active_connections};
$self->{license}->{global}->{sessions}->{total} = $result->{max_active_sessions};
$self->{license}->{global}->{sessions}->{free} = $result->{max_active_sessions} - $self->{license}->{global}->{sessions}->{used};
$self->{license}->{global}->{sessions}->{prct_used} = $self->{license}->{global}->{sessions}->{used} * 100 / $result->{max_active_sessions};
$self->{license}->{global}->{sessions}->{prct_free} = 100 - $self->{license}->{global}->{sessions}->{prct_used};
}
if ($result->{max_provisioned_usim} > 0) {
$self->{license}->{global}->{usim}->{used} = $result->{hss_provisioned_users};
$self->{license}->{global}->{usim}->{total} = $result->{max_provisioned_usim};
$self->{license}->{global}->{usim}->{free} = $result->{max_provisioned_usim} - $result->{hss_provisioned_users};
$self->{license}->{global}->{usim}->{prct_used} = $result->{hss_provisioned_users} * 100 / $result->{max_provisioned_usim};
$self->{license}->{global}->{usim}->{prct_free} = 100 - $self->{license}->{global}->{users}->{prct_used};
}
}
1;
__END__
=head1 MODE
Check license.
=over 8
=item B<--filter-counters>
Only display some counters (regexp can be used).
Example: --filter-counters='users'
=item B<--warning-status>
Set warning threshold for status.
Can use special variables like: %{status}
=item B<--critical-status>
Set critical threshold for status (Default: '%{status} =~ /expired|invalid/i').
Can use special variables like: %{status}
=item B<--unit>
Select the unit for expires threshold. May be 's' for seconds, 'm' for minutes,
'h' for hours, 'd' for days, 'w' for weeks. Default is days.
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'expires', 'license-users-usage', 'license-users-free', 'license-users-usage-prct',
'license-sessions-usage', 'license-sessions-free', 'license-sessions-usage-prct',
'license-usim-usage', 'license-usim-free', 'license-usim-usage-prct'.
=back
=cut