sensu-plugins-sensu 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2870929cd3cd4f899088cb6ec55104e76807d063
-  data.tar.gz: 3e346d7facc6bf08e84d1993a40e1d4e1345faad
+  metadata.gz: db61d659c304cbb69bab103dc96810acc18b303e
+  data.tar.gz: 65d88dbf81a056122cf421e2eef2a354e0cb7971
 SHA512:
-  metadata.gz: a90af312010e2d9ba78c824d54c64f3fd50918d1d647a1601cd221b31b2cd92e6a5448271df7ab57503048316e1ff1cd5365a1fb8555d93abf5aca56b2ec649e
-  data.tar.gz: 40800095ddbdcd9559a2b8411094a841f4295884bec1ea137ec6bde7d4ce77f7753d7511c1f297f475448c50b9c9653024bbe11d899447b40e36af6306f7a4e5
+  metadata.gz: 87ba1a72154774b05550e1969d7e3f6a7129921371cff565bb29067f74b3502d499628886929efb20450b0633dda14d2a37083dd391ce9121c1ff6a573863308
+  data.tar.gz: 06d0d10142e70be953d73eef0b233eda4e4b4ef25d2b1632d4c7a2fee9b11dedd26a6e5bcadcf1e89008e15033abd7db4c930768ddd88e5b0ed00e92cb452c12

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [2.1.0] - 2017-08-29
+### Added
+- check-stale-results.rb: new script to check for stale results in sensu (@m4ce)
+- handler-purge-stale-results.rb: new handler to purge stale results from sensu (@m4ce)
+
 ## [2.0.0] - 2017-08-20
 ### Breaking Changes
 - check-aggregates.rb: Changed the default behaviour to alert with the severity of the aggregated checks.
@@ -64,7 +69,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/1.1.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/2.1.0...HEAD
+[2.1.0]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/1.1.1...2.0.0
 [1.1.1]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/1.1.0...1.1.1
 [1.1.0]: https://github.com/sensu-plugins/sensu-plugins-sensu/compare/1.0.0...1.1.0

data/README.md

@@ -10,14 +10,48 @@
 
 ## Files
  * bin/check-aggregate.rb
+ * bin/check-stale-results.rb
  * bin/metrics-aggregate.rb
  * bin/metrics-delete-expired-stashes.rb
  * bin/metrics-events.rb
  * bin/handler-sensu.rb
  * bin/handler-sensu-deregister.rb
+ * bin/handler-purge-stale-results.rb
 
 ## Usage
 
+### check-stale-results.rb
+
+A sensu plugin to monitor sensu stale check results. You can then implement an handler that purges the results after X days using the `handlers-purge-stale-results` handler.
+
+The plugin accepts the following command line options:
+
+```
+Usage: check-stale-results.rb (options)
+    -c, --crit <COUNT>               Critical if number of stale check results exceeds COUNT
+    -s, --stale <TIME>               Elapsed time to consider a check result result (default: 1d)
+    -v, --verbose                    Be verbose
+    -w, --warn <COUNT>               Warn if number of stale check results exceeds COUNT (default: 1)
+```
+
+the --stale command line option accepts elapsed times formatted as documented in https://github.com/hpoydar/chronic_duration.
+
+The handler accepts the following command line options:
+
+### handler-purge-stale-results.rb
+
+A sensu handler to purge stale check results. This handler can be invoked from a check that uses the the `check-stale-results` plugin.
+
+```
+Usage: handler-purge-stale-results.rb (options)
+        --mail-recipient <ADDRESS>   Mail recipient (required)
+        --mail-sender <ADDRESS>      Mail sender (default: sensu@localhost)
+        --mail-server <HOST>         Mail server (default: localhost)
+    -s, --stale <TIME>               Elapsed time after which a stale check result will be deleted (default: 7d)
+```
+
+the --stale command line option accepts elapsed times formatted as documented in https://github.com/hpoydar/chronic_duration.
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/check-stale-results.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+#
+# check-stale-results.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'net/http'
+require 'json'
+require 'sensu-plugin/utils'
+require 'sensu-plugin/check/cli'
+require 'chronic_duration'
+
+class CheckStaleResults < Sensu::Plugin::Check::CLI
+  include Sensu::Plugin::Utils
+
+  option :stale,
+         description: 'Elapsed time to consider a check result result (default: 1d)',
+         short: '-s <TIME>',
+         long: '--stale <TIME>',
+         proc: proc { |s| ChronicDuration.parse(s) },
+         default: ChronicDuration.parse('1d')
+
+  option :verbose,
+         description: 'Be verbose',
+         short: '-v',
+         long: '--verbose',
+         boolean: true,
+         default: false
+
+  option :warn,
+         description: 'Warn if number of stale check results exceeds COUNT (default: 1)',
+         short: '-w <COUNT>',
+         long: '--warn <COUNT>',
+         proc: proc(&:to_i),
+         default: 1
+
+  option :crit,
+         description: 'Critical if number of stale check results exceeds COUNT',
+         short: '-c <COUNT>',
+         long: '--crit <COUNT>',
+         proc: proc(&:to_i),
+         default: nil
+
+  def initialize
+    super
+
+    raise 'Critical threshold must be higher than the warning threshold' if config[:crit] && config[:warn] >= config[:crit]
+
+    # get list of sensu results
+    @results = results
+  end
+
+  def humanize(secs)
+    [[60, :seconds], [60, :minutes], [24, :hours], [1000, :days]].map do |count, name|
+      if secs > 0
+        secs, n = secs.divmod(count)
+        "#{n.to_i} #{name}"
+      end
+    end.compact.reverse.join(' ')
+  end
+
+  def api_request(method, path, _blk)
+    unless settings.key?('api')
+      raise 'api.json settings not found.'
+    end
+    http = Net::HTTP.new(settings['api']['host'], settings['api']['port'])
+    req = net_http_req_class(method).new(path)
+    if settings['api']['user'] && settings['api']['password']
+      req.basic_auth(settings['api']['user'], settings['api']['password'])
+    end
+    yield(req) if block_given?
+    http.request(req)
+  end
+
+  def results
+    res = []
+    req = api_request(:GET, '/results')
+    res = JSON.parse(req.body) if req && req.code == '200'
+    res
+  end
+
+  def run
+    stale = 0
+    footer = "\n\n"
+    @results.each do |result|
+      diff = Time.now.to_i - result['check']['issued']
+      if diff > config[:stale]
+        stale += 1
+        footer += "  - check result #{result['client']}/#{result['check']['name']} is stale (#{humanize(diff)})\n"
+      end
+    end
+    footer += "\n"
+
+    if config[:crit] && stale >= config[:crit]
+      msg = "Found #{stale} stale check results (>= #{config[:crit]})"
+      msg += footer if config[:verbose]
+      critical(msg)
+    end
+
+    if stale >= config[:warn]
+      msg = "Found #{stale} stale check results (>= #{config[:warn]})"
+      msg += footer if config[:verbose]
+      warning(msg)
+    end
+
+    ok("No stale check results found (>= #{config[:warn]})")
+  end
+end

data/bin/handler-purge-stale-results.rb

@@ -0,0 +1,90 @@
+#
+# handler-purge-stale-results.rb
+#
+# Author: Matteo Cerutti <matteo.cerutti@hotmail.co.uk>
+#
+
+require 'sensu-handler'
+require 'time'
+require 'net/smtp'
+require 'socket'
+require 'chronic_duration'
+
+class HandlerPurgeStaleResults < Sensu::Handler
+  option :stale,
+         description: 'Elapsed time after which a stale check result will be deleted (default: 7d)',
+         short: '-s <TIME>',
+         long: '--stale <TIME>',
+         proc: proc { |s| ChronicDuration.parse(s) },
+         default: ChronicDuration.parse('7d')
+
+  option :mail_server,
+         description: 'Mail server (default: localhost)',
+         long: '--mail-server <HOST>',
+         default: 'localhost'
+
+  option :mail_sender,
+         description: 'Mail sender (default: sensu@localhost)',
+         long: '--mail-sender <ADDRESS>',
+         default: 'sensu@localhost'
+
+  option :mail_recipient,
+         description: 'Mail recipient',
+         long: '--mail-recipient <ADDRESS>',
+         required => true
+
+  def results
+    res = []
+    req = api_request(:GET, '/results')
+    res = JSON.parse(req.body) if req && req.code == '200'
+    res
+  end
+
+  def handle
+    deleted = []
+    failed = []
+
+    results.each do |result|
+      diff = Time.now.to_i - result['check']['issued']
+      if diff > config[:stale]
+        begin
+          req = api_request(:DELETE, "/results/#{result['client']}/#{result['check']['name']}")
+          if req.code != '204'
+            failed << "#{result['client']} - #{result['check']['name']} (Code: #{req.code}, Message: #{req.body})"
+          else
+            deleted << "#{result['client']} - #{result['check']['name']}"
+          end
+        rescue
+          failed << "#{result['client']} - #{result['check']['name']} (Caught exception: #{$ERROR_INFO})"
+        end
+      end
+    end
+
+    if !deleted.empty? || !failed.empty?
+      msg = <<EOF
+From: Sensu <#{config[:mail_sender]}>
+To: <#{config[:mail_recipient]}>
+Subject: Purge stale check results
+
+This is a notification concerning the #{self.class.name} sensu handler running at #{Socket.gethostname}
+
+* Summary
+
+    Deleted: #{deleted.size}
+    Failed to delete: #{failed.size}
+
+* Failed to delete check results:
+
+#{failed.map { |m| "    #{m}" }.join("\n")}
+
+* Deleted check results:
+
+#{deleted.map { |m| "    #{m}" }.join("\n")}
+EOF
+
+      Net::SMTP.start(config[:mail_server]) do |smtp|
+        smtp.send_message(msg, config[:mail_sender], config[:mail_recipient])
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module SensuPluginsSensu
   # This defines the version of the gem
   module Version
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-sensu
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,8 @@ description: This plugin provides monitoring and metrics for Sensu.
 email: "<sensu-users@googlegroups.com>"
 executables:
 - check-aggregate.rb
+- check-stale-results.rb
+- handler-purge-stale-results.rb
 - handler-sensu-deregister.rb
 - handler-sensu.rb
 - metrics-aggregate.rb
@@ -194,6 +210,8 @@ files:
 - LICENSE
 - README.md
 - bin/check-aggregate.rb
+- bin/check-stale-results.rb
+- bin/handler-purge-stale-results.rb
 - bin/handler-sensu-deregister.rb
 - bin/handler-sensu.rb
 - bin/metrics-aggregate.rb