#
# 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::tomcat::web::mode::connectors;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
use centreon::plugins::http;
use Digest::MD5 qw(md5_hex);
use XML::XPath;
use URI::Escape;
sub custom_traffic_output {
my ($self, %options) = @_;
my ($traffic_value, $traffic_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{traffic}, network => 1);
my ($total_value, $total_unit);
if (defined($self->{result_values}->{speed}) && $self->{result_values}->{speed} =~ /[0-9]/) {
($total_value, $total_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{speed}, network => 1);
}
my $msg = sprintf(
"Traffic %s : %s/s (%s on %s)",
ucfirst($self->{result_values}->{label}), $traffic_value . $traffic_unit,
defined($self->{result_values}->{traffic_prct}) ? sprintf("%.2f%%", $self->{result_values}->{traffic_prct}) : '-',
defined($total_value) ? $total_value . $total_unit : '-'
);
return $msg;
}
sub custom_traffic_calc {
my ($self, %options) = @_;
$self->{result_values}->{label} = $options{extra_options}->{label_ref};
$self->{result_values}->{display} = $options{new_datas}->{$self->{instance} . '_display'};
my $diff_traffic = $options{new_datas}->{$self->{instance} . '_' . $self->{result_values}->{label}} - $options{old_datas}->{$self->{instance} . '_' . $self->{result_values}->{label}};
$self->{result_values}->{traffic} = $diff_traffic / $options{delta_time};
if (defined($self->{instance_mode}->{option_results}->{'speed_' . $self->{result_values}->{label}}) && $self->{instance_mode}->{option_results}->{'speed_' . $self->{result_values}->{label}} =~ /[0-9]/) {
$self->{result_values}->{traffic_prct} = $self->{result_values}->{traffic} * 100 / ($self->{instance_mode}->{option_results}->{'speed_' . $self->{result_values}->{label}} * 1000 * 1000);
$self->{result_values}->{speed} = $self->{instance_mode}->{option_results}->{'speed_' . $self->{result_values}->{label}} * 1000 * 1000;
} elsif (defined($options{extra_options}->{type}) && $options{extra_options}->{type} eq 'prct') {
return -10;
}
return 0;
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'connector', type => 1, cb_prefix_output => 'prefix_connector_output', message_multiple => 'All connectors are ok', skipped_code => { -10 => 1 } },
];
$self->{maps_counters}->{connector} = [
{ label => 'threads-current', nlabel => 'connector.threads.current.count', set => {
key_values => [ { name => 'currentThreadCount' }, { name => 'maxThreads' }, { name => 'display' } ],
output_template => 'Threads Current : %s',
perfdatas => [
{ label => 'threads_current', template => '%.2f', min => 0, max => 'maxThreads',
label_extra_instance => 1 },
],
}
},
{ label => 'threads-busy', nlabel => 'connector.threads.busy.count', set => {
key_values => [ { name => 'currentThreadsBusy' }, { name => 'maxThreads' }, { name => 'display' } ],
output_template => 'Threads Busy : %s',
perfdatas => [
{ label => 'threads_busy', template => '%.2f', min => 0, max => 'maxThreads',
label_extra_instance => 1 },
],
}
},
{ label => 'traffic-in', nlabel => 'connector.traffic.in.bitspersecond', set => {
key_values => [ { name => 'in', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_traffic_calc'), closure_custom_calc_extra_options => { label_ref => 'in' },
closure_custom_output => $self->can('custom_traffic_output'),
threshold_use => 'traffic',
perfdatas => [
{ label => 'traffic_in', value => 'traffic', template => '%.2f', min => 0, max => 'speed',
unit => 'b/s', label_extra_instance => 1 },
],
}
},
{ label => 'traffic-in-prct', display_ok => 0, nlabel => 'connector.traffic.in.percent', set => {
key_values => [ { name => 'in', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_traffic_calc'), closure_custom_calc_extra_options => { label_ref => 'in', type => 'prct' },
output_template => 'Traffic In Used : %.2f %%',
output_use => 'traffic_prct', threshold_use => 'traffic_prct',
perfdatas => [
{ label => 'traffic_in_prct', value => 'traffic_prct', template => '%.2f', min => 0, max => 100,
unit => '%', label_extra_instance => 1 },
],
}
},
{ label => 'traffic-out', nlabel => 'connector.traffic.out.bitspersecond', set => {
key_values => [ { name => 'out', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_traffic_calc'), closure_custom_calc_extra_options => { label_ref => 'out' },
closure_custom_output => $self->can('custom_traffic_output'),
threshold_use => 'traffic',
perfdatas => [
{ label => 'traffic_out', value => 'traffic', template => '%.2f', min => 0, max => 'speed',
unit => 'b/s', label_extra_instance => 1 },
],
}
},
{ label => 'traffic-out-prct', display_ok => 0, nlabel => 'connector.traffic.out.percent', set => {
key_values => [ { name => 'out', diff => 1 }, { name => 'display' } ],
closure_custom_calc => $self->can('custom_traffic_calc'), closure_custom_calc_extra_options => { label_ref => 'out', type => 'prct' },
output_template => 'Traffic Out Used : %.2f %%',
output_use => 'traffic_prct', threshold_use => 'traffic_prct',
perfdatas => [
{ label => 'traffic_out_prct', value => 'traffic_prct', template => '%.2f', min => 0, max => 100,
unit => '%', label_extra_instance => 1 },
],
}
},
{ label => 'requests-processingtime-total', nlabel => 'connector.requests.processingtime.total.milliseconds', set => {
key_values => [ { name => 'requestInfo_processingTime', diff => 1 }, { name => 'display' } ],
output_template => 'Requests Total Processing Time : %s ms',
perfdatas => [
{ label => 'requests_processingtime_total', template => '%s', min => 0,
unit => 'ms', label_extra_instance => 1 },
],
}
},
{ label => 'requests-errors', nlabel => 'connector.requests.errors.count', set => {
key_values => [ { name => 'requestInfo_errorCount', diff => 1 }, { name => 'display' } ],
output_template => 'Requests Errors : %s',
perfdatas => [
{ label => 'requests_errors', template => '%s', min => 0,
label_extra_instance => 1 },
],
}
},
{ label => 'requests-total', nlabel => 'connector.requests.total.count', set => {
key_values => [ { name => 'requestInfo_requestCount', diff => 1 }, { name => 'display' } ],
output_template => 'Requests Total : %s',
perfdatas => [
{ label => 'requests_total', template => '%s', min => 0,
label_extra_instance => 1 },
],
}
},
];
}
sub prefix_connector_output {
my ($self, %options) = @_;
return "Connector '" . $options{instance_value}->{display} . "' ";
}
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options, statefile => 1);
bless $self, $class;
$options{options}->add_options(arguments => {
'hostname:s' => { name => 'hostname' },
'port:s' => { name => 'port', default => '8080' },
'proto:s' => { name => 'proto' },
'credentials' => { name => 'credentials' },
'basic' => { name => 'basic' },
'username:s' => { name => 'username' },
'password:s' => { name => 'password' },
'timeout:s' => { name => 'timeout' },
'urlpath:s' => { name => 'url_path', default => '/manager/status?XML=true' },
'filter-name:s' => { name => 'filter_name' },
'speed-in:s' => { name => 'speed_in' },
'speed-out:s' => { name => 'speed_out' },
});
$self->{http} = centreon::plugins::http->new(%options);
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::check_options(%options);
$self->{hostname} = $self->{option_results}->{hostname};
if (!defined($self->{hostname})) {
$self->{hostname} = 'me';
}
$self->{http}->set_options(%{$self->{option_results}});
}
my %xpath_to_check = (
requestInfo_maxTime => '/status/connector/requestInfo/@maxTime',
requestInfo_processingTime => '/status/connector/requestInfo/@processingTime',
requestInfo_requestCount => '/status/connector/requestInfo/@requestCount',
requestInfo_errorCount => '/status/connector/requestInfo/@errorCount',
maxThreads => '/status/connector/threadInfo/@maxThreads',
currentThreadCount => '/status/connector/threadInfo/@currentThreadCount',
currentThreadsBusy => '/status/connector/threadInfo/@currentThreadsBusy',
in => '/status/connector/requestInfo/@bytesReceived',
out => '/status/connector/requestInfo/@bytesSent',
);
sub manage_selection {
my ($self, %options) = @_;
#EXAMPLE 1:
#
#
#
#
#
#
#
#
#
#
#
#
#
#EXAMPLE 2:
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
my $webcontent = $self->{http}->request();
#GET XML DATA
my $xpath = XML::XPath->new(xml => $webcontent);
my %xpath_check_results;
$self->{connector} = {};
foreach my $label (keys %xpath_to_check) {
my $singlepath = $xpath_to_check{$label};
my $nodeset = $xpath->find($singlepath);
foreach my $node ($nodeset->get_nodelist()) {
my $connector_name = $node->getParentNode()->getParentNode()->getAttribute("name");
$connector_name =~ s/^["'\s]+//;
$connector_name =~ s/["'\s]+$//;
$connector_name = uri_unescape($connector_name);
if (defined($self->{option_results}->{filter_name}) && $self->{option_results}->{filter_name} ne '' &&
$connector_name !~ /$self->{option_results}->{filter_name}/) {
$self->{output}->output_add(long_msg => "skipping '" . $connector_name . "': no matching filter.", debug => 1);
next;
}
$self->{connector}->{$connector_name} = { display => $connector_name } if (!defined($self->{connector}->{$connector_name}));
my $value = $node->string_value();
if ($value =~ /^"?([0-9.]+)"?$/) {
$self->{connector}->{$connector_name}->{$label} = $1;
if ($label =~ /^in|out/) {
$self->{connector}->{$connector_name}->{$label} *= 8;
}
}
}
}
if (scalar(keys %{$self->{connector}}) <= 0) {
$self->{output}->add_option_msg(short_msg => "No information found.");
$self->{output}->option_exit();
}
$self->{cache_name} = "tomcat_web_" . $self->{mode} . '_' . $self->{option_results}->{hostname} . '_' . $self->{http}->get_port() . '_' .
(defined($self->{option_results}->{filter_counters}) ? md5_hex($self->{option_results}->{filter_counters}) : md5_hex('all')) . '_' .
(defined($self->{option_results}->{filter_name}) ? md5_hex($self->{option_results}->{filter_name}) : md5_hex('all'));
}
1;
__END__
=head1 MODE
Check Tomcat Application Servers Connectors
=over 8
=item B<--hostname>
IP Address or FQDN of the Tomcat Application Server
=item B<--port>
Port used by Tomcat
=item B<--proto>
Protocol used http or https
=item B<--credentials>
Specify this option if you access server-status page 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 server-status page over basic authentication and don't want a '401 UNAUTHORIZED' error to be logged on your webserver.
Specify this option if you access server-status page over hidden basic authentication or you'll get a '404 NOT FOUND' error.
(Use with --credentials)
=item B<--timeout>
Threshold for HTTP timeout
=item B<--urlpath>
Path to the Tomcat Manager XML (Default: '/manager/status?XML=true')
=item B<--filter-name>
Filter by connector name (can be a regexp).
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'traffic-in' (b), 'traffic-in-prct' (%),
'traffic-out' (b), 'traffic-out-prct' (%),
'threads-current', 'threads-busy', 'requests-processingtime-total' (ms),
'requests-errors', 'requests-total'.
=item B<--speed-in>
Set interface speed for incoming traffic (in Mb).
=item B<--speed-out>
Set interface speed for outgoing traffic (in Mb).
=back
=cut