logstash-input-snmp 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e68f50e2d8dce7148c80ccc3a90029b4a0cc1f1039ae72a99be1525df17d89
-  data.tar.gz: 75d01ff55607a5e0aa31251bcdb91d94d75c3009acae39ac82c4dfb0a09feaa4
+  metadata.gz: 213be86518d3d8a674d4227ff23cad9fac2be281fe2d79e9cd6a2e3bc1415b62
+  data.tar.gz: 1334457e8ebfcd7c979fa5bd53870af0205df9fe0842dd1f7e7d4598b653961b
 SHA512:
-  metadata.gz: e2e8ae4ba872e2f55451be69e62108572ff27ea9380eaa29330cd80a42dbfc39cba4bfb4a1f11ef6e087c66f8e4c0d927484a02f093c742c666c6ede031f8cfc
-  data.tar.gz: 7347cab038cb7d1efbee0c8d60c5fe3a13dcedd2986f399ae150feeaa8758f34f0c0a32740f94685b13e172868a52d340f121bcdde81ffb193f9902985722932
+  metadata.gz: 5630fc5e10d784ba79700e2f11216b660194e36317e06ba6060f1459f3825719b28514324e212378a69dcc5b257c8efdaba889c6f65093560a2ae7d51f124314
+  data.tar.gz: 0a888058d97613735f4eb4188963a73e907fa354a7799529153d00c51e58d15a6a232bcc7c0d22eaa8065a3798d3bb48d1f1b5535057e08b4b521647590bac91

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.0
+  - Added support for querying SNMP tables
+  - Changed three error messages in the base_client to include the target address for clarity in the logs.
+
 ## 1.0.1
   - Added no_codec condition to the documentation and bumped version [#39](https://github.com/logstash-plugins/logstash-input-snmp/pull/39)
   - Changed docs to improve options layout [#38](https://github.com/logstash-plugins/logstash-input-snmp/pull/38)

data/CONTRIBUTORS

@@ -3,6 +3,7 @@ reports, or in general have helped logstash along its way.
 
 Contributors:
 * Colin Surprenant - colin.surprenant@gmail.com
+* Dan Major - axrayn@gmail.com
 
 Note: If you've sent us patches, bug reports, or otherwise contributed to
 Logstash, and you aren't on the list above and want to be, please let us know

data/lib/logstash/inputs/snmp.rb

@@ -20,6 +20,9 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   # List of OIDs for which we want to retrieve the subtree of information
   config :walk,:validate => :array # ["1.3.6.1.2.1.1.1.0"]
 
+  # List of tables to walk
+  config :tables, :validate => :array  #[ {"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"]} ]
+
   # List of hosts to query the configured `get` and `walk` options.
   #
   # Each host definition is a hash and must define the `host` key and value.
@@ -91,6 +94,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   def register
     validate_oids!
     validate_hosts!
+    validate_tables!
 
     mib = LogStash::SnmpMib.new
 
@@ -172,6 +176,16 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
           end
         end
 
+        if  !Array(@tables).empty?
+          @tables.each do |table_entry|
+            begin
+              result = result.merge(definition[:client].table(table_entry, @oid_root_skip))
+            rescue => e
+              logger.error("error invoking table operation on OID: #{table_entry['name']}, ignoring", :exception => e, :backtrace => e.backtrace)
+            end
+          end
+        end
+
         unless result.empty?
           metadata = {
             "host_protocol" => definition[:host_protocol],
@@ -217,7 +231,20 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       $1
     end
 
-    raise(LogStash::ConfigurationError, "at least one get OID or one walk OID is required") if @get.empty? && @walk.empty?
+    if !@tables.nil?
+      @tables.each do |table_entry|
+      # Verify oids for valid pattern and get rid of any leading dot if present
+        columns = table_entry["columns"]
+        columns.each do |column|
+          unless column =~ OID_REGEX
+      	    raise(Logstash::ConfigurationError, "The table column oid '#{column}' is an invalid format")
+          end
+        end
+        $1
+      end
+    end
+
+    raise(LogStash::ConfigurationError, "at least one get OID, one walk OID, or one table OID is required") if @get.empty? && @walk.empty? && @tables.nil?
   end
 
   def validate_v3_user!
@@ -242,4 +269,12 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       raise(LogStash::ConfigurationError, "each host definition must have a \"host\" option") if !host.is_a?(Hash) || host["host"].nil?
     end
   end
+  
+  def validate_tables!
+    if !@tables.nil?
+      @tables.each do |table_entry|
+        raise(LogStash::ConfigurationError, "each table definition must have a \"name\" option") if !table_entry.is_a?(Hash) || table_entry["name"].nil?
+      end
+    end
+  end
 end

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

@@ -18,6 +18,7 @@ java_import "org.snmp4j.smi.OctetString"
 java_import "org.snmp4j.smi.VariableBinding"
 java_import "org.snmp4j.transport.DefaultUdpTransportMapping"
 java_import "org.snmp4j.transport.DefaultTcpTransportMapping"
+java_import "org.snmp4j.util.TableUtils"
 java_import "org.snmp4j.util.TreeUtils"
 java_import "org.snmp4j.util.DefaultPDUFactory"
 java_import "org.snmp4j.asn1.BER"
@@ -52,11 +53,11 @@ module LogStash
       return nil if response_event.nil?
 
       e = response_event.getError
-      raise(SnmpClientError, "error sending snmp get request: #{e.inspect}, #{e.getMessage}") if e
+      raise(SnmpClientError, "error sending snmp get request to target #{@target.address}: #{e.inspect}, #{e.getMessage}") if e
 
       result = {}
       response_pdu = response_event.getResponse
-      raise(SnmpClientError, "timeout sending snmp get request") if response_pdu.nil?
+      raise(SnmpClientError, "timeout sending snmp get request to target #{@target.address}") if response_pdu.nil?
 
       size = response_pdu.size
       (0..size - 1).each do |i|
@@ -85,7 +86,7 @@ module LogStash
 
         if event.isError
           # TODO: see if we can salvage non errored event here
-          raise(SnmpClientError, "error sending snmp walk request: #{event.getErrorMessage}")
+          raise(SnmpClientError, "error sending snmp walk request to target #{@target.address}: #{event.getErrorMessage}")
         end
 
         var_bindings = event.getVariableBindings
@@ -105,6 +106,49 @@ module LogStash
       result
     end
 
+    def table(table, strip_root = 0)
+      result = {}
+      rows = []
+      pdufactory = get_pdu_factory
+      table_name = table["name"]
+      tableUtils = TableUtils.new(@snmp, pdufactory)
+
+      colOID = Array.new
+      Array(table["columns"]).each { |oid| colOID << OID.new(oid) }
+
+      events = tableUtils.getTable(@target, colOID.to_java(org.snmp4j.smi.OID), nil, nil)
+
+      return nil if events.nil? || events.size == 0
+      events.each do |event|
+        next if event.nil?
+
+        if event.isError
+          # TODO: see if we can salvage non errored event here
+          raise(SnmpClientError, "error sending snmp table request to target #{@target.address}: #{event.getErrorMessage}")
+        end
+
+        row = {}
+        idx_val = event.getIndex.toString
+        row["index"] = idx_val
+
+        var_bindings = event.getColumns
+        next if var_bindings.nil? || var_bindings.size == 0
+
+        var_bindings.each do |var_binding|
+          next if var_binding.nil?
+
+          oid = var_binding.getOid.toString
+          variable = var_binding.getVariable
+          value = coerce(variable)
+          mapped_oid = @mib.map_oid(oid, strip_root).sub('.'+idx_val, '')
+          row[mapped_oid] = value
+        end
+        rows << row
+      end
+      result[table_name] = rows
+      result
+    end
+
     protected
 
     NULL_STRING = "null".freeze

data/logstash-input-snmp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-snmp'
-  s.version       = '1.0.1'
+  s.version       = '1.1.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

@@ -24,6 +24,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", "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"}]},
+            {"tables" => [{"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"]}], "hosts" => [{"host" => "udp:127.0.0.1/161"}]},
         ]
     }
 
@@ -33,6 +35,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"}]},
+          {"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.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement