ruby-nagios 0.0.1 → 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.md

@@ -0,0 +1,92 @@
+What?
+=====
+Have you ever had to disable alerts, retry a check
+or acknowledge outages on a large amount of service
+with Nagios and hated the web UI for it?
+
+This is a CLI tool and Ruby library that parses your
+status log file and let you query it for information
+or create external commands to be piped into the nagios
+command file.
+
+You can get this software here on GitHub or via RubyGems
+as *ruby-nagios*
+
+Using on the CLI?
+=================
+Find out what services match a regular expression:
+
+    nagsrv --list-services --with-service /puppet/
+    puppet-freshness
+    puppetd
+    puppetmaster
+
+Find hosts with the service /puppet/:
+
+    nagsrv --list-hosts --with-service /puppet/
+    dev1.your.net
+    dev2.your.net
+    .
+    .
+
+Disable notifications for them all on all hosts:
+
+    nagsrv.rb --disable-notify --with-service /puppet/
+    [1263129006] DISABLE_SVC_NOTIFICATIONS;dev1.your.net;puppet-freshness
+    [1263129006] DISABLE_SVC_NOTIFICATIONS;dev1.your.net;puppetd
+    [1263129006] DISABLE_SVC_NOTIFICATIONS;dev1.your.net;puppet-freshness
+    .
+    .
+    .
+
+Only do it for hosts matching /dev2/:
+
+    nagsrv.rb --disable-notify --with-service /puppet/ --for-host /dev2/
+    [1263129038] DISABLE_SVC_NOTIFICATIONS;dev2.your.net;puppet-freshness
+    [1263129038] DISABLE_SVC_NOTIFICATIONS;dev2.your.net;puppetd
+
+You can do ack's, force checks etc, see the help or
+comments in the nagsrv.rb script. To actually get
+nagios to do these actions just redirect the output
+from these commands to the Nagios CMD file. On my
+machine that is /var/log/nagios/rw/nagios.cmd.
+
+Using from Ruby?
+================
+
+You can also do the same from within Ruby easily,
+the library lets you search host by any property
+on a service, here we'll find all hosts with
+service /puppet/ on host /dev2/:
+
+    require 'rubygems'
+    require 'nagios/status'
+    nagios = Nagios::Status.new
+    nagios.parsestatus("status.log")
+
+    options = {:forhost => "/dev2/", :action => "${host}",
+               :withservice => "/puppet/"}
+    services = nagios.find_services(options)
+
+    puts services.join("\n")
+
+This will in this case just print:
+
+    dev2.your.net
+
+If you didn't specify the :action string it would
+just return an array of services found. The :action
+string is a template that lets you return the matches
+in any format you like, here's a template to Acknowledge
+services:
+
+    "[${tstamp}] ACKNOWLEDGE_SVC_PROBLEM;;${host};${service};1 \
+     ;0;1;#{ENV['USER']};Acknowledged from CLI"
+
+The only variables it supports now is ${host}, ${service}
+and ${tstamp} we can easily add more if needed.
+
+Contact?
+========
+
+R.I.Pienaar / rip@devco.net / @ripienaar / http://devco.net/

data/bin/nagsrv

@@ -52,8 +52,7 @@
 # Please open an issue at ruby-nagios.googlecode.com
 # with any queries
 
-require 'nagios/status'
-
+require 'nagios'
 require 'optparse'
 
 statusfile = "status.log"

data/lib/nagios.rb

@@ -0,0 +1,9 @@
+require 'nagios/config'
+require 'nagios/objects'
+require 'nagios/status'
+
+class String
+  unless method_defined?("each")
+    alias_method :each, :each_line
+  end
+end

data/lib/nagios/config.rb

@@ -0,0 +1,64 @@
+module Nagios
+
+=begin rdoc
+
+Configuration parser for Nagios. Constructor parses Nagios' main
+config file and returns an object: each configuration option's value
+assigned to an instance variable and attribute reader method is
+created.
+
+Can be used as:
+
+      require 'nagios/config'
+      nagios = Nagios::Config.new "lib/ruby-nagios/test/data/nagios.cfg"
+
+      nagios.log_file
+  => "/var/log/nagios3/nagios.log"
+
+      nagios.status_file
+  => "/var/cache/nagios3/status.dat"
+
+
+=end  
+  class Config
+
+    DEFAULT_CONFIG = "/etc/nagios*/nagios.cfg"
+
+    # Read and parse configuration file.
+    #
+    # @param [String] config_file PATH to the configuration file. If
+    #     PATH is not provided method will look for configuration file
+    #     +nagios.cfg+ in +/etc/nagios*+ directory.
+    # @note If you have more than one /etc/nagios* directories then
+    #    only first one will be used. For example, Debian can have
+    #    both Nagios 2 and 3 installed. In the latter case
+    #    configuration file is +/etc/nagios3/nagios.cfg+.
+    # @author Dmytro Kovalov, dmytro.kovalov@gmail.com
+    def initialize config_file=nil
+      @config = config_file || Dir.glob(DEFAULT_CONFIG).first
+      
+      raise "No configuration file option and no files in #{DEFAULT_CONFIG} " unless @config
+      raise "Configuration file #{@config} does not exist" unless File.exist? @config
+      raise "Configuration file #{@config} is not readable" unless File.readable? @config
+
+      File.readlines(@config).map{ |l| l.sub(/#.*$/,'')}.delete_if { |l| l=~ /^$/}.each do |l|
+        key,val = l.strip.split('=',2)
+        raise "Incorrect configuration line #{l}" unless key && val
+
+        case key
+        when /cfg_(file|dir)/ # There could be multiple entries for cfg_dir/file
+          instance_variable_set("@#{key}", (instance_variable_get("@#{key}") || []) << val )
+        else
+          instance_variable_set("@#{key}", val)
+          instance_eval val =~ /^[\d\.-]+/ ? 
+          "def #{key}; return #{val}; end" :
+            "def #{key}; return %Q{#{val}}; end"
+        end
+      end
+    end
+
+    # Special case for cfg_file and cfg_dir: they are Arrays
+    attr_reader :cfg_file, :cfg_dir
+
+  end
+end

data/lib/nagios/objects.rb

@@ -0,0 +1,189 @@
+module Nagios
+
+=begin rdoc
+
+= DESCRIPTION
+
+Nagios::Objects -- class for parsing Nagios' objects.cache
+file. Objects.cache file keeps information about lists of objects
+being monitored by Nagios. It is created by Nagios process on
+(re)start. Since it is machine-generated file syntax should not vary
+from file to file.
+
+Class implements 2 methods at the time of writing:
+* constructor - that only creates an instance and
+* parse method - that does actual parsing and populates instance variable @objects
+
+= SYNOPSIS
+
+  require 'nagios/objects'
+ 
+   nagios = Nagios::Objects.new("test/objects.cache").new.parse
+   print nagios.objects[:contactgroup]
+
+== Files
+
+Location of objects.cache file depends on Nagios configuration (in
+many cases varies from one UNIX/Linux ditribution to another) and is
+defined by directive in nagios.cfg file. 
+
+On Debian system objects.cache it is in
+/var/cache/nagios3/objects.cache:
+
+  object_cache_file=/var/cache/nagios3/objects.cache
+
+== Parsed data hash
+
+    irb(main):010:0> pp nagios.objects
+     {:timeperiod=>
+      {"24x7"=>
+        {:timeperiod_name=>"24x7",
+         :alias=>"24 Hours A Day, 7 Days A Week",
+         :sunday=>"00:00-24:00",
+         :monday=>"00:00-24:00",
+         :tuesday=>"00:00-24:00",
+         :wednesday=>"00:00-24:00",
+         :thursday=>"00:00-24:00",
+         :friday=>"00:00-24:00",
+         :saturday=>"00:00-24:00"},
+       "never"=>{:timeperiod_name=>"never", :alias=>"Never"},
+
+= Author
+
+Dmytro Kovalov, dmytro.kovalov@gmail.com
+2011, Dec, 27 - First working version
+
+=end
+
+  class Objects
+
+    # @param [String] path UNIX path to the objects.cache file
+    # @see Nagios::Objects.parse
+    def initialize path
+      raise "File does not exist" unless File.exist? path
+      raise "File is not readable" unless File.readable? path
+      @objects_file = path
+      @objects = {}
+    end
+ 
+    # PATH to the objects.cache file
+    attr_accessor :objects_file
+
+    # Parsed objects
+    attr_accessor :objects
+
+
+=begin rdoc    
+
+Read objects.cache file and parse it.
+
+Method reads file by blocks. Each block defines one object, definition
+starts with 'define <type> {' and ends with '}'. Each block has a
+'<type>_name' line which defines name of the instance of the
+object. 
+
+Code of the 'parse()' method assumes, that _name line is always first
+in the block! This can be not always the case.
+
+Example of a block:
+
+  define contactgroup {
+          contactgroup_name       admins
+          alias   Nagios Administrators
+          members root
+          }
+
+Example of a parsed object:
+
+    nagios.objects[:contactgroup]
+    => {"admins"=>{:contactgroup_name=>"admins", :alias=>"Nagios Administrators", :members=>"root"}}
+
+    nagios.contactgroup
+    => {"admins"=>{:contactgroup_name=>"admins", :alias=>"Nagios Administrators", :members=>"root"}}
+
+=== Convenience methods
+
+Method parse creates helper methods for every type of object after
+parsing. Same property can be accessed either using Hash @objects
+(i.e. nagios.objects[:host]) or convenience method: nagios.host.
+
+=end
+    def parse
+      block = {}
+      content = File.readlines objects_file
+      handler = nil
+      content.each do |line|
+        case
+        when line =~ /^\s*$/ then next # Skip empty lines
+        when line =~ /^\s*#/ then next # Skip comments
+        when line =~ /(\w+) \{/        # Block starts as "define host {"
+          block = {}
+          handler = $1.to_sym
+        when line =~ /\}/              # End of block
+          #
+          # Process it. Each block type has line <type>_name in the definition: host_name, command_name
+          #
+          @objects[handler] ||= {}
+          @objects[handler][block["#{handler.to_s}_name".to_sym]] = block 
+          block = { }
+       when line =~ /^\s*(\w+)\s+([^\{\}]+)$/  # Build Hash from key-value pairs like: "max_check_attempts      10"
+          block[$1.to_sym] = $2.strip
+        end
+      end
+
+      # Create instance methods for easy access to properties
+      @objects.each do |key,val|
+        instance_variable_set("@#{key}", val)
+        instance_eval "def #{key}; return #{val}; end"
+      end
+      self
+    end
+
+    # Basic find function for resources.
+    # @param [Symbol] resource Resource to search from: :host, :hostgroup, etc.
+    # @param [Symbol] attribute Attribute to use in search. For example, find host by hostname or address, etc. anything that's defined for this resource
+    # @param [Symbol] message  Is either 'find' or 'find_all' passed from caller. In case of 'find' returns 1 hash, 'find_all' - Array of Hash'es.
+    # @param [String] or [Regexp] pattern Search pattern
+    
+    def find resource, message, attribute, pattern
+      self.send(resource.to_sym).values.send(message) do |a| 
+        case pattern
+        when String
+          a[attribute.to_sym] == pattern
+        when Regexp
+          a[attribute.to_sym] =~ pattern
+        else
+          raise 'Unknown pattern for search'
+        end
+        
+      end
+    end
+
+    # Replace standard +method_missing+ with dynamic search methods. Calls internally self.find.
+    #
+    # @see find
+    #
+    # @param [Symbol] sym Should be in the form
+    #     find(_all)?_<resource>_by_<attribute>. Similar to
+    #     ActiveResource find_* dynamic methods. Depending on the name
+    #     of the mthod called (find or find_all) will pass message to
+    #     self.find method, that will call {Array.find} or
+    #     {Array.find_all} accordingly.
+    #
+    # find_*_by and find_all_*. find_all returns Array of
+    # hashes. 
+
+    def method_missing sym, *args, &block
+      raise(NoMethodError, "No such method #{sym.to_s} for #{self.class}") unless sym.to_s =~ /^(find(_all)?)_(.*)_by_(.*)$/
+      # message - either 'find' of 'find_all'
+      # resource - type of objects to search: host, hostgroup etc.
+      # attribute - name of the attribute to do search by: :host_name, :check_command
+      # @param *args String or Regexp to search objects
+      message,resource,attribute  = $1, $3, $4
+
+      self.find resource,message,attribute,args[0]
+    end
+
+  end
+end
+

data/ruby-nagios.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'ruby-nagios'
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.author = 'R.I.Pienaar'
   s.email = 'rip@devco.net'
   s.homepage = 'http://devco.net/'

metadata

@@ -1,88 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-nagios
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-18 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &4747960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *4747960
 description: Manage alerts, checks and acks in bulk
 email: rip@devco.net
-executables: 
+executables:
 - check_check
 - nagsrv
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
 - COPYING
-- README
+- README.md
 - Rakefile
 - bin/check_check
 - bin/nagsrv
+- lib/nagios.rb
+- lib/nagios/config.rb
+- lib/nagios/objects.rb
 - lib/nagios/status.rb
-- pkg/ruby-nagios-0.0.1.gem
 - ruby-nagios.gemspec
-has_rdoc: true
 homepage: http://devco.net/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby library for managing Nagios
 test_files: []
-

data/README

@@ -1,5 +0,0 @@
-Have you ever had to disable alerts, retry a check or acknowledge outages on a large amount of services with Nagios and hated the web UI for it?
-
-This is a CLI tool and Ruby library that parses your status log file and let you query it for information or create external commands to be piped into the nagios command file.
-
-See http://code.google.com/p/ruby-nagios/ for more information