fluent-plugin-snmp 0.0.6 → 0.0.7

data/README.md

@@ -14,38 +14,32 @@ Or install it yourself as:
 
 ## Usage
 
-    <source>                                                          
-      type snmp                                                         
-      tag snmp.server1                                                  
-      nodes name, value                                                 
-      host server1                                                    
-      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 server2                                                    
-      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>                                                         
-
-
-     2012-11-08 16:07:40 +0900 snmp.server1: {"name":"HOST-RESOURCES-MIB::hrStorageUsed.31","value":"2352425"}         
-     2012-11-08 16:07:45 +0900 snmp.server2: {"value":"[name=HOST-RESOURCES-MIB::hrStorageIndex.7, value=7 (INTEGER)]"}  
-
+    <source>
+      type snmp
+      tag snmp.server1
+      nodes name, value
+      host localhost
+      community public
+      mib sysContact.0, sysDescr.0, sysName.0
+      method_type get
+      polling_time 5
+      polling_type async_run
+    </source>
+    
+    <source>
+      type snmp
+      tag snmp.server2
+      host localhost
+      community public
+      mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
+      mib_modules HOST-RESOURCES-MIB
+      polling_time 0,10,20,30,40,50
+      out_executor sample/out_exec.rb.sample
+    </source>
+    
+    <match snmp.server*>
+      type stdout
+    </match>
 
 ## Copyright
 Copyright (c) 2012 Internet Initiative Inc.

data/fluent-plugin-snmp.gemspec

@@ -3,11 +3,11 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-snmp"
-  gem.version       = "0.0.6"
+  gem.version       = "0.0.7"
   gem.authors       = ["hiro-su"]
   gem.email         = ["h-sugimoto@iij.ad.jp"]
-  gem.description   = %q{Input plugin to walk snmp}
-  gem.summary       = %q{Input plugin to walk snmp}
+  gem.description   = %q{Input plugin to snmp}
+  gem.summary       = %q{Input plugin to snmp}
 
   gem.files         = `git ls-files`.split($\)                                    
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/fluent/plugin/in_snmp.rb

@@ -11,11 +11,13 @@ module Fluent
     config_param :mib, :string
     config_param :nodes, :string, :default => nil 
     config_param :polling_time, :string, :default => nil
+    config_param :polling_offset, :time, :default => 0
+    config_param :polling_type, :string, :default => "run" #or async_run
     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
+    config_param :method_type, :string, :default => "walk" #or get
+    config_param :out_executor, :string, :default => nil
 
     # SNMP Lib Params
     # require param: host, community
@@ -52,7 +54,8 @@ module Fluent
     def configure(conf)                                                         
       super
 
-      raise ConfigError, "tag is required param" if @tag.empty?
+      raise ConfigError, "snmp: 'tag' is required param" if @tag.empty?
+      raise ConfigError, "snmp: 'polling_type' parameter is required on snmp input" if @polling_type.empty?
 
       # @mib, @mib_modules, @nodesを配列に変換
       @mib = @mib.split(',').map{|str| str.strip} 
@@ -87,9 +90,10 @@ module Fluent
         :use_IPv6        => @use_IPv6
       }
 
-      unless @out_exec_filter.nil?
+      unless @out_executor.nil?
+        $log.info "load snmp out executor #{out_executor}"
         @out_exec = lambda do |manager|
-          require @out_exec_filter
+          load @out_executor
           opts = {
             :tag         => @tag,
             :mib         => @mib,
@@ -117,7 +121,8 @@ module Fluent
     end
 
     def run
-      Polling::run(@polling_time) do
+      Polling.setting offset: @polling_offset
+      Polling.__send__(@polling_type, @polling_time) do
         break if @end_flag
         exec_params = {
           manager: @manager,
@@ -137,16 +142,25 @@ module Fluent
 
     def shutdown
       @end_flag = true
-      @thread.run
-      @thread.join
-      @starter.join
-      @manager.close 
-      super
+      if @thread 
+        @thread.run
+        @thread.join
+        @thread = nil
+      end
+      if @starter
+        @starter.join 
+        @starter = nil
+      end
+      if @manager
+        @manager.close 
+      end
     end
 
+    private
+
     def exec_snmp opts={}
       @retry_count ||= 0
-      if @out_exec_filter.nil?
+      if @out_executor.nil?
         case opts[:method_type]
         when /^walk$/
           snmp_walk(opts[:manager], opts[:mib], opts[:nodes])
@@ -174,8 +188,6 @@ module Fluent
       raise ex
     end
 
-    private
-
     def snmp_walk(manager, mib, nodes, test=false)
       manager.walk(mib) do |row|
         time = Engine.now 

data/sample/snmp.conf.sample

@@ -1,42 +1,25 @@
 <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
+  type snmp
+  tag snmp.server1
+  nodes name, value
+  host localhost
+  community public
+  mib sysContact.0, sysDescr.0, sysName.0
+  method_type get
+  polling_time 5
+  polling_type async_run
 </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>
+<source>
+  type snmp
+  tag snmp.server2
+  host localhost
+  community public
+  mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
+  mib_modules HOST-RESOURCES-MIB
+  polling_time 0,10,20,30,40,50
+  out_executor sample/out_exec.rb.sample
+</source>
 
 <match snmp.server*>
   type stdout

data/test/plugin/test_in_snmp.rb

@@ -14,6 +14,7 @@ class SnmpInputTest < Test::Unit::TestCase
     mib hrStorageIndex, hrStorageDescr, hrStorageSize, hrStorageUsed
     nodes name, value
     polling_time 0,10,20,30,40,50
+    polling_offset 0
     host localhost
     host_name test_host
     community public
@@ -22,7 +23,7 @@ class SnmpInputTest < Test::Unit::TestCase
     retry_interval 2
     timeout 3s
     method_type walk
-    out_exec_filter sample/out_exec.rb
+    out_executor sample/out_exec.rb.sample
   ]
 
   def create_driver(conf=CONFIG)
@@ -37,9 +38,10 @@ 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 0, d.instance.polling_offset
     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
+    assert_equal "sample/out_exec.rb.sample", d.instance.out_executor
 
     # SNMP Lib Params
     assert_equal "localhost", d.instance.host

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-snmp
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -107,7 +107,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Input plugin to walk snmp
+description: Input plugin to snmp
 email:
 - h-sugimoto@iij.ad.jp
 executables: []
@@ -148,7 +148,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Input plugin to walk snmp
+summary: Input plugin to snmp
 test_files:
 - test/helper.rb
 - test/plugin/test_in_snmp.rb