(plugin) apps::jenkins - break mode jobs (#4215)

This commit is contained in:
qgarnier 2023-02-13 12:17:11 +00:00 committed by GitHub
parent 0fc95ebd4b
commit 132c0f2719
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 464 additions and 210 deletions

View File

@ -1,5 +1,3 @@
{
"dependencies": [
"libjson-perl"
]
"dependencies": []
}

View File

@ -3,7 +3,7 @@
"pkg_summary": "Centreon Plugin",
"plugin_name": "centreon_jenkins.pl",
"files": [
"centreon/plugins/script_simple.pm",
"centreon/plugins/script_custom.pm",
"apps/jenkins/"
]
}

View File

@ -1,5 +1,3 @@
{
"dependencies": [
"perl(JSON)"
]
"dependencies": []
}

View File

@ -0,0 +1,204 @@
#
# Copyright 2023 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::jenkins::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 => {
'username:s' => { name => 'username' },
'password:s' => { name => 'password' },
'hostname:s' => { name => 'hostname' },
'port:s' => { name => 'port' },
'proto:s' => { name => 'proto' },
'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, default_backend => 'curl');
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} : '';
$self->{port} = (defined($self->{option_results}->{port})) ? $self->{option_results}->{port} : 443;
$self->{proto} = (defined($self->{option_results}->{proto})) ? $self->{option_results}->{proto} : 'https';
$self->{timeout} = (defined($self->{option_results}->{timeout})) ? $self->{option_results}->{timeout} : 10;
$self->{username} = (defined($self->{option_results}->{username})) ? $self->{option_results}->{username} : '';
$self->{password} = (defined($self->{option_results}->{password})) ? $self->{option_results}->{password} : '';
$self->{unknown_http_status} = (defined($self->{option_results}->{unknown_http_status})) ? $self->{option_results}->{unknown_http_status} : '%{http_code} < 200 or %{http_code} >= 300';
$self->{warning_http_status} = (defined($self->{option_results}->{warning_http_status})) ? $self->{option_results}->{warning_http_status} : '';
$self->{critical_http_status} = (defined($self->{option_results}->{critical_http_status})) ? $self->{option_results}->{critical_http_status} : '';
if ($self->{hostname} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --hostname option.");
$self->{output}->option_exit();
}
if ($self->{username} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --username option.");
$self->{output}->option_exit();
}
if ($self->{password} eq '') {
$self->{output}->add_option_msg(short_msg => "Need to specify --password option.");
$self->{output}->option_exit();
}
return 0;
}
sub build_options_for_httplib {
my ($self, %options) = @_;
$self->{option_results}->{hostname} = $self->{hostname};
$self->{option_results}->{timeout} = $self->{timeout};
$self->{option_results}->{port} = $self->{port};
$self->{option_results}->{proto} = $self->{proto};
$self->{option_results}->{timeout} = $self->{timeout};
$self->{option_results}->{credentials} = 1;
$self->{option_results}->{basic} = 1;
$self->{option_results}->{username} = $self->{username};
$self->{option_results}->{password} = $self->{password};
}
sub settings {
my ($self, %options) = @_;
return if (defined($self->{settings_done}));
$self->build_options_for_httplib();
$self->{http}->add_header(key => 'Accept', value => 'application/json');
$self->{http}->add_header(key => 'Content-Type', value => 'application/json');
$self->{http}->set_options(%{$self->{option_results}});
$self->{settings_done} = 1;
}
sub get_hostname {
my ($self, %options) = @_;
return $self->{hostname};
}
sub request_api {
my ($self, %options) = @_;
$self->settings();
my ($content) = $self->{http}->request(
url_path => $options{endpoint},
get_param => $options{get_param},
unknown_status => $self->{unknown_http_status},
warning_status => $self->{warning_http_status},
critical_status => $self->{critical_http_status}
);
if (!defined($content) || $content eq '') {
$self->{output}->add_option_msg(short_msg => "API returns empty content [code: '" . $self->{http}->get_code() . "'] [message: '" . $self->{http}->get_message() . "']");
$self->{output}->option_exit();
}
my $decoded;
eval {
$decoded = JSON::XS->new->utf8->decode($content);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => "Cannot decode response (add --debug option to display returned content)");
$self->{output}->option_exit();
}
return $decoded;
}
1;
__END__
=head1 NAME
Jenkins Rest API
=head1 REST API OPTIONS
Jenkins Rest API
=over 8
=item B<--hostname>
Hostname.
=item B<--port>
Port used (Default: 443)
=item B<--proto>
Specify https if needed (Default: 'https')
=item B<--username>
API username.
=item B<--password>
API password.
=item B<--timeout>
Set timeout in seconds (Default: 10).
=back
=head1 DESCRIPTION
B<custom>.
=cut

View File

@ -0,0 +1,134 @@
#
# Copyright 2023 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::jenkins::mode::jobs;
use base qw(centreon::plugins::templates::counter);
use strict;
use warnings;
sub prefix_job_output {
my ($self, %options) = @_;
return "Job '" . $options{instance} . "' ";
}
sub set_counters {
my ($self, %options) = @_;
$self->{maps_counters_type} = [
{ name => 'jobs', type => 1, cb_prefix_output => 'prefix_job_output', message_multiple => 'All jobs are ok' }
];
$self->{maps_counters}->{jobs} = [
{ label => 'score', nlabel => 'job.score.percentage', set => {
key_values => [ { name => 'score' } ],
output_template => 'score: %.2f %%',
perfdatas => [
{ template => '%.2f', min => 0, max => 100, unit => '%', label_extra_instance => 1 }
]
}
},
{ label => 'violations', nlabel => 'job.violations.count', set => {
key_values => [ { name => 'violations' } ],
output_template => 'violations: %s',
perfdatas => [
{ template => '%s', 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-job-name:s' => { name => 'filter_job_name' }
});
return $self;
}
sub manage_selection {
my ($self, %options) = @_;
my $jobs = $options{custom}->request_api(
endpoint => '/api/json',
get_param => [
'tree=jobs[name,buildable,healthReport[description,score],jobs[name,buildable,healthReport[description,score]]]'
]
);
$self->{jobs} = {};
foreach my $job (@{$jobs->{jobs}}) {
my $name = $job->{name};
next if (defined($self->{option_results}->{filter_job_name}) && $self->{option_results}->{filter_job_name} ne '' &&
$name !~ /$self->{option_results}->{filter_job_name}/);
if (defined($job->{healthReport}->[0]->{score})) {
$self->{jobs}->{$name} = { score => $job->{healthReport}->[0]->{score}, violations => 0 };
if ($job->{healthReport}->[0]->{description} =~ /^.+?([0-9]+)/ ) {
$self->{jobs}->{$name}->{violations} = $1;
}
}
next if (!defined($job->{jobs}));
foreach my $subjob (@{$job->{jobs}}) {
my $subname = $name . '/' . $subjob->{name};
next if (defined($self->{option_results}->{filter_job_name}) && $self->{option_results}->{filter_job_name} ne '' &&
$subname !~ /$self->{option_results}->{filter_job_name}/);
if (defined($subjob->{healthReport}->[0]->{score})) {
$self->{jobs}->{$subname} = { score => $subjob->{healthReport}->[0]->{score}, violations => 0 };
if ($subjob->{healthReport}->[0]->{description} =~ /^.+?([0-9]+)/ ) {
$self->{jobs}->{$subname}->{violations} = $1;
}
}
}
}
}
1;
__END__
=head1 MODE
Check jobs.
=over 8
=item B<--filter-job-name>
Filter jobs by name (can be a regexp).
=item B<--warning-*> B<--critical-*>
Thresholds.
Can be: 'score', 'violations'.
=back
=cut

View File

@ -1,197 +0,0 @@
#
# Copyright 2023 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::jenkins::mode::jobstate;
use base qw(centreon::plugins::mode);
use strict;
use warnings;
use centreon::plugins::http;
use centreon::plugins::statefile;
use JSON;
sub new {
my ($class, %options) = @_;
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
bless $self, $class;
$options{options}->add_options(arguments => {
"hostname:s" => { name => 'hostname' },
"port:s" => { name => 'port' },
"proto:s" => { name => 'proto' },
"urlpath:s" => { name => 'url_path' },
"timeout:s" => { name => 'timeout' },
"credentials" => { name => 'credentials' },
"basic" => { name => 'basic' },
"username:s" => { name => 'username' },
"password:s" => { name => 'password' },
"jobname:s" => { name => 'jobname' },
"warning:s" => { name => 'warning' },
"critical:s" => { name => 'critical' },
"checkstyle" => { name => 'checkstyle' },
});
$self->{http} = centreon::plugins::http->new(%options);
return $self;
}
sub check_options {
my ($self, %options) = @_;
$self->SUPER::init(%options);
if (($self->{perfdata}->threshold_validate(label => 'warning', value => $self->{option_results}->{warning})) == 0) {
$self->{output}->add_option_msg(short_msg => "Wrong warning threshold '" . $self->{option_results}->{warning} . "'.");
$self->{output}->option_exit();
}
if (($self->{perfdata}->threshold_validate(label => 'critical', value => $self->{option_results}->{critical})) == 0) {
$self->{output}->add_option_msg(short_msg => "Wrong critical threshold '" . $self->{option_results}->{critical} . "'.");
$self->{output}->option_exit();
}
if (!defined($self->{option_results}->{jobname})) {
$self->{output}->add_option_msg(short_msg => "Please set the jobname option");
$self->{output}->option_exit();
}
$self->{option_results}->{url_path} = $self->{option_results}->{url_path} . "/job/" . $self->{option_results}->{jobname} . "/api/json";
$self->{http}->set_options(%{$self->{option_results}});
}
sub run {
my ($self, %options) = @_;
my $jsoncontent = $self->{http}->request();
my $json = JSON->new;
my $webcontent;
eval {
$webcontent = $json->decode($jsoncontent);
};
if ($@) {
$self->{output}->add_option_msg(short_msg => "Cannot decode json response");
$self->{output}->option_exit();
}
my $description_tendency = $webcontent->{healthReport}->[0]->{description};
my $score_tendency = $webcontent->{healthReport}->[0]->{score};
my ($description_violations, $number_violations);
my $exit1 = $self->{perfdata}->threshold_check(value => $score_tendency, threshold => [ { label => 'critical', 'exit_litteral' => 'critical' }, { label => 'warning', exit_litteral => 'warning' } ]);
$self->{output}->output_add(severity => $exit1,
short_msg => sprintf("%s", $description_tendency));
$self->{output}->perfdata_add(label => 'score_tendency',
value => sprintf("%d", $score_tendency),
warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning'),
critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical'),
min => 0,
);
if (defined($self->{option_results}->{checkstyle})) {
if (defined($webcontent->{healthReport}->[1]->{description})) {
my $description_violations;
my $number_violations;
$description_violations = $webcontent->{healthReport}->[1]->{description};
if ( $description_violations =~ /^.+?([0-9]+)$/ ) {
$number_violations = $1;
}
$self->{output}->add_option_msg(short_msg => sprintf("%s", $description_violations));
$self->{output}->perfdata_add(label => 'number_violations',
value => sprintf("%d", $number_violations),
min => 0,
);
}
}
$self->{output}->display();
$self->{output}->exit();
}
1;
__END__
=head1 MODE
Check Jenkins specific job tendency (score) and checkstyle violation
=over 8
=item B<--hostname>
IP Addr/FQDN of the Jenkins host
=item B<--port>
Port used by Jenkins API
=item B<--proto>
Specify https if needed (Default: 'http')
=item B<--urlpath>
Set path to get Jenkins information
=item B<--credentials>
Required to use username/password authentication method
=item B<--basic>
Specify this option if you access API over basic authentication and don't want a '401 UNAUTHORIZED' error to be logged on your webserver.
Specify this option if you access API over hidden basic authentication or you'll get a '404 NOT FOUND' error.
(Use with --credentials)
=item B<--username>
Specify username for API authentification
=item B<--password>
Specify password for API authentification
=item B<--timeout>
Threshold for HTTP timeout (Default: 5)
=item B<--warning>
Warning Threshold for tendency score
=item B<--critical>
Critical Threshold for tendency score
=item B<--checkstyle>
Add checkstyle's violation output and perfdata
=back
=cut

View File

@ -0,0 +1,116 @@
#
# Copyright 2023 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::jenkins::mode::listjobs;
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) = @_;
my $jobs = $options{custom}->request_api(
endpoint => '/api/json',
get_param => [
'tree=jobs[name,buildable,jobs[name,buildable]]'
]
);
my $results = [];
foreach my $job (@{$jobs->{jobs}}) {
push @$results, { name => $job->{name} };
foreach my $subjob (@{$job->{jobs}}) {
push @$results, { name => $job->{name} . '/' . $subjob->{name} };
}
}
return $results;
}
sub run {
my ($self, %options) = @_;
my $jobs = $self->manage_selection(%options);
foreach (@$jobs) {
$self->{output}->output_add(
long_msg => sprintf(
'[name: %s]',
$_->{name}
)
);
}
$self->{output}->output_add(
severity => 'OK',
short_msg => 'List jobs:'
);
$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 $jobs = $self->manage_selection(%options);
foreach (@$jobs) {
$self->{output}->add_disco_entry(
%$_
);
}
}
1;
__END__
=head1 MODE
List jobs.
=over 8
=back
=cut

View File

@ -22,18 +22,19 @@ package apps::jenkins::plugin;
use strict;
use warnings;
use base qw(centreon::plugins::script_simple);
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}} = (
'job-state' => 'apps::jenkins::mode::jobstate',
);
$self->{modes} = {
'jobs' => 'apps::jenkins::mode::jobs',
'list-jobs' => 'apps::jenkins::mode::listjobs'
};
$self->{custom_modes}->{api} = 'apps::jenkins::custom::api';
return $self;
}