sensu-plugins-network-checks 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4fe3ce670028be6e730e1dc630814320751dc37f3a463afe18c6dfe44c98bfc
-  data.tar.gz: 71e2789dd43b014154cc55e3e39dec64e1d4b90f208823fd2607fd6af41ff35b
+  metadata.gz: 6b9838fcbdec2087aba8d8fb8de4b7dc319d7e529cda950b9143ed6e3410f770
+  data.tar.gz: dfee7221ae2a11f4525b9c4afa97da7b375b9a031a19bdf9514b924867844d13
 SHA512:
-  metadata.gz: ccb6b577dd63fb7ed02813bf5059612ec5a7605eab3ec8a0e8a6e5fd640214e177a86a9910585d9045f7d423294f6fe4dd25e0e656192726405cc0c6d6e2e3c0
-  data.tar.gz: d7436091135499b7561d3f71ce03f4de8078a320ccd062d86be0f37e76368ec9ae82d64528ea5d7bf62346cf3ea877849c1deceda06edc4a9b592ed920d60dee
+  metadata.gz: 629163838de440d93eb3b21dab0976fdbeae3d6aac460b32f7d9a1157f45049595703d5b4462b4232e10ed50facaed260a73597af3eb3950952b8325ab46068f
+  data.tar.gz: e769e77553edd10d09bd1ff8c56db4c43fb2a6451ebc9614cb5e2c71c0ed53d4f1233701fe5993ff9a7b6e5104015df89b64cb835138b032cb33f9a0b866f411

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed  [here](https://github.com/sensu-plugin
 
 ## [Unreleased]
 
+## [2.3.0] - 2018-02-09
+### Changed
+- check-whois-domain-expiration.rb, check-whois-domain-expiration-multi.rb and check-jsonwhois-domain-expiration.rb: better resilience against errors, better reporting of erroneous responses (@DrMurx)
+
 ## [2.2.0] - 2018-02-02
 ### Added
 - check-ports.rb: support for multiple hosts (@DDSloan96)
@@ -194,7 +198,8 @@ This CHANGELOG follows the format listed  [here](https://github.com/sensu-plugin
 
 * initial release, same as community repo
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.3.0...HEAD
+[2.3.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.2.0...2.3.0
 [2.2.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.1.1...2.2.0
 [2.1.1]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.1.0...2.1.1
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-network-checks/compare/2.0.1...2.1.0

data/bin/check-jsonwhois-domain-expiration.rb

@@ -61,6 +61,21 @@ class JSONWhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
          default: 7,
          description: 'Critical if a domain expires in fewer than DAYS days'
 
+  option :'ignore-errors',
+         short: '-i',
+         long: '--ignore-errors',
+         boolean: true,
+         default: false,
+         description: 'Ignore connection or parsing errors'
+
+  option :'report-errors',
+         short: '-r LEVEL',
+         long: '--report-errors LEVEL',
+         proc: proc(&:to_sym),
+         in: %i(unknown warning critical),
+         default: :unknown,
+         description: 'Level for reporting connection or parsing errors'
+
   option :help,
          short: '-h',
          long: '--help',
@@ -77,19 +92,26 @@ class JSONWhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
     domains = config[:domain].split(',')
     warning_days = config[:warning].to_i
     critical_days = config[:critical].to_i
-    results = {}
-    results['critical'] = {}
-    results['warning'] = {}
-    results['ok'] = {}
+    results = {
+      critical: {},
+      warning: {},
+      ok: {},
+      unknown: {}
+    }
 
     domains.each do |domain|
-      domain_result = (get_domain_expiration(domain) - DateTime.now).to_i
-      if domain_result <= critical_days
-        results['critical'][domain] = domain_result
-      elsif domain_result <= warning_days
-        results['warning'][domain] = domain_result
-      else
-        results['ok'] = domain_result
+      begin
+        expires_on = get_domain_expiration(domain)
+        domain_result = (expires_on - DateTime.now).to_i
+        if domain_result <= critical_days
+          results[:critical][domain] = domain_result
+        elsif domain_result <= warning_days
+          results[:warning][domain] = domain_result
+        else
+          results[:ok][domain] = domain_result
+        end
+      rescue
+        results[:unknown][domain] = 'Connection or parsing error' unless config[:'ignore-errors']
       end
     end
     results
@@ -109,15 +131,23 @@ class JSONWhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
       http.request(req)
     end
 
-    DateTime.parse(JSON.parse(res.body)['expires_on'])
+    json = JSON.parse(res.body)
+    DateTime.parse(json['expires_on'])
   end
 
   def run
-    status = expiration_results
-    if !status['critical'].empty?
-      critical status['critical'].map { |u, v| "#{u} days left:#{v}" }.join(',')
-    elsif !status['warning'].empty?
-      warning status['warning'].map { |u, v| "#{u} days left:#{v}" }.join(',')
+    results = expiration_results
+
+    warn_results = results[:critical].merge(results[:warning]).map { |u, v| "#{u} (#{v} days left)" }
+    unknown_results = results[:unknown].map { |u, v| "#{u} (#{v})" }
+    message warn_results.concat(unknown_results).join(', ')
+
+    if !results[:critical].empty? || (!results[:unknown].empty? && config[:'report-errors'] == :critical)
+      critical
+    elsif !results[:warning].empty? || (!results[:unknown].empty? && config[:'report-errors'] == :warning)
+      warning
+    elsif !results[:unknown].empty?
+      unknown
     else
       ok 'No domains expire in the near term'
     end

data/bin/check-whois-domain-expiration-multi.rb

@@ -55,6 +55,21 @@ class WhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
          default: 7,
          description: 'Critical if fewer than DAYS away'
 
+  option :'ignore-errors',
+         short: '-i',
+         long: '--ignore-errors',
+         boolean: true,
+         default: false,
+         description: 'Ignore connection or parsing errors'
+
+  option :'report-errors',
+         short: '-r LEVEL',
+         long: '--report-errors LEVEL',
+         proc: proc(&:to_sym),
+         in: %i(unknown warning critical),
+         default: :unknown,
+         description: 'Level for reporting connection or parsing errors'
+
   option :timeout,
          short: '-t SECONDS',
          long: '--timeout SECONDS',
@@ -77,44 +92,60 @@ class WhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
     domains = config[:domain].split(',')
     warning_days = config[:warning].to_i
     critical_days = config[:critical].to_i
-    results = {}
-    results['critical'] = {}
-    results['warning'] = {}
-    results['ok'] = {}
     max_retries = 4
 
+    results = {
+      critical: {},
+      warning: {},
+      ok: {},
+      unknown: {}
+    }
+    whois = Whois::Client.new(timeout: config[:timeout])
+
     domains.each do |domain|
-      whois = Whois::Client.new(timeout: config[:timeout])
       begin
         tries ||= 0
         whois_result = whois.lookup(domain).parser
       rescue Timeout::Error, Errno::ECONNRESET, Whois::ConnectionError
         tries += 1
-        tries < max_retries ? retry : next
+        if tries < max_retries
+          retry
+        else
+          results[:unknown][domain] = 'Connection error' unless config[:'ignore-errors']
+          next
+        end
       end
 
-      if whois_result.expires_on.nil?
-        results['critical'][domain] = domain_result
-      else
-        domain_result = (DateTime.parse(whois_result.expires_on.to_s) - DateTime.now).to_i
+      begin
+        expires_on = DateTime.parse(whois_result.expires_on.to_s)
+        domain_result = (expires_on - DateTime.now).to_i
         if domain_result <= critical_days
-          results['critical'][domain] = domain_result
+          results[:critical][domain] = domain_result
         elsif domain_result <= warning_days
-          results['warning'][domain] = domain_result
+          results[:warning][domain] = domain_result
         else
-          results['ok'] = domain_result
+          results[:ok][domain] = domain_result
         end
+      rescue
+        results[:unknown][domain] = 'Parsing error' unless config[:'ignore-errors']
       end
     end
     results
   end
 
   def run
-    status = expiration_results
-    if !status['critical'].empty?
-      critical status['critical'].map { |u, v| "#{u} days left:#{v}" }.join(',')
-    elsif !status['warning'].empty?
-      warning status['warning'].map { |u, v| "#{u} days left:#{v}" }.join(',')
+    results = expiration_results
+
+    warn_results = results[:critical].merge(results[:warning]).map { |u, v| "#{u} (#{v} days left)" }
+    unknown_results = results[:unknown].map { |u, v| "#{u} (#{v})" }
+    message warn_results.concat(unknown_results).join(', ')
+
+    if !results[:critical].empty? || (!results[:unknown].empty? && config[:'report-errors'] == :critical)
+      critical
+    elsif !results[:warning].empty? || (!results[:unknown].empty? && config[:'report-errors'] == :warning)
+      warning
+    elsif !results[:unknown].empty?
+      unknown
     else
       ok 'No domains expire in the near term'
     end

data/bin/check-whois-domain-expiration.rb

@@ -60,27 +60,22 @@ class WhoisDomainExpirationCheck < Sensu::Plugin::Check::CLI
          show_options: true,
          exit: 0
 
-  def check_days(num_days,
-                 warning_days = config[:warning].to_i,
-                 critical_days = config[:critical].to_i)
-    if num_days <= critical_days
+  def run
+    whois = Whois.whois(config[:domain])
+
+    expires_on = DateTime.parse(whois.parser.expires_on.to_s)
+    num_days = (expires_on - DateTime.now).to_i
+
+    message "#{config[:domain]} expires on #{expires_on.strftime('%m-%d-%Y')} (#{num_days} days away)"
+
+    if num_days <= config[:warning].to_i
       critical
-    elsif num_days <= warning_days
+    elsif num_days <= config[:critical].to_i
       warning
     else
       ok
     end
-  end
-
-  def initialize
-    super()
-    whois = Whois.whois(config[:domain])
-    @expires_on = DateTime.parse(whois.parser.expires_on.to_s)
-    @num_days = (@expires_on - DateTime.now).to_i
-  end
-
-  def run
-    message "#{config[:domain]} expires on #{@expires_on.strftime('%m-%d-%Y')} (#{@num_days} days away)"
-    check_days @num_days
+  rescue
+    unknown "#{config[:domain]} can't be checked"
   end
 end

data/lib/sensu-plugins-network-checks/version.rb

@@ -1,7 +1,7 @@
 module SensuPluginsNetworkChecks
   module Version
     MAJOR = 2
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-network-checks
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors