fluent-plugin-snmp 0.0.5 → 0.0.6

data/fluent-plugin-snmp.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-snmp"
-  gem.version       = "0.0.5"
+  gem.version       = "0.0.6"
   gem.authors       = ["hiro-su"]
   gem.email         = ["h-sugimoto@iij.ad.jp"]
   gem.description   = %q{Input plugin to walk snmp}

data/lib/fluent/plugin/in_snmp.rb

@@ -12,6 +12,10 @@ module Fluent
     config_param :nodes, :string, :default => nil 
     config_param :polling_time, :string, :default => nil
     config_param :host_name, :string, :default => nil
+    config_param :retry, :integer, :default => 5
+    config_param :retry_interval, :time, :default => 1
+    config_param :method_type, :string, :default => "walk"
+    config_param :out_exec_filter, :string, :default => nil
 
     # SNMP Lib Params
     # require param: host, community
@@ -38,7 +42,7 @@ module Fluent
     config_param :write_community, :string, :default => nil
     config_param :version, :string, :default => nil # Use :SNMPv1 or :SNMPv2c
     config_param :timeout, :time, :default => nil
-    config_param :retries, :integer, :default => nil
+    config_param :retries, :integer, :default => 0
     config_param :transport, :string, :default => nil
     config_param :max_recv_bytes, :string, :default => nil
     config_param :mib_dir, :string, :default => nil
@@ -83,7 +87,19 @@ module Fluent
         :use_IPv6        => @use_IPv6
       }
 
-      @retry_conut = 0
+      unless @out_exec_filter.nil?
+        @out_exec = lambda do |manager|
+          require @out_exec_filter
+          opts = {
+            :tag         => @tag,
+            :mib         => @mib,
+            :mib_modules => @mib_modules,
+            :nodes       => @nodes,
+            :conf        => conf
+          }
+          Fluent::SnmpInput.new.out_exec(manager, opts)
+        end
+      end
     end
 
     def starter
@@ -102,35 +118,69 @@ module Fluent
 
     def run
       Polling::run(@polling_time) do
-        snmpwalk(@manager, @mib, @nodes)
         break if @end_flag
+        exec_params = {
+          manager: @manager,
+          mib: @mib,
+          nodes: @nodes,
+          method_type: @method_type
+        }
+        exec_snmp(exec_params)
       end
     rescue TypeError => ex
       $log.error "run TypeError", :error=>ex.message
-      exit
     rescue => ex
-      $log.error "run failed", :error=>ex.message
-      sleep(10)
-      @retry_conut += 1
-      retry if @retry_conut < 30
+      $log.fatal "run failed", :error=>ex.inspect
+      $log.fatal_backtrace ex.backtrace
+      exit
     end
 
-    #Ctrl-cで処理を停止時に呼ばれる
     def shutdown
       @end_flag = true
       @thread.run
       @thread.join
       @starter.join
       @manager.close 
+      super
+    end
+
+    def exec_snmp opts={}
+      @retry_count ||= 0
+      if @out_exec_filter.nil?
+        case opts[:method_type]
+        when /^walk$/
+          snmp_walk(opts[:manager], opts[:mib], opts[:nodes])
+        when /^get$/
+          snmp_get(opts[:manager], opts[:mib], opts[:nodes])
+        else
+          $log.error "unknow exec method"
+          raise
+        end
+      else
+        @out_exec.call opts[:manager]
+      end
+      @retry_count = 0
+    rescue SNMP::RequestTimeout => ex
+      $log.error "exec_snmp failed", :error=>ex.inspect
+      @retry_count += 1
+      if @retry_count <= @retry
+        sleep @retry_interval
+        $log.error "retry: #{@retry_count}"
+        retry
+      else
+        raise ex
+      end
+    rescue => ex
+      raise ex
     end
 
     private
 
-    def snmpwalk(manager, mib, nodes, test=false)
+    def snmp_walk(manager, mib, nodes, test=false)
       manager.walk(mib) do |row|
         time = Engine.now 
         time = time - time % 5
-        record = Hash.new
+        record = {}
         row.each do |vb|
           if nodes.nil?
             record["value"] = vb
@@ -142,10 +192,27 @@ module Fluent
         end
       end
     rescue => ex
-      $log.error "snmpwalk failed", :error=>ex.message
+      raise ex
+    end
+
+    def snmp_get(manager, mib, nodes, test=false)
+      manager.get(mib).each_varbind do |vb|
+        time = Engine.now
+        time = time - time % 5
+        record = {}
+        if nodes.nil?
+          record["value"] = vb
+        else
+          nodes.each{|param| record[param] = check_type(vb.__send__(param))}
+        end
+        Engine.emit(@tag, time, record)
+        return {:time => time, :record => record} if test
+      end
+    rescue => ex
+      raise ex
     end
 
-    # SNMPで取得したデータの型チェック
+    # data check from snmp
     def check_type(value)
       if value =~ /^\d+(\.\d+)?$/ 
         return value.to_f
@@ -153,9 +220,8 @@ module Fluent
         return value.to_s
       end
     rescue => ex
-      $Log.error "snmp failed to check_type", :error=>ex.message
+      $log.error "snmp failed to check_type", :error=>ex.message
       $log.warn_backtrace ex.backtrace
     end
-
   end
 end

data/sample/out_exec.rb.sample

@@ -0,0 +1,17 @@
+module Fluent
+  class SnmpInput
+    def out_exec manager, opts={}
+      manager.walk(opts[:mib]) do |row|
+        time = Time.now.to_i
+        time = time - time  % 5
+        record = {}
+        row.each do |vb|
+          record["name"] = vb.name.to_s
+          record["value"] = vb.value.to_s
+          Engine.emit opts[:tag], time, record
+        end
+      end
+    end
+  end
+end
+

data/sample/snmp.conf.sample

@@ -0,0 +1,43 @@
+<source>
+type snmp
+tag snmp.server1
+nodes name, value
+host localhost
+community public
+version 2c
+mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
+mib_modules HOST-RESOURCES-MIB
+retries 0
+timeout 3s
+polling_time 0,10,20,30,40,50
+</source>
+
+#<source>
+#type snmp
+#tag snmp.server2
+#host localhost
+#community public
+#version 2c
+#mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
+#mib_modules HOST-RESOURCES-MIB
+#retries 0
+#timeout 3s
+#polling_time 5,15,25,35,45,55
+#</source>
+#
+#<source>
+#type snmp
+#tag snmp.server3
+#host localhost
+#community public
+#version 2c
+#mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
+#mib_modules HOST-RESOURCES-MIB
+#retries 0
+#timeout 3s
+#polling_time 5m
+#</source>
+
+<match snmp.server*>
+  type stdout
+</match>

data/test/plugin/test_in_snmp.rb

@@ -15,10 +15,14 @@ class SnmpInputTest < Test::Unit::TestCase
     nodes name, value
     polling_time 0,10,20,30,40,50
     host localhost
-    community private
+    host_name test_host
+    community public
     mib_modules HOST-RESOURCES-MIB, IF-MIB
-    retries 0
+    retry 0
+    retry_interval 2
     timeout 3s
+    method_type walk
+    out_exec_filter sample/out_exec.rb
   ]
 
   def create_driver(conf=CONFIG)
@@ -33,16 +37,20 @@ class SnmpInputTest < Test::Unit::TestCase
     assert_equal ["hrStorageIndex","hrStorageDescr","hrStorageSize","hrStorageUsed"], d.instance.mib
     assert_equal ["name","value"], d.instance.nodes
     assert_equal ["0","10","20","30","40","50"], d.instance.polling_time
+    assert_equal "walk", d.instance.method_type
+    assert_equal 2, d.instance.retry_interval
+    assert_equal "sample/out_exec.rb", d.instance.out_exec_filter
 
     # SNMP Lib Params
     assert_equal "localhost", d.instance.host
+    assert_equal "test_host", d.instance.host_name
     assert_nil d.instance.port
     assert_nil d.instance.trap_port
-    assert_equal "private", d.instance.community
+    assert_equal "public", d.instance.community
     assert_nil d.instance.write_community
     assert_equal :SNMPv2c, d.instance.version
     assert_equal 3, d.instance.timeout
-    assert_equal 0, d.instance.retries
+    assert_equal 0, d.instance.retry
     assert_nil d.instance.transport
     assert_nil d.instance.max_recv_bytes
     assert_nil d.instance.mib_dir
@@ -57,9 +65,15 @@ class SnmpInputTest < Test::Unit::TestCase
     assert_equal "sensorValue_%RH", @obj.__send__(:check_type,"sensorValue_%RH")
     assert_equal 12.00, @obj.__send__(:check_type,"12")
     assert_equal 12.34, @obj.__send__(:check_type,"12.34")
+    assert_equal String, @obj.__send__(:check_type,"test").class
+    assert_equal String, @obj.__send__(:check_type,"utrh0").class
+    assert_equal String, @obj.__send__(:check_type,"sensorValue_degC").class
+    assert_equal String, @obj.__send__(:check_type,"sensorValue_%RH").class
+    assert_equal Float, @obj.__send__(:check_type,"12").class
+    assert_equal Float, @obj.__send__(:check_type,"12.34").class
   end
 
-  def test_snmpwalk
+  def test_snmp_walk
     d = create_driver
     nodes = d.instance.nodes
     mib = d.instance.mib
@@ -77,12 +91,71 @@ class SnmpInputTest < Test::Unit::TestCase
     Time.stubs(:now).returns(Time.parse "2012/12/31 23:59:50")
     manager = SNMP::Manager.new(snmp_init_params)
 
-    data = @obj.__send__(:snmpwalk, manager, mib, nodes, true)
+    data = @obj.__send__(:snmp_walk, manager, mib, nodes, true)
     record = data[:record]
 
     assert_equal 1356965990, data[:time]
-    assert_equal "HOST-RESOURCES-MIB::hrStorageIndex.1", record["name"]
-    assert_equal "1", record["value"]
+    assert_equal "HOST-RESOURCES-MIB::hrStorageIndex.31", record["name"]
+    assert_equal "31", record["value"]
   end
 
+
+  def test_snmp_get
+    d = create_driver %[
+      tag snmp.server1
+      mib hrStorageIndex.31
+      nodes name, value
+      polling_time 0,10,20,30,40,50
+      host localhost
+      community public
+      mib_modules HOST-RESOURCES-MIB
+    ]
+    nodes = d.instance.nodes
+    mib = d.instance.mib
+
+    snmp_init_params = {
+      :host => d.instance.host,
+      :community => d.instance.community,
+      :timeout => d.instance.timeout,
+      :retries => d.instance.retries,
+      :mib_dir => d.instance.mib_dir,
+      :mib_modules => d.instance.mib_modules,
+    }
+
+    # unixtime 1356965990
+    Time.stubs(:now).returns(Time.parse "2012/12/31 23:59:50")
+    manager = SNMP::Manager.new(snmp_init_params)
+
+    data = @obj.__send__(:snmp_get, manager, mib, nodes, true)
+    record = data[:record]
+
+    assert_equal 1356965990, data[:time]
+    assert_equal "HOST-RESOURCES-MIB::hrStorageIndex.31", record["name"]
+    assert_equal "31", record["value"]
+  end
+
+  def test_exec_snmp
+    d = create_driver
+    snmp_init_params = {
+      :host => d.instance.host,
+      :community => d.instance.community,
+      :timeout => d.instance.timeout,
+      :retries => d.instance.retries,
+      :mib_dir => d.instance.mib_dir,
+      :mib_modules => d.instance.mib_modules,
+    }
+
+    manager = SNMP::Manager.new(snmp_init_params)
+
+    opts = {
+      :manager => manager,
+      :method_type => d.instance.method_type,
+      :mib => d.instance.mib,
+      :nodes => d.instance.nodes,
+      :test => true
+    }
+
+    exec = @obj.__send__(:exec_snmp, opts)
+    assert_equal 0, exec
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-snmp
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -121,7 +121,8 @@ files:
 - Rakefile
 - fluent-plugin-snmp.gemspec
 - lib/fluent/plugin/in_snmp.rb
-- snmp.conf.sample
+- sample/out_exec.rb.sample
+- sample/snmp.conf.sample
 - test/helper.rb
 - test/plugin/test_in_snmp.rb
 homepage: 

data/snmp.conf.sample

@@ -1,43 +0,0 @@
-<source>
-type snmp
-tag snmp.server1
-nodes name, value
-host localhost
-community private
-version 2c
-mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
-mib_modules HOST-RESOURCES-MIB
-retries 0
-timeout 3s
-polling_time 0,10,20,30,40,50
-</source>
-
-<source>
-type snmp
-tag snmp.server2
-host localhost
-community private
-version 2c
-mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
-mib_modules HOST-RESOURCES-MIB
-retries 0
-timeout 3s
-polling_time 5,15,25,35,45,55
-</source>
-
-<source>
-type snmp
-tag snmp.server3
-host localhost
-community private
-version 2c
-mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
-mib_modules HOST-RESOURCES-MIB
-retries 0
-timeout 3s
-polling_time 5m
-</source>
-
-<match snmp.server*>
-  type stdout
-</match>