ostrichpoll 0.0.4 → 0.0.5

data/README.md

@@ -47,6 +47,7 @@ Configuration is specified in the format:
           normal_range: [0, 5]
           missing: ignore
           exit_code: 2
+          exit_message: "Message drop rate is too high"
         metrics/KafkaEventSink_append_msec/p99:
           normal_range: [0, 10]
           missing: error
@@ -64,6 +65,7 @@ Configuration is specified in the format:
     * `normal_range` an array specifying the minimum and maximum (inclusive) values which are acceptable for this metric
     * `missing` behavior if the metric is not seen in the output at all. (error by default)
     * `exit_code` what value Ostrichpoll should exit with if this error is seen.
+    * `exit_message` what Ostrichpoll should output to STDOUT if this error is seen. "OK" is the default (if no errors are encountered).
     
 ### Notes
 Ostrichpoll is setup to execute all validations on each execution. Even if one of the early validations fails, the output from all validations is logged to stderr. However, the exit code is the exit code from the first erroring validation.

data/lib/ostrichpoll.rb

@@ -6,7 +6,7 @@ require 'logger'
 
 require 'ostrichpoll/string'
 require 'ostrichpoll/version'
-require 'ostrichpoll/exit_codes'
+require 'ostrichpoll/exit_status'
 require 'ostrichpoll/config_parser'
 
 module OstrichPoll
@@ -46,14 +46,14 @@ module OstrichPoll
   if @opts[:configfile]
     yaml = YAML.load_file @opts[:configfile]
     hosts = ConfigParser.parse(yaml)
+    retval = nil
 
-    retval = false
     hosts.each do |h|
-      retval = h.validate unless retval
+      retval = h.validate if retval.nil?
     end
 
     # use the exitcode, unless none is given
-    exit retval if retval
+    retval.exit unless retval.nil?
 
   else
     # if we don't have a config file, simply check that the host and port respond to http
@@ -62,7 +62,7 @@ module OstrichPoll
       @response = Net::HTTP.get uri
     rescue Exception => e
       Log.warn e
-      exit EXIT_NOHTTP
+      EXIT_NOHTTP.exit
     end
   end
 
@@ -71,7 +71,7 @@ rescue SystemExit => e
 
 rescue Exception => e
   Log.error e
-  exit EXIT_ERROR # exit with error
+  ExitStatus.new(e.message, 1).exit # exit with error
 end
 
-exit OstrichPoll::EXIT_OK
+OstrichPoll::EXIT_OK.exit

data/lib/ostrichpoll/config_parser.rb

@@ -65,6 +65,9 @@ module OstrichPoll
           when 'exit_code'
             validator.exit_code = value
 
+          when 'exit_message'
+            validator.exit_message = value
+
           else
             Log.warn "Unknown key for validation: #{key}. Ignoring."
         end

data/lib/ostrichpoll/exit_status.rb

@@ -0,0 +1,24 @@
+module OstrichPoll
+
+  class ExitStatus
+    attr_accessor :message, :code
+
+    def initialize(message, code)
+      @message = message
+      @code = code
+    end
+    
+    def exit
+      puts @message
+      Kernel.exit @code
+    end
+  end
+
+
+  # generics
+  EXIT_OK = ExitStatus.new("OK", 0)
+  EXIT_FAIL = ExitStatus.new("", 1)
+
+  # could not connect to http endpoint
+  EXIT_NOHTTP = ExitStatus.new("Ostrichpoll Could not connect to HTTP endpoint", 1)
+end

data/lib/ostrichpoll/ostrich_validator.rb

@@ -23,14 +23,16 @@ module OstrichPoll
     def validate
       uri = URI.parse url
       response = Net::HTTP.get uri rescue (
-        Log.error "Unable to connect to host #{uri}"
-        return EXIT_ERROR
+        error_msg = "Unable to connect to host #{uri}"
+        Log.error error_msg
+        return ExitStatus.new(error_msg, 1)
       )
 
       # parse response
       json = JSON.parse(response) rescue (
-        Log.error "Invalid JSON response: #{response}"
-        return EXIT_ERROR
+        error_msg = "Invalid JSON response: #{response}"
+        Log.error error_msg
+        return ExitStatus.new(error_msg, 1)
       )
 
       @stored_values = {}
@@ -52,9 +54,10 @@ module OstrichPoll
           f.puts json.to_yaml
         end
       end
+      
+      retval = nil
 
       # execute each validation:
-      retval = false
       if validations
         matched_validations = []
         validations.each do |v|
@@ -71,7 +74,7 @@ module OstrichPoll
 
         matched_validations.each do |v|
           value = v.check(find_value(json, v.metric))
-          retval = value unless retval
+          retval = value if retval.nil?
         end
       end
 
@@ -133,11 +136,13 @@ module OstrichPoll
     attr_accessor :normal_range
     attr_accessor :missing
     attr_accessor :exit_code
+    attr_accessor :exit_message
 
     def init
       @rate = false
       @regex = false
       @exit_code = 1
+      @exit_message = ""
       @missing = :ignore
     end
 
@@ -145,6 +150,10 @@ module OstrichPoll
       Log.warn "Invalid metric #{metric.inspect}" unless metric.is_a? String
       Log.warn "Invalid exit code: #{exit_code.inspect}" unless exit_code.is_a? Integer
 
+      if exit_message
+        Log.warn "Invalid exit message: #{exit_message.inspect}" unless exit_message.is_a? String
+      end
+
       if normal_range
         Log.warn "Invalid normal range: #{normal_range.inspect}" unless normal_range.is_a? Array
       end
@@ -160,12 +169,13 @@ module OstrichPoll
       # error on missing value unless we ignore missing
       unless value
         unless missing == :ignore
-          Log.warn "#{metric}: value missing, treating as error; exit code #{exit_code}"
-          return exit_code
+          error_msg = "#{metric}: value missing"
+          Log.warn "#{error_msg}, treating as error; exit code #{exit_code}"
+          return ExitStatus.new(error_msg, exit_code)
         else
           Log.debug "#{host_instance.url} |   missing value, but set to ignore"
           # not an error, but you can't check anything else
-          return false
+          return nil
         end
       end
 
@@ -187,7 +197,7 @@ module OstrichPoll
         else
           # let it pass
           Log.info "#{metric}: no previous reading for rate"
-          return false
+          return nil
         end
       end
 
@@ -208,19 +218,19 @@ module OstrichPoll
         end
 
         if lo && value < lo
-          Log.warn "#{metric}: read value #{value} is below normal range minimum #{lo}; exit code #{exit_code}"
-          return exit_code
+          Log.warn "#{metric}: read value #{value} is below normal range minimum #{lo}; exit code #{exit_code}; exit message '#{exit_message}'"
+          return ExitStatus.new(exit_message, exit_code)
         end
 
         if hi && value > hi
-          Log.warn "#{metric}: read value #{value} is above normal range maximum #{hi}; exit code #{exit_code}"
-          return exit_code
+          Log.warn "#{metric}: read value #{value} is above normal range maximum #{hi}; exit code #{exit_code}; exit message '#{exit_message}'"
+          return ExitStatus.new(exit_message, exit_code)
         end
 
         Log.debug "#{host_instance.url} |   within normal range"
       end
 
-      false
+      nil
     end
   end
 end

data/lib/ostrichpoll/version.rb

@@ -1,3 +1,3 @@
 module OstrichPoll
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ostrichpoll
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000Z
+date: 2012-09-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70343268535920 !ruby/object:Gem::Requirement
+  requirement: &70231070956020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70343268535920
+  version_requirements: *70231070956020
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70343268534280 !ruby/object:Gem::Requirement
+  requirement: &70231070955200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70343268534280
+  version_requirements: *70231070955200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70343268530060 !ruby/object:Gem::Requirement
+  requirement: &70231070948140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343268530060
+  version_requirements: *70231070948140
 description: Ostrichpoll is a tiny utility for monitoring Twitter Ostrich services.
   Effectively it can monitor any service which exposes internal metrics in JSON over
   HTTP.
@@ -63,7 +63,7 @@ files:
 - bin/ostrichpoll
 - lib/ostrichpoll.rb
 - lib/ostrichpoll/config_parser.rb
-- lib/ostrichpoll/exit_codes.rb
+- lib/ostrichpoll/exit_status.rb
 - lib/ostrichpoll/ostrich_validator.rb
 - lib/ostrichpoll/string.rb
 - lib/ostrichpoll/version.rb

data/lib/ostrichpoll/exit_codes.rb

@@ -1,8 +0,0 @@
-module OstrichPoll
-  # generics
-  EXIT_OK = 0
-  EXIT_ERROR = -1
-
-  # could not connect to http endpoint
-  EXIT_NOHTTP = 1
-end