zabbix_agent 0.1

data/README

@@ -0,0 +1,41 @@
+Zabbix Ruby agent readme
+
+This is a pure Ruby implementation of the Zabbix agent.  The agent supports
+both the 1.1 and 1.4 (default) agent protocols.  Presently the agent only
+supports passive connections.  The agent is multi threaded and will spawn a new
+thread for each incoming connection.  After a timeout period (default 30s) the
+thread will be killed and the associated socket closed.  Effort has been made
+to make the agent itself thread safe, however the agent makes no effort to
+ensure the functions it calls are thread safe.  Thus it is important that the
+end user be aware they are responsible for their functions being thread safe.
+
+Required Gems:
+bit-struct
+
+Use:
+Use of the agent is pretty straight forward.
+
+agent = ZabbixAgent.new(nil,10060)
+
+This will instantiate a new agent listening on all interfaces on port 10060.
+The key thing to note is that this will not start the agent's main thread.
+
+agent.register("myfunc",self.method(:myfunc))
+
+This will register a new key/item with the agent.  Behind the scenes all keys
+are stored in a Hash which in turn is used to look up which function to call,
+the resul from this function called is then passed back to the Zabbix server.
+The return value must be in string format.  The function will be passed
+whatever arguments were received from the Zabbix server, for instance if the
+agent received the following from the server:
+myfunc[1,2,"str"]
+A string of '1,2,3,"str"' would be passed to the function.
+
+Starting the agent is as simple as:
+agent.start
+
+This method will return as it will spawn two threads, the main loop and the
+watchdog.
+
+After the agent has started it is possible to register more items dynamically.
+The item zbx_available will return the current list of items the agent supports.

data/zabbix_agent.rb

@@ -0,0 +1,238 @@
+#!/usr/bin/ruby
+
+#License:: GPL 2.0  http://www.gnu.org/licenses/gpl-2.0.html
+#Copyright:: Copyright (C) 2009,2010 Andrew Nelson nelsonab(at)red-tux(dot)net
+#
+#This program is free software; you can redistribute it and/or
+#modify it under the terms of the GNU General Public License
+#as published by the Free Software Foundation; either version 2
+#of the License, or (at your option) any later version.
+#
+#This program is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#GNU General Public License for more details.
+#
+#You should have received a copy of the GNU General Public License
+#along with this program; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+version_header = <<EOF
+##########################################
+# Subversion information
+# $Id: zabbix_agent.rb 228 2010-10-13 06:23:18Z nelsonab $
+# $Revision: 228 $
+##########################################
+EOF
+
+REVISION=version_header.split("\n")[3].split[2]
+
+require 'rubygems'
+require 'thread'
+require 'socket'
+
+require 'bit-struct'
+
+#Class for holding the 1.4 protocol header
+class ZBX_14 < BitStruct
+  char :header, 32, "Zabbix Header"
+  unsigned :version, 8, "Protocol Version"
+  unsigned :length, 64, :endian=>:little
+  rest :data, "Data"
+
+  initial_value.header='ZBXD'
+  initial_value.version=1
+
+  def set_data(data)
+    self.data=data
+    self.length=data.length
+  end
+
+  alias initialize_orig initialize
+
+  def initialize(data)
+    initialize_orig
+    set_data(data)
+  end
+end
+
+class WorkerThread < Thread
+  attr_reader :starttime
+
+  def initialize(*args)
+    @starttime=Time.now.to_i
+    @socket=nil
+    args.each {|item|
+      @socket = item if item.class==TCPSocket
+    }
+
+    raise "No TCP Socket Found!" if @socket.nil?
+
+    super(*args)
+  end
+
+  def kill
+    @socket.close  #This will generate an IOError in the thread
+    super
+  end
+end
+
+class ZabbixAgent
+
+  attr_accessor :thread_timeout, :watchdog_sleep_timer
+  
+  #Intialize the port and address to listen on
+  #address is the address on the local host to listen to
+  #port is the port on the local host to listen to
+  #protocol_version is one of the following:
+  # :ver1_1, :ver1_4
+  # This denotes the protocol version to be used when sending the data back.
+  # Version 1.4 is the default
+  def initialize(address,port,protocol_version=:ver1_4)
+    @proto_ver=protocol_version
+    @socket = TCPServer.open(address,port)
+
+    @functions_mutex = Mutex.new
+    @workers_mutex = Mutex.new
+
+    @thread_timeout=30
+    @watchdog_sleep_timer=1
+
+    #setup internal variables
+    @functions={}  #Hash of function callbacks key(str):function(method)
+
+    register("agent.version",self.method(:version))
+    register("zbx_available",self.method(:show_avail))
+  end
+
+  #setup the main listener thread
+  #This function will return the thread created
+  def start
+    @workers=[]
+    @main_thread = Thread.new do
+      main
+      puts "Main thread quit"
+    end
+    @watchdog_thread = Thread.new do watchdog end
+  end
+
+  #this is the main loop for the thread.
+  def main
+    #When a connection comes in, get the string and send it to the dispatcher
+    #which will then take care of the request and then go back to listening
+    #for a new connection
+    #This agent will not spawn new threads for each incoming connection.
+    loop do
+      t = WorkerThread.new(@socket.accept) {|session|
+        worker_method(session)
+      }
+      @workers_mutex.synchronize {
+        @workers+=[t]
+      }
+    end
+  end
+
+  def watchdog
+    loop do
+      @workers_mutex.synchronize {
+        @workers.each {|thread|
+          if thread.status==false
+            @workers.delete(thread)  # Thread died of natural causes, we don't need to track it anymore
+          elsif thread.starttime < Time.now.to_i-@thread_timeout
+            puts "Killing #{thread} due to timeout"
+            thread.kill
+            @workers.delete(thread)
+          end
+        }
+      }
+      sleep @watchdog_sleep_timer
+    end
+  end
+
+  def worker_method(session)
+    puts "starting socket #{session}"
+    begin
+      str=session.gets
+      dispatch(str,session)
+      session.close
+    rescue IOError
+      #IO Errors are likely due to the thread being killed.  If there was a better way to
+      #trap this I would rather use it.
+    end
+  end
+
+  def output11(socket,data)
+    socket.print data
+  end
+
+  def output14(socket,data)
+    zbx=ZBX_14.new(data)
+    socket.send(zbx,0)
+  end
+
+  #Registers a method with the agent.
+  #key is of type string, function is of class method
+  #When the key is received, the function is called with the arguments from
+  #the Zabbix server and is expected to return the value to be sent
+  #The class initializer contains a reference to the use of this function
+  #The
+  def register(key,function)
+    @functions_mutex.synchronize {
+      @functions.merge!({key,function})
+    }
+  end
+
+  def version(args)
+    return "Ruby Zabbix agent svn revision:#{REVISION}"
+  end
+
+  def show_avail(args)
+    retval=""
+    p @functions
+    @functions.each_key do |key|
+      retval += "#{key}\n"
+    end
+    p retval
+    return retval
+  end
+
+  def dispatch(str,socket)
+    matches = (str =~ /(\S+)\[(\S+)\]|(\S+)/)
+    if $1.nil?
+      func=$3
+      arg=nil
+    else
+      func=$1
+      arg=$2
+    end
+    if @functions.has_key?(func)
+      retval=nil
+      @functions_mutex.synchronize {
+        retval=@functions[func].call(arg)
+      }
+    else
+      socket.print "ZBX_NOTSUPPORTED"
+      return
+    end
+
+    case @proto_ver
+      when :ver1_1 then output11(socket,retval)
+      when :ver1_4 then output14(socket,retval)
+      else output11(socket,retval)
+    end
+  end
+end
+
+if __FILE__ == $0
+  Thread.abort_on_exception=true
+  
+  agent = ZabbixAgent.new(nil,10060)
+#  agent.thread_timeout=30
+  agent.start
+
+  puts "To quit press ctrl-c"
+  #we need to have an infinate loop for the thread to work.
+  loop do
+    sleep 100
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: zabbix_agent
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- A. Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Class for creating Zabbix agents in Ruby
+email: nelsonab@red-tux.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- zabbix_agent.rb
+- README
+has_rdoc: true
+homepage: http://trac.red-tux.net/
+licenses: 
+- LGPL 2.1
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- .
+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: zabbix_agent
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Class for creating Zabbix agents in Ruby
+test_files: []
+