nagios_mklivestatus 0.0.1

data/README

@@ -0,0 +1,21 @@
+In order to use the gem, you have to install it into your rubygem environment.
+
+gem install nagios_maklivestatus
+
+To integrate it in your applications, it can be done just by adding the two following lines :
+
+require 'rubygems'
+require 'nagios_mklivestatus'
+
+And to query the mklivestatus :
+
+mklivesocket = Nagios::MkLiveStatus.new(path)
+mklivesocket.query(mkliveQuery)
+
+Please refer to the rdoc in order to have a complete description of each class.
+
+TODO:
+	- managing exceptions throws by the socket
+	- controlling livestatus query validity
+	- adding OR and AND query filter support
+	- adding support to http

data/lib/nagios_mklivestatus.rb

@@ -0,0 +1,147 @@
+# This module holds the definition of the class used to query Nagios MkLiveStatus
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2011 GIP RECIA
+# License::   General Public Licence
+module Nagios
+  # This class is used to create and querying a socket
+  # It accepts the following socket:
+  # * TCP : new("tcp://<host>:<port>")
+  # * Unix : new("/var/lib/nagios/rw/live") 
+  #
+  # Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+  # Copyright:: Copyright (c) 2011 GIP RECIA
+  # License::   General Public Licence
+  class MkLiveStatus
+    
+    require File.dirname(__FILE__)+'/nagios_mklivestatus/query'
+    require 'socket'
+    
+    # path informations of nagios sockets
+    @mk_livestatus_socket_path=""
+    
+    # type of the socket
+    @mk_livestatus_socket_type=""
+    
+    #debug mode : default to false
+    @debug = false
+  
+    # Initialize the nagios mklivestatus socket informations.
+    #
+    # Two type of socket are supported for now:
+    # * TCP : path equal to "tcp://<host>:<port>"
+    # * File : where path is the path to the file
+    #
+    # If debug is set to true it will indicates the information used for the socket 
+    # and the query and result of each queries call
+    def initialize(path,debug=false)
+      
+      #set debug mode
+      if debug
+        @debug = true
+      end
+      
+      puts ""
+      #check socket type
+      # if the path start with tcp:// => tcp socket
+      if path.strip.start_with?("tcp://")
+        tmp = path[6,path.length]
+        table = tmp.partition(":")
+        @mk_livestatus_socket_type = "tcp"
+        @mk_livestatus_socket_path = Hash.new
+        @mk_livestatus_socket_path[:ip] = table[0]
+        @mk_livestatus_socket_path[:port] = table[2]
+        
+        puts "type : "+@mk_livestatus_socket_type if @debug
+        puts "ip : "+@mk_livestatus_socket_path[:ip] if @debug
+        puts "port : "+@mk_livestatus_socket_path[:port] if @debug
+      # default socket type is set to file
+      elsif File.exists? path
+        @mk_livestatus_socket_path = path
+        @mk_livestatus_socket_type = "file"
+        
+        puts "type : "+@mk_livestatus_socket_type if @debug
+        puts "file : "+@mk_livestatus_socket_path if @debug
+      end
+    end
+    
+    # The method opens the socket and send the query then return the response of nagios
+    # 
+    # The query parameter must be set and be a string reprensting the MKLiveStatus Query :
+    #  GET hosts
+    # or
+    #  GET hosts
+    #  Columns: host_name
+    #  Filter: host_name ~ test
+    #  ....
+    #
+    def query(query=nil)
+      
+      socket=nil
+      
+      puts ""
+      #open socket depending on the type of connection
+      case @mk_livestatus_socket_type
+        when "tcp"
+          socket=TCPSocket.open(@mk_livestatus_socket_path[:ip], @mk_livestatus_socket_path[:port])
+          puts "Ouverture du socket TCP : "+@mk_livestatus_socket_path[:ip]+" "+@mk_livestatus_socket_path[:port] if @debug
+        when "file"
+          socket=UNIXSocket.open(@mk_livestatus_socket_path)
+          puts "Ouverture du socket Unix : "+@mk_livestatus_socket_path if @debug
+      end
+      
+      #if socket is generated and query exists
+      if socket != nil and query != nil and query.to_s.upcase.start_with?("GET ")
+        
+        strQuery = query.to_s 
+        #the endline must be empty
+        if not strQuery.end_with?("\n")
+          strQuery << "\n"
+        end
+        
+        puts ""
+        puts "---" if @debug
+        puts strQuery if @debug
+        puts "---" if @debug
+        
+        # set response header to 16
+        strQuery << "ResponseHeader: fixed16\n"
+        
+        # query the socket
+        socket.puts strQuery
+        
+        # close the socket
+        socket.shutdown(Socket::SHUT_WR)
+        
+        # check data reception
+        recieving = socket.recv(16)
+        check_receiving_error recieving
+        
+        # get all the line of the socket
+        response = ""
+        while(line = socket.gets) do
+          response << line
+        end
+        
+        puts response if @debug
+        
+        return response
+        
+      end
+      
+    end
+    
+private
+    # Check if the recived datas have a status code greater than 200.
+    # If the case is matched then we raise an exception in order to stop the process
+    #
+    # datas : from socket.recv
+    def check_receiving_error( datas )
+      error_code = datas.split(" ")[0].to_i
+      if error_code > 200
+        raise Exception, "Nagios::MkLiveStatus.query return an error_code #{error_code}"
+      end
+    end  
+
+  end
+end

data/lib/nagios_mklivestatus/query.rb

@@ -0,0 +1,82 @@
+# This class is used to create a nagios mklivestatus query
+# * get : is the object we are looking for
+# * columns : are the fields we need from the object
+# * filters : are the filters applied to the query
+#
+# By default the query get all the columns of the object without filter.
+# If you add any columns or filter they will take place in the query
+#
+# Author::    Esco-lan Team  (mailto:team@esco-lan.org)
+# Copyright:: Copyright (c) 2011 GIP RECIA
+# License::   General Public Licence
+class Nagios::MkLiveStatus::Query
+  
+  @get=nil
+  @columns=nil
+  @filters=nil
+  
+  # Constructor of the Query instance
+  # base is by default nil but if its filled the base if associated to the GET of the query
+  def initialize(base=nil)
+    get(base)
+  end
+  
+  # Get method is used to set the object to search for in nagios mklivestatus
+  def get(get)
+    if get != nil and not get.empty?
+      @get = get
+    end
+  end
+  
+  # Add a field to get in the query for the GET object
+  def addColumn(name)
+    if not name == nil or name.empty?
+      if @columns == nil
+        @columns=Array.new
+      end
+      
+      @columns.push(name)
+    end
+  end
+  
+  # Add a filter to the query
+  def addFilter(expression)
+    if not expression == nil or expression.empty?
+      if @filters == nil
+        @filters=Array.new
+      end
+      
+      @filters.push(expression)
+    end
+  end
+  
+  #short cut to the method to_socket
+  def to_s
+    return to_socket
+  end
+  
+  # method used to generate the query from the field
+  # if get is not set then the method return an empty string
+  def to_socket
+    query = String.new
+    if @get != nil
+      query << "GET "+@get+"\n"
+      
+      if @columns != nil and @columns.length > 0
+        query << "Columns:"
+        @columns.each do |column|
+          query << " "+column
+        end
+        query << "\n"
+      end
+      
+      if @filters != nil and @filters.length > 0
+        @filters.each do |filter|
+          query << "Filter: "+filter+"\n"
+        end
+      end
+    end
+    
+    return query
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: nagios_mklivestatus
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Esco-lan Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-02 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Querying Nagios MKLiveStatus through TCP or Unix sockets
+email: team@esco-lan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/nagios_mklivestatus.rb
+- lib/nagios_mklivestatus/query.rb
+- README
+has_rdoc: true
+homepage: http://blogs.cocoondev.org/crafterm/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Querying Nagios MKLiveStatus through sockets TCP or Unix
+test_files: []
+