zabbix-ruby-client 0.0.17 → 0.0.18

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

@@ -1,33 +1,31 @@
 require "zabbix-ruby-client/logger"
+require "zabbix-ruby-client/plugin_base"
 
 module ZabbixRubyClient
   module Plugins
     module Network
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]
         interface = args[1]
-        netinfo = `grep "#{interface}: " /proc/net/dev`
-        if $?.to_i == 0
-          _, _, rx_ok, rx_packets, rx_err, rx_drop, _, _, _, _, tx_ok, tx_packets, tx_err, tx_drop, _, _, _, _  = netinfo.split(/\s+/)
+        info = get_info(interface)
+        if info
+          time = Time.now.to_i
+          back = []
+          back << "#{host} net.rx_ok[#{interface}] #{time} #{info[2]}"
+          back << "#{host} net.rx_packets[#{interface}] #{time} #{info[3]}"
+          back << "#{host} net.rx_err[#{interface}] #{time} #{info[4]}"
+          back << "#{host} net.rx_drop[#{interface}] #{time} #{info[5]}"
+          back << "#{host} net.tx_ok[#{interface}] #{time} #{info[10]}"
+          back << "#{host} net.tx_packets[#{interface}] #{time} #{info[11]}"
+          back << "#{host} net.tx_err[#{interface}] #{time} #{info[12]}"
+          back << "#{host} net.tx_drop[#{interface}] #{time} #{info[13]}"
+          return back
         else
-          Log.warn "proc not found."
           return []
         end
-
-        time = Time.now.to_i
-        back = []
-        back << "#{host} net.rx_ok[#{interface}] #{time} #{rx_ok}"
-        back << "#{host} net.rx_packets[#{interface}] #{time} #{rx_packets}"
-        back << "#{host} net.rx_err[#{interface}] #{time} #{rx_err}"
-        back << "#{host} net.rx_drop[#{interface}] #{time} #{rx_drop}"
-        back << "#{host} net.tx_ok[#{interface}] #{time} #{tx_ok}"
-        back << "#{host} net.tx_packets[#{interface}] #{time} #{tx_packets}"
-        back << "#{host} net.tx_err[#{interface}] #{time} #{tx_err}"
-        back << "#{host} net.tx_drop[#{interface}] #{time} #{tx_drop}"
-        return back
-
       end
 
       def discover(*args)
@@ -35,6 +33,17 @@ module ZabbixRubyClient
         [ "net.if.discovery", "{\"{#NET_IF}\": \"#{interface}\"}" ]
       end
 
+    private
+
+      def get_info(interface)
+        info = getline("/proc/net/dev", "#{interface}: ")
+        if info
+          info.split(/\s+/)
+        else
+          false
+        end
+      end
+      
     end
   end
 end

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

@@ -5,6 +5,7 @@ module ZabbixRubyClient
   module Plugins
     module Nginx
       extend self
+      extend ZabbixRubyClient::PluginBase
 
       def collect(*args)
         host = args[0]

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

@@ -0,0 +1,64 @@
+require "zabbix-ruby-client/logger"
+
+module ZabbixRubyClient
+  module Plugins
+    module Postgres
+      extend self
+
+      def collect(*args)
+        host = args[0]
+        psqlargs = args[1]
+        dbname = args[2]
+        # be sure to have this in the config file
+        # args: [ "-U username -h localhost", "dbname" ]
+        # and setup username in a ~/.pgpass (0600) file for the zrc user
+        # localhost:5432:dbname:username:password
+        psqlstatus = `psql #{psqlargs} -A -t -c "select * from pg_stat_database where datname='#{dbname}'" #{dbname}`
+        if $?.to_i == 0
+          status = get_status(psqlstatus)
+        else
+          Log.warn "The connection failed."
+          return []
+        end
+
+        time = Time.now.to_i
+        back = []
+        status.each do |e,v|
+          back << "#{host} postgres.#{e}[#{dbname}] #{time} #{v}"
+        end
+        return back
+      end
+
+      def discover(*args)
+        dbname = args[1]
+        [ "postgres.db.discovery", "{\"{#DBNAME}\": \"#{dbname}\"}" ]
+      end
+
+      def get_status(status)
+        ret = {}
+        els = status.split "|"
+        ret["numbackends"] = els[2]
+        ret["xact_commit"] = els[3]
+        ret["xact_rollback"] = els[4]
+        ret["blks_read"] = els[5]
+        ret["blks_hit"] = els[6]
+        ret["tup_returned"] = els[7]
+        ret["tup_fetched"] = els[8]
+        ret["tup_inserted"] = els[9]
+        ret["tup_updated"] = els[10]
+        ret["tup_deleted"] = els[11]
+        ret["conflicts"] = els[12]
+        ret["temp_files"] = els[13]
+        ret["temp_bytes"] = els[14]
+        ret["deadlocks"] = els[15]
+        ret["blk_read_time"] = els[16]
+        ret["blk_write_time"] = els[17]
+        ret
+      end
+
+    end
+  end
+end
+
+ZabbixRubyClient::Plugins.register('postgres', ZabbixRubyClient::Plugins::Postgres)
+

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

@@ -1,3 +1,3 @@
 module ZabbixRubyClient
-  VERSION ||= "0.0.17"
+  VERSION ||= "0.0.18"
 end

data/spec/files/plugins/sample_buggy.rb

@@ -0,0 +1,11 @@
+module SampleBuggy
+  extend self
+
+  def collect(*args)
+    raise Exception
+  end
+
+end
+
+ZabbixRubyClient::Plugins.register('sample_buggy', SampleBuggy)
+

data/spec/files/plugins/sample_discover.rb

@@ -0,0 +1,12 @@
+module SampleDiscover
+  extend self
+
+  def discover(*args)
+    interface = args[0]
+    [ "sample.discover", "{\"{#SAMPLE}\": \"#{interface}\"}" ]
+  end
+
+end
+
+ZabbixRubyClient::Plugins.register('sample_discover', SampleDiscover)
+

data/spec/files/system/apache_status

@@ -1,9 +1,10 @@
 Total Accesses: 12
 Total kBytes: 6
-Uptime: 602766
-ReqPerSec: 1.99082e-5
-BytesPerSec: .010193
-BytesPerReq: 512
+CPULoad: 5.69795e-5
+Uptime: 1175861
+ReqPerSec: 4.16716e-5
+BytesPerSec: 1.0128
+BytesPerReq: 24304.3
 BusyWorkers: 1
-IdleWorkers: 9
-Scoreboard: _____W____......................................................................................................................................................................................................................................................
+IdleWorkers: 4
+Scoreboard: __S__W__W_........

data/spec/files/system/apt-check

@@ -0,0 +1 @@
+23;14

data/spec/files/system/df

@@ -0,0 +1 @@
+/dev/sda2      288238944 76560212 197013928  28% /home

data/spec/files/system/diskstats

@@ -0,0 +1 @@
+   8       1 sda1 974243 695335 37526290 4648644 711455 785503 27660904 11097172 0 6283844 15744924

data/spec/files/system/loadavg

@@ -0,0 +1 @@
+0.89 1.29 1.05 2/968 2768

data/spec/files/system/meminfo

@@ -0,0 +1,46 @@
+MemTotal:        4130440 kB
+MemFree:          224460 kB
+Buffers:           59116 kB
+Cached:           385776 kB
+SwapCached:       204968 kB
+Active:          2664148 kB
+Inactive:         883200 kB
+Active(anon):    2473484 kB
+Inactive(anon):   739608 kB
+Active(file):     190664 kB
+Inactive(file):   143592 kB
+Unevictable:         212 kB
+Mlocked:             212 kB
+HighTotal:       3280520 kB
+HighFree:          41136 kB
+LowTotal:         849920 kB
+LowFree:          183324 kB
+SwapTotal:       5858448 kB
+SwapFree:        3580100 kB
+Dirty:               532 kB
+Writeback:             0 kB
+AnonPages:       3002480 kB
+Mapped:           278560 kB
+Shmem:            110636 kB
+Slab:              92716 kB
+SReclaimable:      60300 kB
+SUnreclaim:        32416 kB
+KernelStack:        7752 kB
+PageTables:        49584 kB
+NFS_Unstable:          0 kB
+Bounce:                0 kB
+WritebackTmp:          0 kB
+CommitLimit:     7923668 kB
+Committed_AS:   15878488 kB
+VmallocTotal:     122880 kB
+VmallocUsed:       49400 kB
+VmallocChunk:      66212 kB
+HardwareCorrupted:     0 kB
+AnonHugePages:         0 kB
+HugePages_Total:       0
+HugePages_Free:        0
+HugePages_Rsvd:        0
+HugePages_Surp:        0
+Hugepagesize:       2048 kB
+DirectMap4k:      851960 kB
+DirectMap2M:       61440 kB

data/spec/files/system/net_dev

@@ -0,0 +1 @@
+  eth0: 8523363858 17554648    0    0    0     0          0    589997 2479556217 15780062    0    0    0     0       0          0

data/spec/files/system/proc_cpu

@@ -0,0 +1 @@
+cpu  473806 20486 406619 187353904 11589 9 696 5186311 0 0

data/spec/files/task_discovery.yml

@@ -0,0 +1,3 @@
+---
+- name: sample_discovery
+  args: [ 'some_arg' ]

data/spec/lib/cli_spec.rb

@@ -4,10 +4,48 @@ require 'spec_helper'
 require "zabbix-ruby-client/cli"
 
 describe ZabbixRubyClient::Cli do
-  
-  pending "init creates a working directory"
-  pending "show displays the list of data collected"
-  pending "upload collects and uploads the data from system"
-  pending "when a custom config file is specified it's taken in account"
 
-end
+  before :each do
+    @cli = ZabbixRubyClient::Cli.new(
+      [],
+      {
+        'configfile' => 'config.yml',
+        'taskfile' => 'minutely.yml'
+      }
+    )
+    @testdir = File.join('spec','files','test-client')
+    @cli.shell.mute do
+      @cli.init(@testdir)
+    end
+    @oldpwd = Dir.pwd
+    Dir.chdir @testdir
+  end
+
+  after :each do
+    Dir.chdir @oldpwd
+    FileUtils.rm_rf @testdir if Dir.exists? @testdir
+  end
+
+  it "init creates a working directory" do
+    expect(File.file? 'Gemfile').to be_true
+  end
+
+  it "show displays the list of data collected" do
+    ZabbixRubyClient::Runner.stub(:new).and_return(Object)
+    Object.stub(:collect)
+    Object.stub(:show)
+    @cli.shell.mute do
+      @cli.show
+    end
+  end
+
+  it "upload collects and uploads the data from system" do
+    ZabbixRubyClient::Runner.stub(:new).and_return(Object)
+    Object.stub(:collect)
+    Object.stub(:upload)
+    @cli.shell.mute do
+      @cli.upload
+    end
+  end
+
+end

data/spec/lib/data_spec.rb

@@ -2,7 +2,64 @@
 
 require 'spec_helper'
 require "zabbix-ruby-client/data"
+require "zabbix-ruby-client/plugins"
+require "zabbix-ruby-client/logger"
 
 describe ZabbixRubyClient::Data do
 
-end
+  before :all do
+    plugindir = File.expand_path("../../files/plugins", __FILE__)
+    ZabbixRubyClient::Plugins.scan_dirs([plugindir])
+    @logfile = File.expand_path("../../files/logs/spec.log", __FILE__)
+    ZabbixRubyClient::Log.set_logger(@logfile)
+  end
+
+  before :each do
+    @data = ZabbixRubyClient::Data.new("host")
+  end
+
+  after :all do
+    FileUtils.rm_rf @logfile if File.exists? @logfile
+  end
+
+  it "initializes with host" do
+    expect(@data.instance_variable_get(:@host)).to eq "host"
+  end
+
+  it "runs a plugin" do
+    items = ["localhost sample[foo] 123456789 42"]
+    @data.run_plugin("sample")
+    expect(@data.instance_variable_get(:@items)).to eq items
+  end
+
+  it "logs an error when plugin is not found" do
+    ZabbixRubyClient::Log.stub(:error).with("Plugin unknown_plugin not found.")
+    @data.run_plugin("unknown_plugin")
+  end
+
+  it "runs a plugin that only has discovery" do
+    discovery = { "sample.discover" => [["{\"{#SAMPLE}\": \"sample_arg\"}" ]]}
+    @data.run_plugin("sample_discover", 'sample_arg')
+    expect(@data.instance_variable_get(:@discover)).to eq discovery
+  end
+
+  it "ignores buggy plugins" do
+    expect(@data.run_plugin("sample_buggy")).to be_true
+  end
+
+  it "logs buggy plugins" do
+    ZabbixRubyClient::Log.stub(:fatal).with("Oops")
+    ZabbixRubyClient::Log.stub(:fatal).with("Exception")
+    @data.run_plugin("sample_buggy")
+  end
+
+  it "merges collected and discovered data" do
+    Time.stub(:now).and_return("123456789")
+    @data.run_plugin("sample")
+    @data.run_plugin("sample_discover")
+    result = ["host sample.discover 123456789 { \"data\": [ {\"{#SAMPLE}\": \"\"} ] }",
+              "localhost sample[foo] 123456789 42"]
+    expect(@data.merge).to eq result
+  end
+
+end

data/spec/lib/plugin_base_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require "zabbix-ruby-client/logger"
+require "zabbix-ruby-client/plugin_base"
+
+describe ZabbixRubyClient::PluginBase do
+
+  before :all do
+    @logfile = File.expand_path("../files/logs/spec.log", __FILE__)
+    ZabbixRubyClient::Log.set_logger(@logfile)
+    @stubfile = File.expand_path('../../../spec/files/system/net_dev', __FILE__)
+    @expected_line = "eth0: 8523363858 17554648    0    0    0     0          0    589997 2479556217 15780062    0    0    0     0       0          0"
+  end
+
+  after :all do
+    FileUtils.rm_rf @logfile if File.exists? @logfile
+  end
+
+  after :each do
+    FileUtils.rm "/tmp/xxxxx" if File.exists? "/tmp/xxxxx"
+  end
+
+  it "extracts a line from a file" do
+    line = ZabbixRubyClient::PluginBase.getline(@stubfile, "eth0: ")
+    expect(line).to eq @expected_line
+  end
+
+  it "logs a debug entry when it extracts a line from a file" do
+    expect(ZabbixRubyClient::Log).to receive(:debug).with("File #{@stubfile}: #{@expected_line}")   
+    ZabbixRubyClient::PluginBase.getline(@stubfile, "eth0: ")
+  end
+
+  it "logs a warn entry when a line is not found in a file" do
+    expect(ZabbixRubyClient::Log).to receive(:warn).with("File #{@stubfile}: pattern \" xxx \" not found.")   
+    x = ZabbixRubyClient::PluginBase.getline(@stubfile, " xxx ")
+    expect(x).to be_false
+  end
+
+  it "logs an error entry when a file is not found" do
+    expect(ZabbixRubyClient::Log).to receive(:error).with("File not found: /tmp/xxxxx")
+    x = ZabbixRubyClient::PluginBase.getline("/tmp/xxxxx", " xxx ")
+    expect(x).to be_false
+  end
+
+  it "logs an error entry when a file is not readable" do
+    FileUtils.touch "/tmp/xxxxx"
+    FileUtils.chmod 0300, "/tmp/xxxxx"
+    expect(ZabbixRubyClient::Log).to receive(:error).with("File not readable: /tmp/xxxxx")
+    x = ZabbixRubyClient::PluginBase.getline("/tmp/xxxxx", " xxx ")
+    expect(x).to be_false
+  end
+
+end

data/spec/lib/plugins/apache_spec.rb

@@ -1,14 +1,87 @@
 # encoding: utf-8
 
 require 'spec_helper'
+require 'webmock/rspec'
 require "zabbix-ruby-client/plugins"
 ZabbixRubyClient::Plugins.scan_dirs ["zabbix-ruby-client/plugins"]
 require "zabbix-ruby-client/plugins/apache"
 
 describe ZabbixRubyClient::Plugins::Apache do
-  
-  pending "gets the status page from localhost"
-  pending "populate a hash with extracted data"
-  pending "populate scores from scoreboard data"
 
-end
+  before :each do
+    stubfile = File.expand_path('../../../../spec/files/system/apache_status', __FILE__)
+    @data = File.read(stubfile)
+    @processed = {
+      "Total Accesses"=>"12",
+      "Total kBytes"=>"6",
+      "CPULoad"=>"5.69795e-5",
+      "Uptime"=>"1175861",
+      "ReqPerSec"=>"4.16716e-5",
+      "BytesPerSec"=>"1.0128",
+      "BytesPerReq"=>"24304.3",
+      "BusyWorkers"=>"1",
+      "IdleWorkers"=>"4",
+      "Scoreboard"=>"__S__W__W_........"}
+    @expected_data = [
+      "local apache[TotalAccesses] 123456789 12",
+      "local apache[TotalKBytes] 123456789 6",
+      "local apache[CPULoad] 123456789 5.69795e-05",
+      "local apache[Uptime] 123456789 1175861",
+      "local apache[ReqPerSec] 123456789 4.16716e-05",
+      "local apache[BytesPerSec] 123456789 1.0128",
+      "local apache[BytesPerReq] 123456789 24304.3",
+      "local apache[BusyWorkers] 123456789 1",
+      "local apache[IdleWorkers] 123456789 4",
+      "local apache[c_idle] 123456789 8",
+      "local apache[c_waiting] 123456789 7",
+      "local apache[c_closing] 123456789 0",
+      "local apache[c_dns] 123456789 0",
+      "local apache[c_finish] 123456789 0",
+      "local apache[c_cleanup] 123456789 0",
+      "local apache[c_keep] 123456789 0",
+      "local apache[c_log] 123456789 0",
+      "local apache[c_read] 123456789 0",
+      "local apache[c_send] 123456789 2",
+      "local apache[c_start] 123456789 1"
+    ]
+  end
+
+  it "gets the status page from localhost" do
+    stub_request(:get, '127.0.0.1:80/server-status?auto')
+    ZabbixRubyClient::Plugins::Apache.send(:get_status)
+  end
+
+  it "populate a hash with extracted data" do
+    stub_request(:get, '127.0.0.1:80/server-status?auto').
+      to_return({ :body => @data })
+    status = ZabbixRubyClient::Plugins::Apache.send(:get_status)
+    expect(status).to eq @processed
+  end
+
+  it "populate scores from scoreboard data" do
+    expected = {
+      "_" => 7,
+      "S" => 1,
+      "R" => 0,
+      "W" => 2,
+      "K" => 0,
+      "D" => 0,
+      "C" => 0,
+      "L" => 0,
+      "G" => 0,
+      "I" => 0,
+      "." => 8
+    }
+    board = ZabbixRubyClient::Plugins::Apache.send(:get_scores, @processed['Scoreboard'])
+    expect(board).to eq expected
+  end
+
+  it "collects data properly" do
+    stub_request(:get, '127.0.0.1:80/server-status?auto').
+      to_return({ :body => @data })
+    Time.stub(:now).and_return("123456789")
+    data = ZabbixRubyClient::Plugins::Apache.send(:collect, 'local')
+    expect(data).to eq @expected_data
+  end
+
+end