zabbix-ruby-client 0.0.17 → 0.0.18

data/.gitignore

@@ -12,3 +12,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.settings

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Zabbbix Ruby Client Changelog
 -----------------------------
 
+### v0.0.18 - 2013-12-13
+
+* total fix on CPU usage plugin
+* added a postgres plugin (per database)
+* refactoring of plugins
+* fixed typo on count of start processes in apache plugin
+* made plugin collection optional, so you can have a plugin for only discovery
+* more tests and coverage
+
 ### v0.0.17 - 2013-10-31
 
 * bugfix on requires

data/README.md

@@ -91,10 +91,13 @@ There are a set of standart plugins included in the package, aimed at linux syst
   * sysinfo (uses uname -a) is populating the host info in the inventory, and should be ran at setup and/or monthly [sysinfo_tpl](master/zabbix-templates/sysinfo_tpl.xml)
 * apache (depends on mod_status with status_extended on) [apache_tpl](master/zabbix-templates/apache_tpl.xml)
 * mysql (uses mysqladmin extended-status) [mysql_tpl](master/zabbix-templates/mysql_tpl.xml)
+* postgres (uses psql and pg_stat_database) [postgres_tpl](master/zabbix-templates/postgres_tpl.xml)
+  * best is to use a .pgpass file see http://www.postgresql.org/docs/9.0/interactive/libpq-pgpass.html
 * nginx (requires httpStubStatus nginx module) [nginx_tpl](master/zabbix-templates/nginx_tpl.xml)
 * redis (uses redis-cli info) [redis_tpl](master/zabbix-templates/redis_tpl.xml)
   * args [ "/path/to/redis-cli", "options to connect" ]
 
+
 You can add extra plugins in a plugins/ dir in the working dir, just by copying one of the existing plugins in the repo and change to your need. All plugins present in plugins/ will be loaded if present in the config file you use. That can be convenient to test by using the -t flag, for example `bundle exec zrc -t testplugin.yml` where testplugin.yml only contains the name and args for yoiur plugin.
 
 ## Custom plugins how-to
@@ -159,7 +162,7 @@ I first created on both sides an autossh user with no console and no password:
 sudo useradd -m -r -s /bin/false -d /usr/local/zabtunnel zabtunnel
 ```
 
-On the zabbix server I created a key that I transfered to the clients in `/usr/local/zabtunnel/,ssh/authorized_keys`
+On the zabbix server I created a key that I transfered to the clients in `/usr/local/zabtunnel/.ssh/authorized_keys`
 
 ```
 sudo su -s /bin/bash - zabtunnel
@@ -197,25 +200,19 @@ ListenIP 127.0.0.1
 
 ## Todo
 
-* read /proc rather than rely on installed tools (done)
-* write tests
+* improve templates for graphs
 * add more plugins
   * memcache
-  * redis
   * mysql master/slave
+  * postgres replication
   * monit
   * passenger
-  * nginx (done)
   * logged users
   * denyhosts
   * postfix
   * sendgrid
   * airbrake
-  * disk occupation (done)
 * try to work out a way to create host/graphs/alerts from the client using Zabbix API
-* verify compatibility with ruby 1.9 (done)
-* create a resend system that will store timed data on client if connection to server fails, and will send pending (missed) data on next batch.
-
 
 ## Contributing
 

data/lib/zabbix-ruby-client/data.rb

@@ -11,18 +11,20 @@ module ZabbixRubyClient
     end
 
     def run_plugin(plugin, args = nil)
-      Plugins.load(plugin) || logger.error( "Plugin #{plugin} not found.")
+      Plugins.load(plugin) || ZabbixRubyClient::Log.error( "Plugin #{plugin} not found.")
       if Plugins.loaded[plugin]
         begin
-          @items += Plugins.loaded[plugin].send(:collect, @host, *args)
+          if Plugins.loaded[plugin].respond_to?(:collect)
+            @items += Plugins.loaded[plugin].send(:collect, @host, *args)
+          end
           if Plugins.loaded[plugin].respond_to?(:discover)
             key, value = Plugins.loaded[plugin].send(:discover, *args)
             @discover[key] ||= []
             @discover[key] << [ value ]
           end
         rescue Exception => e
-          Log.fatal "Oops"
-          Log.fatal e.message
+          ZabbixRubyClient::Log.fatal "Oops"
+          ZabbixRubyClient::Log.fatal e.message
         end
       end
     end

data/lib/zabbix-ruby-client/plugin_base.rb

@@ -0,0 +1,41 @@
+require "zabbix-ruby-client/logger"
+
+module ZabbixRubyClient
+  module PluginBase
+    extend self
+
+    def httprequest(url)
+    end
+
+    def perform(command)
+    end
+
+    def getline(file, pattern=false)
+      if File.readable? file
+        File.open(file,'r') do |f|
+          f.each do |l|
+            line = l.strip
+            if pattern
+              if Regexp.new(pattern).match line
+                Log.debug "File #{file}: #{line}"
+                return line
+              end
+            else
+              return line
+            end
+          end
+        end
+        Log.warn "File #{file}: pattern \"#{pattern}\" not found."
+        false
+      else
+        if File.file? file
+          Log.error "File not readable: #{file}"
+        else
+          Log.error "File not found: #{file}"
+        end
+        false
+      end
+    end
+
+  end
+end

data/lib/zabbix-ruby-client/plugins/apache.rb

@@ -32,7 +32,7 @@ module ZabbixRubyClient
         back << "#{host} apache[c_log] #{time} #{ret["Score"]["L"]}"
         back << "#{host} apache[c_read] #{time} #{ret["Score"]["R"]}"
         back << "#{host} apache[c_send] #{time} #{ret["Score"]["W"]}"
-        back << "#{host} apache[c_start] #{time}#{ret["Score"]["S"]}"
+        back << "#{host} apache[c_start] #{time} #{ret["Score"]["S"]}"
         return back
       end
 

data/lib/zabbix-ruby-client/plugins/apt.rb

@@ -7,19 +7,41 @@ module ZabbixRubyClient
 
       def collect(*args)
         host = args[0]
-        aptcheck = `/usr/lib/update-notifier/apt-check 2>&1`
-        if $?.to_i == 0
-          security, pending = aptcheck.split(/;/).map(&:to_i)
+        info = get_info
+        if info
+          time = Time.now.to_i
+          back = []
+          back << "#{host} apt[security] #{time} #{info[0]}"
+          back << "#{host} apt[pending] #{time} #{info[1]}"
+          back << "#{host} apt[status] #{time} TODO apt #{info[0]}/#{info[1]}"
+          return back
         else
-          Log.warn "Are you running on ubuntu ?"
           return []
         end
-        time = Time.now.to_i
-        back = []
-        back << "#{host} apt[security] #{time} #{security}"
-        back << "#{host} apt[pending] #{time} #{pending}"
-        back << "#{host} apt[status] #{time} TODO apt #{security}/#{pending}"
-        return back
+      end
+
+    private
+
+      def get_info
+        info = aptinfo
+        if info
+          back = info.split(/;/).map(&:to_i)
+          back
+        else
+          false
+        end
+      end
+
+      def aptinfo
+        output = `/usr/lib/update-notifier/apt-check 2>&1`
+        if $?.to_i == 0
+          Log.debug self
+          Log.debug output
+          output
+        else
+          Log.warn "Oh you don't have apt ?"
+          false
+        end
       end
 
     end

data/lib/zabbix-ruby-client/plugins/cpu.rb

@@ -1,4 +1,4 @@
-# for more info check 
+# for more info check
 # http://www.linuxhowtos.org/System/procstat.htm
 # http://juliano.info/en/Blog:Memory_Leak/Understanding_the_Linux_load_average
 require "zabbix-ruby-client/logger"
@@ -7,34 +7,43 @@ module ZabbixRubyClient
   module Plugins
     module Cpu
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]
-        cpuinfo = `cat /proc/stat | grep "^cpu"`
-        if $?.to_i == 0
-          _, user, nice, sys, idle, wait, irq, soft, guest, steal = cpuinfo.split(/\s+/).map(&:to_i)
-        else
-          Log.warn "Oh you don't have a /proc ?"
-          return []
+        info = get_info
+        back = []
+        if info
+          time = Time.now.to_i
+          info.each do |k,v|
+            back << "#{host} cpu[#{k}] #{time} #{v}"
+          end
         end
-        used = user + nice + sys
-        total = used + idle
+        back
+      end
 
-        time = Time.now.to_i
-        back = []
-        back << "#{host} cpu[user] #{time} #{user}"
-        back << "#{host} cpu[nice] #{time} #{nice}"
-        back << "#{host} cpu[system] #{time} #{sys}"
-        back << "#{host} cpu[iowait] #{time} #{wait}"
-        back << "#{host} cpu[irq] #{time} #{irq}"
-        back << "#{host} cpu[soft] #{time} #{soft}"
-        back << "#{host} cpu[steal] #{time} #{steal}"
-        back << "#{host} cpu[guest] #{time} #{guest}"
-        back << "#{host} cpu[idle] #{time} #{idle}"
-        back << "#{host} cpu[used] #{time} #{used}"
-        back << "#{host} cpu[total] #{time} #{total}"
-        return back
+    private
 
+      def get_info
+        ret = {}
+        info = getline("/proc/stat", "^cpu ")
+        if info
+          back = info.split(/\s+/).map(&:to_i)
+          ret["user"] = back[1]
+          ret["nice"] = back[2]
+          ret["system"] = back[3]
+          ret["idle"] = back[4]
+          ret["iowait"] = back[5]
+          ret["irq"] = back[6]
+          ret["soft"] = back[7]
+          ret["steal"] = back[8] || 0
+          ret["guest"] = back[9] || 0
+          ret["used"] = back[1...4].reduce(&:+)
+          ret["total"] = back[1...9].reduce(&:+)
+          ret
+        else
+          false
+        end
       end
 
     end

data/lib/zabbix-ruby-client/plugins/disk.rb

@@ -2,48 +2,37 @@
 # http://www.xaprb.com/blog/2010/01/09/how-linux-iostat-computes-its-results/
 # http://www.mjmwired.net/kernel/Documentation/iostats.txt
 require "zabbix-ruby-client/logger"
+require "zabbix-ruby-client/plugin_base"
 
 module ZabbixRubyClient
   module Plugins
     module Disk
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]
         dev = args[1]
         mapped = args[3] || dev
-        diskspace = `df | grep "#{mapped}"`
-        if $?.to_i == 0
-          _, size, used, available, percent_used, mount = diskspace.split(/\s+/)
-        else
-          Log.error "df is not working... ouchie."
-          return []
-        end
-        time = Time.now.to_i
-        back = []
-        back << "#{host} disk.space[#{mapped},size] #{time} #{size.to_i * 1000}"
-        back << "#{host} disk.space[#{mapped},used] #{time} #{used.to_i * 1000}"
-        back << "#{host} disk.space[#{mapped},available] #{time} #{available.to_i * 1000}"
-        back << "#{host} disk.space[#{mapped},percent_used] #{time} #{percent_used.gsub(/%/,'')}"
-
-        if dev != ""
-          diskinfo = `cat /proc/diskstats | grep " #{dev} "`
-          if $?.to_i == 0
-            _, _, _, _, read_ok, read_merged, read_sector, read_time, write_ok, write_merged, write_sector, write_time, io_current, io_time, io_weighted = diskinfo.split(/\s+/)
-          else
-            logger.warn "Oh there is no such device."
-            return []
-          end
-          back << "#{host} disk.io[#{mapped},read_ok] #{time} #{read_ok}"
-          back << "#{host} disk.io[#{mapped},read_merged] #{time} #{read_merged}"
-          back << "#{host} disk.io[#{mapped},read_sector] #{time} #{read_sector}"
-          back << "#{host} disk.io[#{mapped},read_time] #{time} #{read_time}"
-          back << "#{host} disk.io[#{mapped},write_ok] #{time} #{write_ok}"
-          back << "#{host} disk.io[#{mapped},write_merged] #{time} #{write_merged}"
-          back << "#{host} disk.io[#{mapped},write_sector] #{time} #{write_sector}"
-          back << "#{host} disk.io[#{mapped},write_time] #{time} #{write_time}"
-          back << "#{host} disk.io[#{mapped},io_time] #{time} #{io_time}"
-          back << "#{host} disk.io[#{mapped},io_weighted] #{time} #{io_weighted}"
+
+        info = get_info(dev, mapped)
+        if info
+          time = Time.now.to_i
+          back = []
+          back << "#{host} disk.space[#{mapped},size] #{time} #{info[1].to_i * 1000}"
+          back << "#{host} disk.space[#{mapped},used] #{time} #{info[2].to_i * 1000}"
+          back << "#{host} disk.space[#{mapped},available] #{time} #{info[3].to_i * 1000}"
+          back << "#{host} disk.space[#{mapped},percent_used] #{time} #{info[4].gsub(/%/,'')}"
+          back << "#{host} disk.io[#{mapped},read_ok] #{time} #{info[9]}"
+          back << "#{host} disk.io[#{mapped},read_merged] #{time} #{info[10]}"
+          back << "#{host} disk.io[#{mapped},read_sector] #{time} #{info[11]}"
+          back << "#{host} disk.io[#{mapped},read_time] #{time} #{info[12]}"
+          back << "#{host} disk.io[#{mapped},write_ok] #{time} #{info[13]}"
+          back << "#{host} disk.io[#{mapped},write_merged] #{time} #{info[14]}"
+          back << "#{host} disk.io[#{mapped},write_sector] #{time} #{info[15]}"
+          back << "#{host} disk.io[#{mapped},write_time] #{time} #{info[16]}"
+          back << "#{host} disk.io[#{mapped},io_time] #{time} #{info[17]}"
+          back << "#{host} disk.io[#{mapped},io_weighted] #{time} #{info[18]}"
         end
         return back
       end
@@ -52,7 +41,37 @@ module ZabbixRubyClient
         device = args[0]
         mount = args[1]
         mapped = args[2] || device
-        [ "disk.dev.discovery", "{\"{#DISK_DEVICE}\": \"#{mapped}\", \"{#DISK_MOUNT}\": \"#{mount}\"}" ]
+        [ "disk.dev.discovery", 
+          "{\"{#DISK_DEVICE}\": \"#{mapped}\", \"{#DISK_MOUNT}\": \"#{mount}\"}" 
+        ]
+      end
+
+    private
+
+      def get_info(disk, device)
+        info = diskinfo(disk)
+        if info
+          back = info.split(/\s+/)
+          io = getline("/proc/diskstats", " #{device} ")
+          if io
+            back += io.split(/\s+/)
+          end
+          back
+        else
+          false
+        end
+      end
+
+      def diskinfo(disk)
+        output = `df | grep "#{disk}"`
+        if $?.to_i == 0
+          Log.debug self
+          Log.debug output
+          output
+        else
+          Log.warn "Oh there is no such device."
+          false
+        end
       end
 
     end

data/lib/zabbix-ruby-client/plugins/load.rb

@@ -1,33 +1,40 @@
 # for more info check 
 # http://juliano.info/en/Blog:Memory_Leak/Understanding_the_Linux_load_average
-require "zabbix-ruby-client/logger"
+require "zabbix-ruby-client/plugin_base"
 
 module ZabbixRubyClient
   module Plugins
     module Load
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]
-        #cpuinfo = `mpstat | grep " all "`
-        cpuinfo = `cat /proc/loadavg`
-        if $?.to_i == 0
-          one, five, fifteen, procs_t = cpuinfo.split(/\s+/)
+        info = get_info
+        if info
+          time = Time.now.to_i
+          back = []
+          back << "#{host} load[one] #{time} #{info[0]}"
+          back << "#{host} load[five] #{time} #{info[1]}"
+          back << "#{host} load[fifteen] #{time} #{info[2]}"
+          back << "#{host} load[procs] #{time} #{info[3]}"
+          return back
         else
-          Log.warn "Oh you don't have a /proc ?"
           return []
         end
+      end
 
-        procs, _ = procs_t.split(/\//)
-
-        time = Time.now.to_i
-        back = []
-        back << "#{host} load[one] #{time} #{one}"
-        back << "#{host} load[five] #{time} #{five}"
-        back << "#{host} load[fifteen] #{time} #{fifteen}"
-        back << "#{host} load[procs] #{time} #{procs}"
-        return back
+    private
 
+      def get_info
+        info = getline("/proc/loadavg")
+        if info
+          back = info.split(/\s+/)
+          back[3] = back[3].split(/\//)[0]
+          back
+        else
+          false
+        end
       end
 
     end

data/lib/zabbix-ruby-client/plugins/memory.rb

@@ -1,49 +1,71 @@
 require "zabbix-ruby-client/logger"
+require "zabbix-ruby-client/plugin_base"
 
 module ZabbixRubyClient
   module Plugins
     module Memory
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]
-        meminfo = `cat /proc/meminfo`
-        if $?.to_i == 0
-          info = splitinfo(meminfo)
+        info = get_info
+        if info
+          time = Time.now.to_i
+          back = []
+          back << "#{host} memory[total] #{time} #{info['MemTotal']}"
+          back << "#{host} memory[free] #{time} #{info['MemFree']}"
+          back << "#{host} memory[used] #{time} #{info['MemUsed']}"
+          back << "#{host} memory[percent_used] #{time} #{info['MemPercent']}"
+          back << "#{host} memory[swap_total] #{time} #{info['SwapTotal']}"
+          back << "#{host} memory[swap_free] #{time} #{info['SwapFree']}"
+          back << "#{host} memory[swap_used] #{time} #{info['SwapUsed']}"
+          back << "#{host} memory[swap_percent_used] #{time} #{info['SwapPercent']}"
+          return back
         else
-          Log.warn "Please install sysstat."
           return []
         end
+      end
 
-        mem_total = info["MemTotal"] * 1024
-        mem_free = (info['MemFree'] + info['Buffers'] + info['Cached']) * 1024
-        mem_used = mem_total - mem_free
-        mem_percent = (mem_used / mem_total.to_f * 100).to_i
-        swap_total = info['SwapTotal'] * 1024
-        swap_free = info['SwapFree'] * 1024
-        swap_used = swap_total - swap_free
-        swap_percent = 0
-        unless swap_total == 0
-          swap_percent = (swap_used / swap_total.to_f * 100).to_i
+    private
+
+      def get_info
+        info = meminfo
+        if info
+          back = splitinfo(info)
+          back["MemTotal"] = back["MemTotal"] * 1024
+          back["MemFree"] = (back['MemFree'] + back['Buffers'] + back['Cached']) * 1024
+          back["MemUsed"] = back["MemTotal"] - back["MemFree"]
+          back["MemPercent"] = (back["MemUsed"] / back["MemTotal"].to_f * 100).to_i
+          back['SwapTotal'] = back['SwapTotal'] * 1024
+          back['SwapFree'] = back['SwapFree'] * 1024
+          back['SwapUsed'] = back['SwapTotal'] - back['SwapFree']
+          back['SwapPercent'] = 0
+          unless back['SwapTotal'] == 0
+            back['SwapPercent'] = (back['SwapUsed'] / back['SwapTotal'].to_f * 100).to_i
+          end
+          back
+        else
+          false
         end
+      end
 
-        time = Time.now.to_i
-        back = []
-        back << "#{host} memory[total] #{time} #{mem_total}"
-        back << "#{host} memory[used] #{time} #{mem_used}"
-        back << "#{host} memory[free] #{time} #{mem_free}"
-        back << "#{host} memory[percent_used] #{time} #{mem_percent}"
-        back << "#{host} memory[swap_total] #{time} #{swap_total}"
-        back << "#{host} memory[swap_used] #{time} #{swap_used}"
-        back << "#{host} memory[swap_free] #{time} #{swap_free}"
-        back << "#{host} memory[swap_percent_used] #{time} #{swap_percent}"
-        return back
+      def meminfo
+        output = `cat /proc/meminfo`
+        if $?.to_i == 0
+          Log.debug self
+          Log.debug output
+          output
+        else
+          Log.warn "Oh there is no such device."
+          false
+        end
       end
 
       def splitinfo(info)
         info.split(/\n/).map(&:strip).reduce({}) do |a,line|
           _, key, value = *line.match(/^(\w+):\s+(\d+)\s/)
-          a[key] = value.to_i
+          a[key] = value.to_i if key
           a
         end
       end