sensu-plugins-jenkins 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0835b69c82a04c134a91160cd8752da9f1231e7f65f170bc50373b96529f2c48
-  data.tar.gz: 94842b12df98c6db6c57897de68669b35b98512caa44900133bb75694919d8cd
+  metadata.gz: 75c39b7e5b5565b722528e10fb11058718cc4a3269c6ed5681addfb89407b9cb
+  data.tar.gz: b3d3ca9c8db98a107638ece7e80ac90619cca58dfe892a403f5c672aa83f4f7e
 SHA512:
-  metadata.gz: 8dd866668e513e35777ea75e37fb37e437431f4699e6ad4685b0dce8e486191c8c33ae2c9519705e5a05ecd33fe4b8aaeaea175922df9909ef3297bb2bb9d621
-  data.tar.gz: 7e72e30f86c9317a19895fdd4131c61388da4d1054d19a2f5c104eae3ac659fd0ee65c4cf24f6ca00ee569ebf0708cd67be6bdd14fa819b841a16c8faf87c1f9
+  metadata.gz: b78f035d9c4665fd24d04396f4747648de3391ff65311e61c85260a798f538676975f51eac261fe0e85c5a2b58f547695355d7c4602efddf0bf80848ab69e7eb
+  data.tar.gz: 0372069eeb99cdc1d30098c4b6d0be30880acd803fa75fd1e008d912e12fe152904793e9b8bdf9b168395a11d3240454440ef878ee7df662556cb8a04fa1c62d

data/CHANGELOG.md

@@ -6,6 +6,11 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [1.7.0] - 2018-05-14
+### Added
+- check-jenkins-build-time.rb: add `--check-build-duration` mode to check duration (@CoRfr)
+- check-jenkins.rb: add `--timeout` option to specify timeout instead of the hardcoded 5s (@CoRfr)
+
 ## [1.6.2] - 2018-03-01
 ### Fixed
 - check-jenkins-health.rb: fixed bug introduced by #25 (@majormoses)
@@ -95,7 +100,8 @@ Which is based on [Keep A Changelog](http://keepachangelog.com/)
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.6.2...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.7.0...HEAD
+[1.7.0]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.6.2...1.7.0
 [1.6.2]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.6.1...1.6.2
 [1.6.1]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.6.0...1.6.1
 [1.6.0]: https://github.com/sensu-plugins/sensu-plugins-jenkins/compare/1.5.0...1.6.0

data/bin/check-jenkins-build-time.rb

@@ -4,7 +4,9 @@
 #
 # DESCRIPTION:
 #   Alert if the last successful build timestamp of a jenkins job is older than
-#   a specified time duration OR not within a specific daily time window.
+#   a specified time duration
+#   OR not within a specific daily time window
+#   OR if the total build duration exceeds a specified duration.
 #
 # OUTPUT:
 #   plain text
@@ -19,6 +21,8 @@
 #   where TIME_EXPRESSION is either a relative time duration from now (30m, 1h) or
 #   a daily time window (1am-2am, 1:01am-2:01am), without spaces.
 #
+#   --check-build-duration to check the last build duration for a job.
+#
 # DEPENDENCIES:
 #   gem: sensu-plugin
 #   jenkins_api_client
@@ -50,6 +54,11 @@ class JenkinsBuildTime < Sensu::Plugin::Check::CLI
          long: '--jobs JOB_NAME=TIME_EXPRESSION,[JOB_NAME=TIME_EXPRESSION]',
          required: true
 
+  option :check_build_duration,
+         description: 'Mode to check the build duration instead of the last occurence of a build',
+         short: '-d',
+         long: '--[no-]check-build-duration'
+
   option :username,
          description: 'Username for Jenkins instance',
          short: '-U USERNAME',
@@ -68,24 +77,32 @@ class JenkinsBuildTime < Sensu::Plugin::Check::CLI
     critical_jobs = []
 
     jobs = parse_jobs_param
+    check_build_duration = config[:check_build_duration] || false
 
     jobs.each do |job_name, time_expression|
       begin
-        last_build_time = build_time(job_name, last_successful_build_number(job_name))
+        build_number = last_successful_build_number(job_name)
+        last_build_time = build_time(job_name, build_number)
+        last_build_duration = build_duration(job_name, build_number)
       rescue
         critical "Error looking up Jenkins job: #{job_name}"
       end
 
-      if time_expression_is_window?(time_expression)
+      if check_build_duration
+        unless time_within_allowed_build_duration?(last_build_duration,
+                                                   parse_duration_seconds(time_expression))
+          critical_jobs << critical_message_build_duration(job_name, last_build_time, last_build_duration, time_expression)
+        end
+      elsif time_expression_is_window?(time_expression)
         unless time_within_window?(last_build_time,
                                    parse_window_start(time_expression),
                                    parse_window_end(time_expression))
-          critical_jobs << critical_message(job_name, last_build_time, time_expression)
+          critical_jobs << critical_message(job_name, last_build_time, last_build_duration, time_expression)
         end
       else
         unless time_within_allowed_duration?(last_build_time,
                                              parse_duration_seconds(time_expression))
-          critical_jobs << critical_message(job_name, last_build_time, time_expression)
+          critical_jobs << critical_message(job_name, last_build_time, last_build_duration, time_expression)
         end
       end
     end
@@ -104,9 +121,21 @@ class JenkinsBuildTime < Sensu::Plugin::Check::CLI
     jenkins.job.list_details(job_name)['lastSuccessfulBuild']['number']
   end
 
+  def build_details(job_name, build_number)
+    # Cache the results
+    @build_details ||= {}
+    @build_details[job_name] ||= {}
+    @build_details[job_name][build_number] ||= jenkins.job.get_build_details(job_name, build_number)
+  end
+
   def build_time(job_name, build_number)
     # Jenkins expresses timestamps in epoch millis
-    Time.at(jenkins.job.get_build_details(job_name, build_number)['timestamp'] / 1000)
+    Time.at(build_details(job_name, build_number)['timestamp'] / 1000)
+  end
+
+  def build_duration(job_name, build_number)
+    # Jenkins expresses timestamps in epoch millis, convert it to seconds
+    build_details(job_name, build_number)['duration'] / 1000
   end
 
   def time_expression_is_window?(time_expression)
@@ -148,8 +177,16 @@ class JenkinsBuildTime < Sensu::Plugin::Check::CLI
     time > (@now - duration_seconds)
   end
 
-  def critical_message(job_name, last_build_time, time_expression)
-    "#{job_name}: last built at #{last_build_time}, not within allowed time: #{time_expression}"
+  def time_within_allowed_build_duration?(build_duration_seconds, duration_seconds)
+    build_duration_seconds <= duration_seconds
+  end
+
+  def critical_message_build_duration(job_name, last_build_time, duration_seconds, time_expression)
+    "#{job_name}: last built at #{last_build_time} (#{ChronicDuration.output(duration_seconds)}) exceeded max duration (#{time_expression})"
+  end
+
+  def critical_message(job_name, last_build_time, duration_seconds, time_expression)
+    "#{job_name}: last built at #{last_build_time} (#{ChronicDuration.output(duration_seconds)}), not within allowed time: #{time_expression}"
   end
 
   def parse_jobs_param

data/bin/check-jenkins.rb

@@ -65,16 +65,23 @@ class JenkinsMetricsPingPongChecker < Sensu::Plugin::Check::CLI
          description: 'Perform "insecure" SSL connections and transfers.',
          default: false
 
+  option :timeout,
+         short: '-t SECONDS',
+         long: '--timeout SECONDS',
+         description: 'Timeout for REST request',
+         proc: proc(&:to_i),
+         default: 5
+
   def run
     https ||= config[:https] ? 'https' : 'http'
     testurl = "#{https}://#{config[:server]}:#{config[:port]}#{config[:uri]}"
 
     r = if config[:https] && config[:insecure]
-          RestClient::Resource.new(testurl, timeout: 5, verify_ssl: false).get
+          RestClient::Resource.new(testurl, timeout: config[:timeout], verify_ssl: false).get
         elsif config[:https]
-          RestClient::Resource.new(testurl, timeout: 5, verify_ssl: true).get
+          RestClient::Resource.new(testurl, timeout: config[:timeout], verify_ssl: true).get
         else
-          RestClient::Resource.new(testurl, timeout: 5).get
+          RestClient::Resource.new(testurl, timeout: config[:timeout]).get
         end
 
     if r.code == 200 && r.body.include?('pong')

data/lib/sensu-plugins-jenkins/version.rb

@@ -1,8 +1,8 @@
 module SensuPluginsJenkins
   module Version
     MAJOR = 1
-    MINOR = 6
-    PATCH = 2
+    MINOR = 7
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-jenkins
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin