logstash-input-snmp 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 213be86518d3d8a674d4227ff23cad9fac2be281fe2d79e9cd6a2e3bc1415b62
-  data.tar.gz: 1334457e8ebfcd7c979fa5bd53870af0205df9fe0842dd1f7e7d4598b653961b
+  metadata.gz: b52920a394a09244f4731933b5d79655002bd3569552ca33972dfd069d709ade
+  data.tar.gz: ff663bdff7ca249635388c68329cfcd0ae759893c4eaf27ff226ca59c6939f7f
 SHA512:
-  metadata.gz: 5630fc5e10d784ba79700e2f11216b660194e36317e06ba6060f1459f3825719b28514324e212378a69dcc5b257c8efdaba889c6f65093560a2ae7d51f124314
-  data.tar.gz: 0a888058d97613735f4eb4188963a73e907fa354a7799529153d00c51e58d15a6a232bcc7c0d22eaa8065a3798d3bb48d1f1b5535057e08b4b521647590bac91
+  metadata.gz: de641478532900bd27fa9e261b239a0d7f87c2024ee20c59e70dce40a9bb5bbd369a6ec9b4b96c69571afafda62fb49940e458b2174bcf5d852de5e893106ef9
+  data.tar.gz: 0c63e9b7f357faba71b6120aeaf5b42adcb399307f630597e0858ef267a071487cbff47c6fe7422dcdf1441f4755182e511d9fe5902a3f4b86162b9bd5dc63c6

data/CHANGELOG.md

@@ -1,5 +1,12 @@
+## 1.2.0
+  - Adding oid_path_length config option [#59] (https://github.com/logstash-plugins/logstash-input-snmp/pull/59)
+  - Fixing bug with table support removing index value from OIDs [#60] )https://github.com/logstash-plugins/logstash-input-snmp/issues/60)
+
+## 1.1.1
+  - Added information and other improvements to documentation [#57](https://github.com/logstash-plugins/logstash-input-snmp/pull/57)
+
 ## 1.1.0
-  - Added support for querying SNMP tables
+  - Added support for querying SNMP tables [#49] (https://github.com/logstash-plugins/logstash-input-snmp/pull/49)
   - Changed three error messages in the base_client to include the target address for clarity in the logs.
 
 ## 1.0.1

data/docs/index.asciidoc

@@ -59,8 +59,10 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-hosts>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-mib_paths>> |<<path,path>>|No
-| <<plugins-{type}s-{plugin}-oid_root_skip>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-oid_root_skip>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-oid_path_length>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-walk>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-tables>> |<<array,array>>|No
 |=======================================================================
 
 ==== SNMPv3 Authentication Options
@@ -168,7 +170,7 @@ If you require other MIBs, you need to import them. See <<plugins-{type}s-{plugi
 [id="plugins-{type}s-{plugin}-oid_root_skip"]
 ===== `oid_root_skip` 
 
-The `oid_root_skip` option specifies the  number of OID root digits to ignore in event field name.
+The `oid_root_skip` option specifies the number of OID root digits to ignore in the event field name.
 For example, in a numeric OID like "1.3.6.1.2.1.1.1.0" the first 5 digits could be ignored by setting `oid_root_skip => 5`
 which would result in a field name "1.1.1.0". Similarly when a MIB is used an OID such
 "1.3.6.1.2.mib-2.system.sysDescr.0" would become "mib-2.system.sysDescr.0"
@@ -176,6 +178,17 @@ which would result in a field name "1.1.1.0". Similarly when a MIB is used an OI
 * Value type is <<number,number>>
 * Default value is `0`
 
+[id="plugins-{type}s-{plugin}-oid_path_length"]
+===== `oid_path_length`
+
+The `oid_path_length` option specifies the number of OID root digits to retain in the event field name.
+For example, in a numeric OID like "1.3.6.1.2.1.1.1.0" the last 2 digits could be retained by setting `oid_path_length => 2`
+which would result in a field name "1.0". Similarly when a MIB is used an OID such
+"1.3.6.1.2.mib-2.system.sysDescr.0" would become "sysDescr.0"
+
+* Value type is <<number,number>>
+* Default value is `0`
+
 [id="plugins-{type}s-{plugin}-walk"]
 ===== `walk`
 
@@ -197,6 +210,41 @@ Example
 }
 -----
 
+[id="plugins-{type}s-{plugin}-tables"]
+===== `tables`
+
+The `tables` option is used to query for tabular values for the given column OID(s).
+
+Each table definition is a hash and must define the name key and value and the columns to return.
+
+* Value type is <<array,array>>
+* There is no default value for this setting
+* Results are returned under a field using the table name
+
+*Specifying a single table*
+
+[source,ruby]
+-----
+input {
+  snmp {
+    hosts => [{host => "udp:127.0.0.1/161" community => "public" version => "2c"  retries => 2  timeout => 1000}]
+    tables => [ {"name" => "interfaces" "columns" => ["1.3.6.1.2.1.2.2.1.1", "1.3.6.1.2.1.2.2.1.2", "1.3.6.1.2.1.2.2.1.5"]} ]
+  }
+}
+-----
+
+*Specifying multiple tables*
+
+[source,ruby]
+-----
+input {
+  snmp {
+    get => ["1.3.6.1.2.1.1.1.0"]
+    tables => [ {"name" => "interfaces" "columns" => ["1.3.6.1.2.1.2.2.1.1", "1.3.6.1.2.1.2.2.1.2", "1.3.6.1.2.1.2.2.1.5"]}, {"name" => "ltmPoolStatTable" "columns" => ["1.3.6.1.4.1.3375.2.2.5.2.3.1.1", "1.3.6.1.4.1.3375.2.2.5.2.3.1.6"]} ]
+  }
+}
+-----
+
 ==== SNMPv3 Authentication Options
 
 A **single user** can be configured and will be used for all defined SNMPv3 hosts.
@@ -252,6 +300,25 @@ The `security_level` option specifies the SNMPv3 security level between Authenti
 * Value can be any of: `noAuthNoPriv`, `authNoPriv`, `authPriv`
 * There is no default value for this setting
 
+*Specifying SNMPv3 settings*
+
+[source,ruby]
+-----
+input {
+  snmp {
+    hosts => [{host => "udp:127.0.0.1/161" version => "3"}]
+    get => ["1.3.6.1.2.1.1.1.0"]
+    security_name => "mySecurityName"
+    auth_protocol => "sha"
+    auth_pass => "ShaPassword"
+    priv_protocol => "aes"
+    priv_pass => "AesPasword"
+    security_level => "authPriv"
+  }
+}
+
+-----
+
 ==== More configuration examples
 
 *Using both `get` and `walk` in the same poll cycle for each host(s)*

data/lib/logstash/inputs/snmp.rb

@@ -56,6 +56,12 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   # as "1.3.6.1.2.mib-2.system.sysDescr.0" would become "mib-2.system.sysDescr.0"
   config :oid_root_skip, :validate => :number, :default => 0
 
+  # number of OID tail digits to retain in event field name. For example, in a numeric OID
+  # like 1.3.6.1.2.1.1.1.0" the last 2 digits could be retained by setting oid_path_length => 2
+  # which would result in a field name "1.0". Similarly, when a MIB is used an OID such as
+  # "1.3.6.1.2.mib-2.system.sysDescr.0" would become "sysDescr.0"
+  config :oid_path_length, :validate => :number, :default => 0
+
   # Set polling interval in seconds
   #
   # The default, `30`, means poll each host every 30 seconds.
@@ -95,6 +101,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
     validate_oids!
     validate_hosts!
     validate_tables!
+    validate_strip!
 
     mib = LogStash::SnmpMib.new
 
@@ -161,7 +168,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
         result = {}
         if !definition[:get].empty?
           begin
-            result = result.merge(definition[:client].get(definition[:get], @oid_root_skip))
+            result = result.merge(definition[:client].get(definition[:get], @oid_root_skip, @oid_path_length))
           rescue => e
             logger.error("error invoking get operation on #{definition[:host_address]} for OIDs: #{definition[:get]}, ignoring", :exception => e, :backtrace => e.backtrace)
           end
@@ -169,7 +176,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
         if  !definition[:walk].empty?
           definition[:walk].each do |oid|
             begin
-              result = result.merge(definition[:client].walk(oid, @oid_root_skip))
+              result = result.merge(definition[:client].walk(oid, @oid_root_skip, @oid_path_length))
             rescue => e
               logger.error("error invoking walk operation on OID: #{oid}, ignoring", :exception => e, :backtrace => e.backtrace)
             end
@@ -179,7 +186,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
         if  !Array(@tables).empty?
           @tables.each do |table_entry|
             begin
-              result = result.merge(definition[:client].table(table_entry, @oid_root_skip))
+              result = result.merge(definition[:client].table(table_entry, @oid_root_skip, @oid_path_length))
             rescue => e
               logger.error("error invoking table operation on OID: #{table_entry['name']}, ignoring", :exception => e, :backtrace => e.backtrace)
             end
@@ -277,4 +284,8 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       end
     end
   end
+
+  def validate_strip!
+    raise(LogStash::ConfigurationError, "you can not specify both oid_root_skip and oid_path_length") if @oid_root_skip > 0 and @oid_path_length > 0
+  end
 end

data/lib/logstash/inputs/snmp/base_client.rb

@@ -45,7 +45,7 @@ module LogStash
       transport.listen()
     end
 
-    def get(oids, strip_root = 0)
+    def get(oids, strip_root = 0, path_length = 0)
       pdu = get_pdu
       Array(oids).each { |oid| pdu.add(VariableBinding.new(OID.new(oid))) }
 
@@ -66,14 +66,14 @@ module LogStash
         variable = variable_binding.getVariable
         value = coerce(variable)
 
-        result[@mib.map_oid(oid, strip_root)] = value
+        result[@mib.map_oid(oid, strip_root, path_length)] = value
       end
 
       result
     end
 
 
-    def walk(oid, strip_root = 0)
+    def walk(oid, strip_root = 0, path_length = 0)
       result = {}
 
       pdufactory = get_pdu_factory
@@ -99,14 +99,14 @@ module LogStash
           variable = var_binding.getVariable
           value = coerce(variable)
 
-          result[@mib.map_oid(oid, strip_root)] = value
+          result[@mib.map_oid(oid, strip_root, path_length)] = value
         end
       end
 
       result
     end
 
-    def table(table, strip_root = 0)
+    def table(table, strip_root = 0, path_length = 0)
       result = {}
       rows = []
       pdufactory = get_pdu_factory
@@ -140,7 +140,7 @@ module LogStash
           oid = var_binding.getOid.toString
           variable = var_binding.getVariable
           value = coerce(variable)
-          mapped_oid = @mib.map_oid(oid, strip_root).sub('.'+idx_val, '')
+          mapped_oid = @mib.map_oid(oid, strip_root, path_length).chomp('.'+idx_val)
           row[mapped_oid] = value
         end
         rows << row

data/lib/logstash/inputs/snmp/mib.rb

@@ -69,7 +69,7 @@ module LogStash
         current.childs[last_node] = node
       end
 
-      def map_oid(oid, strip_root = 0)
+      def map_oid(oid, strip_root = 0, path_length = 0)
         path = Oid.parse(oid)
 
         result = []
@@ -88,7 +88,13 @@ module LogStash
           result << node.name
         end
 
-        result.drop(strip_root).join(".")
+	if strip_root > 0
+	  result.drop(strip_root).join(".")
+	elsif path_length > 0
+	  result.pop(path_length).join(".")
+	else
+	  result.join(".")
+	end
       end
     end
 
@@ -136,8 +142,8 @@ module LogStash
       [module_name, nodes]
     end
 
-    def map_oid(oid, strip_root = 0)
-      @tree.map_oid(oid, strip_root)
+    def map_oid(oid, strip_root = 0, path_length = 0)
+      @tree.map_oid(oid, strip_root, path_length)
     end
 
     private

data/logstash-input-snmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-snmp'
-  s.version       = '1.1.0'
+  s.version       = '1.2.0'
   s.licenses      = ['Apache-2.0']
   s.summary       = "SNMP input plugin"
   s.description   = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/inputs/snmp_spec.rb

@@ -22,6 +22,8 @@ describe LogStash::Inputs::Snmp do
         [
             {"get" => ["1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
             {"get" => [".1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
+            {"get" => [".1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}], "oid_root_skip" => 2},
+            {"get" => [".1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}], "oid_path_length" => 2},
             {"get" => ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
             {"get" => ["1.3.6.1.2.1.1.1.0", ".1.3.6.1.2.1.1"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
             {"walk" => ["1.3.6.1.2.1.1.1"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
@@ -35,6 +37,8 @@ describe LogStash::Inputs::Snmp do
           {"get" => ["test"], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
           {"get" => [], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
           {"get" => "foo", "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
+          {"get" => [".1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}], "oid_path_length" => "a" },
+          {"get" => [".1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:127.0.0.1/161"}], "oid_path_length" => 2, "oid_root_skip" => 2 },
           {"walk" => "foo", "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
           {"tables" => [{"columns" => ["1.2.3.4", "4.3.2.1"]}], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
       ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement