From 7afe16e41d1bfe2af2f460d2e008c25644ee7832 Mon Sep 17 00:00:00 2001 From: Mathieu Cinquin Date: Tue, 17 Feb 2015 15:30:39 +0100 Subject: [PATCH] add jenkins check - fix #6137 --- apps/jenkins/mode/jobstate.pm | 211 ++++++++++++++++++++++++++++++++++ apps/jenkins/plugin.pm | 66 +++++++++++ 2 files changed, 277 insertions(+) create mode 100644 apps/jenkins/mode/jobstate.pm create mode 100644 apps/jenkins/plugin.pm diff --git a/apps/jenkins/mode/jobstate.pm b/apps/jenkins/mode/jobstate.pm new file mode 100644 index 000000000..081a6371b --- /dev/null +++ b/apps/jenkins/mode/jobstate.pm @@ -0,0 +1,211 @@ +############################################################################### +# Copyright 2005-2015 CENTREON +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give CENTREON +# permission to link this program with independent modules to produce an timeelapsedutable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting timeelapsedutable under terms of CENTREON choice, provided that +# CENTREON also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Author : Mathieu Cinquin +# +#################################################################################### + +package apps::jenkins::mode::jobstate; + +use base qw(centreon::plugins::mode); + +use strict; +use warnings; +use centreon::plugins::httplib; +use centreon::plugins::statefile; + +use JSON; +use Data::Dumper; + +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 => + { + "hostname:s" => { name => 'hostname' }, + "port:s" => { name => 'port', default => '80'}, + "proto:s" => { name => 'proto', default => 'http' }, + "urlpath:s" => { name => 'url_path' }, + "jobname:s" => { name => 'jobname' }, + "credentials" => { name => 'credentials' }, + "username:s" => { name => 'username' }, + "password:s" => { name => 'password' }, + "warning:s" => { name => 'warning' }, + "critical:s" => { name => 'critical' }, + "checkstyle" => { name => 'checkstyle' }, + "timeout:s" => { name => 'timeout', default => '3' }, + }); + + 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}->{hostname})) { + $self->{output}->add_option_msg(short_msg => "Please set the hostname option"); + $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(); + } + if ((defined($self->{option_results}->{credentials})) && (!defined($self->{option_results}->{username}) || !defined($self->{option_results}->{password}))) { + $self->{output}->add_option_msg(short_msg => "You need to set --username= and --password= options when --credentials is used"); + $self->{output}->option_exit(); + } +} + +sub run { + my ($self, %options) = @_; + + + $self->{option_results}->{url_path} = $self->{option_results}->{url_path}."/job/".$self->{option_results}->{jobname}."/api/json"; + + my $jsoncontent = centreon::plugins::httplib::connect($self); + + 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<--username> + +Specify username for API authentification + +=item B<--password> + +Specify password for API authentification + +=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 + +=item B<--timeout> + +Threshold for HTTP timeout (Default: 3) + +=back + +=cut diff --git a/apps/jenkins/plugin.pm b/apps/jenkins/plugin.pm new file mode 100644 index 000000000..be520330c --- /dev/null +++ b/apps/jenkins/plugin.pm @@ -0,0 +1,66 @@ +################################################################################ +# Copyright 2005-2015 CENTREON +# Centreon is developped by : Julien Mathis and Romain Le Merlus under +# GPL Licence 2.0. +# +# This program is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free Software +# Foundation ; either version 2 of the License. +# +# This program is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. See the GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along with +# this program; if not, see . +# +# Linking this program statically or dynamically with other modules is making a +# combined work based on this program. Thus, the terms and conditions of the GNU +# General Public License cover the whole combination. +# +# As a special exception, the copyright holders of this program give CENTREON +# permission to link this program with independent modules to produce an executable, +# regardless of the license terms of these independent modules, and to copy and +# distribute the resulting executable under terms of CENTREON choice, provided that +# CENTREON also meet, for each linked independent module, the terms and conditions +# of the license of that module. An independent module is a module which is not +# derived from this program. If you modify this program, you may extend this +# exception to your version of the program, but you are not obliged to do so. If you +# do not wish to do so, delete this exception statement from your version. +# +# For more information : contact@centreon.com +# Authors : Mathieu Cinquin +# +#################################################################################### + +package apps::jenkins::plugin; + +use strict; +use warnings; +use base qw(centreon::plugins::script_simple); + +sub new { + my ($class, %options) = @_; + + my $self = $class->SUPER::new(package => __PACKAGE__, %options); + bless $self, $class; + # $options->{options} = options object + + $self->{version} = '0.1'; + %{$self->{modes}} = ( + 'job-state' => 'apps::jenkins::mode::jobstate', + ); + + return $self; +} + + +1; + +__END__ + +=head1 PLUGIN DESCRIPTION + +Check Jenkins through its JSON API + +=cut