nagios-plugin 0.0.1

data/lib/nagios-plugin.rb

@@ -0,0 +1,123 @@
+require 'optparse'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Nagios
+  class Plugin
+     VERSION = '0.0.1'
+     OK_STATE = 0
+     WARNING_STATE = 1
+     CRITICAL_STATE = 2
+     UNKNOWN_STATE = 3
+     
+     def initialize(args = {})
+     	 @shortname = args[:shortname] || "Nagios::Plugin"
+     	 @print = args[:print] || true
+     	 @exit = args[:exit] || true
+     	 @perfdata = Hash.new
+     	 
+     	 # now, handle the arguments...
+     	 @opts = OptionParser.new
+     	 @opts.on("-w", "--warning WARNING", "WARNING THRESHOLD") do |w|
+     	 	 @warning = w
+	 end
+	 @opts.on("-c", "--critical CRITICAL", "CRITICAL THRESHOLD") do |c|
+     	 	 @critical = c
+	 end
+     end
+     
+     def warning
+     	     @warning     
+     end
+     
+     def critical
+     	     @critical
+     end
+     
+     def parse_argv()
+     	     @opts.parse(ARGV)
+     end
+     
+     def exit=(enabled)
+     	     @exit = enabled
+     end
+     
+     def print=(enabled)
+     	     @print = enabled
+     end
+     
+     # actually does the check
+     def run
+     	     raise "You must implement the run method!"
+     end
+     
+     def state 
+     	   @state
+     end
+     
+     def output 
+     	     @output
+     end
+     
+     def add_perfdata(args)
+     	   field = args[:field] or raise "must supply field!"
+     	   data = args[:data] or raise "must supply data!"
+     	   @perfdata[field] = {:data => data}
+     	   @perfdata[field][:uom] = args[:uom] if args[:uom]
+     	   @perfdata[field][:warning] = args[:warning] if args[:warning]
+     	   @perfdata[field][:critical] = args[:critical] if args[:critical]
+     end
+     
+     private
+     
+     def critical(message)
+     	     @state = :CRITICAL
+     	     do_exit(CRITICAL_STATE, message)
+     end
+     
+     def ok(message)
+     	     @state = :OK
+     	     do_exit(OK_STATE, message)
+     end
+     
+     def warning(message)
+     	     @state = :WARNING
+     	     do_exit(WARNING_STATE, message)
+     end
+     
+     def unknown(message)
+     	     @state = :UNKNOWN
+     	     do_exit(UNKNOWN_STATE, message)
+     end
+     
+     def do_exit(status, message)
+     	     @output = @shortname + " "
+     	     case status
+     	     when OK_STATE
+     	     	     @output += "OK - "
+     	     when WARNING_STATE
+     	     	     @output += "WARNING - "
+     	     when CRITICAL_STATE
+     	     	     @output += "CRITICAL - "
+     	     when UNKNOWN_STATE
+     	     	     @output += "UNKNOWN - "
+     	     end
+     	     @output += message
+     	     # see if we have keys...
+     	     if @perfdata.keys.length > 0
+     	     	     @output += " | "
+     	     	     outputs = []
+     	     	     @perfdata.each_pair do |key, value|
+     	     	     	     outputs << "#{key}=#{value[:data]}#{value[:uom]};#{value[:warning]};#{value[:critical]}"  
+     	     	     end
+     	     	     @output += outputs.join(", ")
+     	     end
+     	     @output.strip!
+     	     puts @output if @print
+     	     exit(status) if @exit
+     	     return @output
+     end
+     
+  end 
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/nagios-plugin'

data/test/test_nagios-plugin.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestPlugin < Nagios::Plugin
+	def run
+	    critical("waffles are getting really low...")
+	end
+end
+
+class TestNagiosPlugin < Test::Unit::TestCase
+
+  def setup
+  	  @tp = TestPlugin.new(:shortname => "Waffles")
+  	  @tp.exit = false
+  	  @tp.print = false
+  end
+  
+  def test_critical
+  	  output = @tp.run
+  	  assert_equal("Waffles CRITICAL - waffles are getting really low...", output)
+  end
+  
+  def test_perf
+  	  @tp.add_perfdata(:field => "waffles_per_second", :data => 10, :warning => 2, :critical => 5, :uom => "wps")
+  	  @tp.run
+  	  output = @tp.output
+  	  assert_equal("Waffles CRITICAL - waffles are getting really low... | waffles_per_second=10wps;2;5", output)
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: nagios-plugin
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Harding
+- Daniel Zajic
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-27 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- danielzajic@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/nagios-plugin.rb
+- test/test_helper.rb
+- test/test_nagios-plugin.rb
+has_rdoc: true
+homepage: https://github.com/analog-analytics/ruby-nagios-plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides a base class for writing Nagios Plugins in Ruby
+test_files: []
+