sensu-plugin 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b8bf9dc7a64cb5b2a2359146d1d8cfa747fc8e6
-  data.tar.gz: 52223d03497178da064f55e89e307d1ab86dfef4
+  metadata.gz: 2730e59c7a3b4d3dbc9d167d84a5ca0a7e428ae7
+  data.tar.gz: 4922478ec5392ab0efb0e41bfee2076c175aee7a
 SHA512:
-  metadata.gz: d698f30f72883a2024bb7096c14cc42ec4fa740a12e337c7903018b76b2e30444030fe907b8dc962d3f2a87c2dac6fc08b2400ec00fb36d84d9f0f4d83a654f5
-  data.tar.gz: 5768eb08725dc2f4d723a2dc367587854f108082c08804fa6679982fd70ce684fcbb4f1f8867171a27cff6119ff94d1015594162ccdd465d619edec46f8eef13
+  metadata.gz: 76dd04a3e1c2819c4cff3daefbb1f6ffeb250820b8e7d3fcbfa9e9a4f467074b3b25839c3fc166cda4b6131743465bcb12946e8b2de033afb84391897fbe05a2
+  data.tar.gz: bfdf09aff3a445ffc1a9f94d21d46a28193812e633b8d0c91fb5354d0c3f3b07f50a347cfead92f7d06d6db1c910ac1e461e02d64d7e1ca9b9ee85a829a76703

data/lib/sensu-handler.rb

@@ -1,4 +1,6 @@
 require 'net/http'
+require 'timeout'
+require 'uri'
 require 'json'
 require 'sensu-plugin/utils'
 require 'mixlib/cli'
@@ -71,21 +73,41 @@ module Sensu
     end
 
     def bail(msg)
-      puts msg + ': ' + @event['client']['name'] + '/' + @event['check']['name']
+      client_name = @event['client']['name'] || 'error:no-client-name'
+      check_name = @event['check']['name'] || 'error:no-check-name'
+      puts "#{msg}: #{client_name}/#{check_name}"
       exit 0
     end
 
+    def api_settings
+      @api_settings ||= if ENV['SENSU_API_URL']
+        uri = URI(ENV['SENSU_API_URL'])
+        {
+          'host' => uri.host,
+          'port' => uri.port,
+          'user' => uri.user,
+          'password' => uri.password
+        }
+      else
+        settings['api']
+      end
+    end
+
     def api_request(method, path, &blk)
-      if not settings.has_key?('api')
+      if api_settings.nil?
         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'])
+      domain = api_settings['host'].start_with?('http') ? api_settings['host'] : 'http://' + api_settings['host']
+      uri = URI("#{domain}:#{api_settings['port']}#{path}") 
+      req = net_http_req_class(method).new(uri)
+      if api_settings['user'] && api_settings['password']
+        req.basic_auth(api_settings['user'], api_settings['password'])
       end
       yield(req) if block_given?
-      http.request(req)
+      res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.request(req)
+      end
+      res
     end
 
     def filter_disabled
@@ -113,7 +135,7 @@ module Sensu
       end
       if @event['occurrences'] > occurrences && @event['action'] == 'create'
         number = refresh.fdiv(interval).to_i
-        unless number == 0 || @event['occurrences'] % number == 0
+        unless number == 0 || (@event['occurrences'] - occurrences) % number == 0
           bail 'only handling every ' + number.to_s + ' occurrences'
         end
       end
@@ -131,7 +153,7 @@ module Sensu
       ]
       stashes.each do |(scope, path)|
         begin
-          timeout(2) do
+          Timeout.timeout(5) do
             if stash_exists?(path)
               bail scope + ' alerts silenced'
             end
@@ -153,7 +175,7 @@ module Sensu
         if @event['check']['dependencies'].is_a?(Array)
           @event['check']['dependencies'].each do |dependency|
             begin
-              timeout(2) do
+              Timeout.timeout(2) do
                 check, client = dependency.split('/').reverse
                 if event_exists?(client || @event['client']['name'], check)
                   bail 'check dependency event exists'

data/lib/sensu-mutator.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+#
+# Sensu-mutator
+# ===
+#
+# DESCRIPTION:
+#   Base mutator class.  All you need to do is extend this class and implement a
+#   #mutate function.  Uses the autorun feature just like sensu-handler and sensu-plugin/cli
+# 
+# Example Implementation: described https://sensuapp.org/docs/latest/mutators#example-mutator-plugin
+#
+# class Helper < Sensu::Mutator
+#   def mutate
+#     @event.merge!(:mutated => true)
+#   end
+# end
+#
+# PLATFORM:
+#   all
+#
+# DEPENDENCIES:
+#   sensu-plugin/utils
+#   mixlib/cli
+#
+# Copyright 2015 Zach Bintliff <https://github.com/zbintliff>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+require 'json'
+require 'sensu-plugin/utils'
+require 'mixlib/cli'
+
+module Sensu
+  class Mutator
+    include Sensu::Plugin::Utils
+    include Mixlib::CLI
+
+    attr_accessor :argv
+
+    def initialize(argv = ARGV)
+      super()
+      self.argv = parse_options(argv)
+    end
+
+    def mutate
+      ## Override this, be sure any changes are made to @event
+      nil
+    end
+
+    def dump
+      puts JSON.dump(@event)
+    end
+
+    # This works just like Plugin::CLI's autorun.
+    @@autorun = self
+    class << self
+      def method_added(name)
+        if name == :mutate
+          @@autorun = self
+        end
+      end
+    end
+
+    def self.disable_autorun
+      @@autorun = false
+    end
+
+    at_exit do
+      if @@autorun
+        mutator = @@autorun.new
+        mutator.read_event(STDIN)
+        mutator.mutate
+        mutator.dump
+      end
+    end
+  end
+end

data/lib/sensu-plugin.rb

@@ -1,6 +1,6 @@
 module Sensu
   module Plugin
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
     EXIT_CODES = {
       'OK'       => 0,
       'WARNING'  => 1,

data/lib/sensu-plugin/cli.rb

@@ -51,20 +51,22 @@ module Sensu
       end
 
       at_exit do
-        begin
-          check = @@autorun.new
-          check.run
-        rescue SystemExit => e
-          exit e.status
-        rescue OptionParser::InvalidOption => e
-          puts "Invalid check argument(s): #{e.message}, #{e.backtrace}"
-          exit 1
-        rescue Exception => e
-          # This can't call check.critical, as the check may have failed to construct
-          puts "Check failed to run: #{e.message}, #{e.backtrace}"
-          exit 2
+        if @@autorun
+          begin
+            check = @@autorun.new
+            check.run
+          rescue SystemExit => e
+            exit e.status
+          rescue OptionParser::InvalidOption => e
+            puts "Invalid check argument(s): #{e.message}, #{e.backtrace}"
+            exit 1
+          rescue Exception => e
+            # This can't call check.critical, as the check may have failed to construct
+            puts "Check failed to run: #{e.message}, #{e.backtrace}"
+            exit 2
+          end
+          check.warning "Check did not exit! You should call an exit code method."
         end
-        check.warning "Check did not exit! You should call an exit code method."
       end
 
     end

data/lib/sensu-plugin/metric/cli.rb

@@ -19,11 +19,13 @@ module Sensu
 
         class Graphite < Sensu::Plugin::CLI
           def output(*args)
-            if args[0].is_a?(Exception) || args[1].nil?
-              puts args[0].to_s
-            else
-              args[2] ||= Time.now.to_i
-              puts args[0..2].join("\s")
+            unless args.empty?
+              if args[0].is_a?(Exception) || args[1].nil?
+                puts args[0].to_s
+              else
+                args[2] ||= Time.now.to_i
+                puts args[0..2].join("\s")
+              end
             end
           end
         end

data/test/handle_filter_test.rb

@@ -59,7 +59,7 @@ class TestFilterExternal < MiniTest::Unit::TestCase
     event = {
       'client' => { 'name' => 'test' },
       'check' => { 'name' => 'test' },
-      'occurrences' => 60,
+      'occurrences' => 61,
       'action' => 'create'
     }
     output = run_script_with_input(JSON.generate(event))
@@ -71,7 +71,7 @@ class TestFilterExternal < MiniTest::Unit::TestCase
     event = {
       'client' => { 'name' => 'test' },
       'check' => { 'name' => 'test' },
-      'occurrences' => 59,
+      'occurrences' => 60,
       'action' => 'create'
     }
     output = run_script_with_input(JSON.generate(event))
@@ -83,7 +83,7 @@ class TestFilterExternal < MiniTest::Unit::TestCase
     event = {
       'client' => { 'name' => 'test' },
       'check' => { 'name' => 'test', 'refresh' => 0 },
-      'occurrences' => 59,
+      'occurrences' => 60,
       'action' => 'create'
     }
     output = run_script_with_input(JSON.generate(event))
@@ -95,7 +95,7 @@ class TestFilterExternal < MiniTest::Unit::TestCase
     event = {
       'client' => { 'name' => 'test' },
       'check' => { 'name' => 'test', 'refresh' => 30 },
-      'occurrences' => 59,
+      'occurrences' => 60,
       'action' => 'create'
     }
     output = run_script_with_input(JSON.generate(event))

data/test/mutator_test.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'test_helper'
+
+# Simple Heper to test mutator
+class TestMutatorHelpers < MiniTest::Test
+  include SensuPluginTestHelper
+  def test_base_mutator
+    set_script 'external/mutator-trivial'
+    event = JSON.parse(fixture('basic_event.json').read)
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_equal(event, JSON.parse(output))
+  end
+
+  def test_external_mutator
+    set_script 'external/mutator-helpers'
+    event = JSON.parse(fixture('basic_event.json').read)
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_equal(true, JSON.parse(output)['mutated'])
+  end
+end

data/test/test_helper.rb

@@ -3,7 +3,6 @@ gem 'minitest' if RUBY_VERSION < '1.9.0'
 require 'minitest/autorun'
 
 module SensuPluginTestHelper
-
   def set_script(script)
     @script = File.join(File.dirname(__FILE__), script)
   end
@@ -22,4 +21,11 @@ module SensuPluginTestHelper
     end
   end
 
+  def fixture_path
+    File.expand_path('../fixtures', __FILE__)
+  end
+
+  def fixture(f)
+    File.new(File.join(fixture_path, f))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sensu-handler.rb
+- lib/sensu-mutator.rb
 - lib/sensu-plugin.rb
 - lib/sensu-plugin/check/cli.rb
 - lib/sensu-plugin/cli.rb
@@ -87,8 +88,9 @@ files:
 - test/external_metric_test.rb
 - test/handle_filter_test.rb
 - test/handle_helper_test.rb
+- test/mutator_test.rb
 - test/test_helper.rb
-homepage: https://github.com/sonian/sensu-plugin
+homepage: https://github.com/sensu-plugins/sensu-plugin
 licenses:
 - MIT
 metadata: {}
@@ -108,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Sensu Plugins
@@ -118,6 +120,7 @@ test_files:
 - test/external_handler_argument_test.rb
 - test/handle_filter_test.rb
 - test/external_handler_test.rb
+- test/mutator_test.rb
 - test/external_check_test.rb
 - test/test_helper.rb
 has_rdoc: false