logstash-input-snmp 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 747dbf68d6a90a7ab937bf8c64edef786b7d0c4c0ac2f97088401d1e842c2616
-  data.tar.gz: e53514a31810159796b3e80ee56f7aa6d66eba23ac781744fd9fbf0be83d4d9a
+  metadata.gz: 13fdcfbd3e486a466a7fa32e1de3e6bbdccd30779f5eb4fce9ef8645355c8322
+  data.tar.gz: b8e80f54fbe399f262e48aff1fd614d578b16d493cded3e15446593ebffd1f93
 SHA512:
-  metadata.gz: fa84badc45e056d01ca6a8668e3b5a2ddf89348339f49524b60b77843753cb7eb51fe2fcfe40d2d61dfc95523988f1fa6e11cc430692bbbe38d0014371c62278
-  data.tar.gz: 9e8e9895750a23892e99b2c198eef3e66f75de885e700dcea020d00356e843a022bd5dae6894a390f9f64faea40ea0f15310dbc7b34ef1fa96947b15d9d1a45b
+  metadata.gz: fc44139cfc59066ffa89fc916903e4507972b9650cc056ee0bb897a8028dcf93abf30c07627926ce717a0da275d084ebf45b7e631355d04752ef55e868eef3f7
+  data.tar.gz: 1ca064497bd573c6d3de4c00bf0d744fb14339926d61203d6a7e74fcbb6887c64f784e32ecb579db11fc2ff849c329b7479df92a44b24803d653b316ab41cbd6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.3.1
+  -  Refactor: handle no response(s) wout error logging [#105](https://github.com/logstash-plugins/logstash-input-snmp/pull/105)
+
 ## 1.3.0
   - Feat: ECS compliance + optional target [#99](https://github.com/logstash-plugins/logstash-input-snmp/pull/99)
   - Internal: update to Gradle 7 [#102](https://github.com/logstash-plugins/logstash-input-snmp/pull/102)

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

@@ -52,13 +52,13 @@ module LogStash
     end
 
     def walk(oid, strip_root = 0, path_length = 0)
-      result = {}
-
       pdufactory = get_pdu_factory
       treeUtils = TreeUtils.new(@snmp, pdufactory)
       events = treeUtils.getSubtree(@target, OID.new(oid))
       return nil if events.nil? || events.size == 0
 
+      result = {}
+
       events.each do |event|
         next if event.nil?
 

data/lib/logstash/inputs/snmp.rb

@@ -192,53 +192,73 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
 
   def run(queue)
     # for now a naive single threaded poller which sleeps off the remaining interval between
-    # each run. each run polls all the defined hosts for the get and walk options.
+    # each run. each run polls all the defined hosts for the get, table and walk options.
     stoppable_interval_runner.every(@interval, "polling hosts") do
-      @client_definitions.each do |definition|
-        client = definition[:client]
-        result = {}
-        if !definition[:get].empty?
-          oids = definition[:get]
-          begin
-            result = result.merge(client.get(oids, @oid_root_skip, @oid_path_length))
-          rescue => e
-            logger.error("error invoking get operation for OIDs: #{oids}, ignoring",
-                         host: definition[:host_address], exception: e, backtrace: e.backtrace)
+      poll_clients(queue)
+    end
+  end
+
+  def poll_clients(queue)
+    @client_definitions.each do |definition|
+      client = definition[:client]
+      host = definition[:host_address]
+      result = {}
+
+      if !definition[:get].empty?
+        oids = definition[:get]
+        begin
+          data = client.get(oids, @oid_root_skip, @oid_path_length)
+          if data
+            result.update(data)
+          else
+            logger.debug? && logger.debug("get operation returned no response", host: host, oids: oids)
           end
+        rescue => e
+          logger.error("error invoking get operation, ignoring", host: host, oids: oids, exception: e, backtrace: e.backtrace)
         end
-        if !definition[:walk].empty?
-          definition[:walk].each do |oid|
-            begin
-              result = result.merge(client.walk(oid, @oid_root_skip, @oid_path_length))
-            rescue => e
-              logger.error("error invoking walk operation on OID: #{oid}, ignoring",
-                           host: definition[:host_address], exception: e, backtrace: e.backtrace)
+      end
+
+      if !definition[:walk].empty?
+        definition[:walk].each do |oid|
+          begin
+            data = client.walk(oid, @oid_root_skip, @oid_path_length)
+            if data
+              result.update(data)
+            else
+              logger.debug? && logger.debug("walk operation returned no response", host: host, oid: oid)
             end
+          rescue => e
+            logger.error("error invoking walk operation, ignoring", host: host, oid: oid, exception: e, backtrace: e.backtrace)
           end
         end
+      end
 
-        if !Array(@tables).empty?
-          @tables.each do |table_entry|
-            begin
-              result = result.merge(client.table(table_entry, @oid_root_skip, @oid_path_length))
-            rescue => e
-              logger.error("error invoking table operation on OID: #{table_entry['name']}, ignoring",
-                           host: definition[:host_address], exception: e, backtrace: e.backtrace)
+      if !Array(@tables).empty?
+        @tables.each do |table_entry|
+          begin
+            data = client.table(table_entry, @oid_root_skip, @oid_path_length)
+            if data
+              result.update(data)
+            else
+              logger.debug? && logger.debug("table operation returned no response", host: host, table: table_entry)
             end
+          rescue => e
+            logger.error("error invoking table operation, ignoring",
+                         host: host, table_name: table_entry['name'], exception: e, backtrace: e.backtrace)
           end
         end
+      end
 
-        unless result.empty?
-          event = targeted_event_factory.new_event(result)
-          event.set(@host_protocol_field, definition[:host_protocol])
-          event.set(@host_address_field, definition[:host_address])
-          event.set(@host_port_field, definition[:host_port])
-          event.set(@host_community_field, definition[:host_community])
-          decorate(event)
-          queue << event
-        else
-          logger.debug? && logger.debug("no snmp data retrieved", host: definition[:host_address])
-        end
+      unless result.empty?
+        event = targeted_event_factory.new_event(result)
+        event.set(@host_protocol_field, definition[:host_protocol])
+        event.set(@host_address_field, definition[:host_address])
+        event.set(@host_port_field, definition[:host_port])
+        event.set(@host_community_field, definition[:host_community])
+        decorate(event)
+        queue << event
+      else
+        logger.debug? && logger.debug("no snmp data retrieved", host: definition[:host_address])
       end
     end
   end

data/logstash-input-snmp.gemspec

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

@@ -136,43 +136,46 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
 
     before(:each) do
       allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
-    end
 
-    before do
       expect(LogStash::SnmpClient).to receive(:new).and_return(mock_client)
-      expect(mock_client).to receive(:get).and_return({"foo" => "bar"})
       # devutils in v6 calls close on the test pipelines while it does not in v7+
-      expect(mock_client).to receive(:close).at_most(:once)
+      allow(mock_client).to receive(:close).at_most(:once)
     end
 
-    it "shoud add @metadata fields and add default host field" do
-      config = <<-CONFIG
+    context 'mocked get' do
+
+      before do
+        expect(mock_client).to receive(:get).and_return({"foo" => "bar"})
+      end
+
+      it "shoud add @metadata fields and add default host field" do
+        config = <<-CONFIG
           input {
             snmp {
               get => ["1.3.6.1.2.1.1.1.0"]
               hosts => [{ host => "udp:127.0.0.1/161" community => "public" }]
             }
           }
-      CONFIG
-      event = input(config) { |_, queue| queue.pop }
-
-      if ecs_select.active_mode == :disabled
-        expect(event.get("[@metadata][host_protocol]")).to eq("udp")
-        expect(event.get("[@metadata][host_address]")).to eq("127.0.0.1")
-        expect(event.get("[@metadata][host_port]")).to eq("161")
-        expect(event.get("[@metadata][host_community]")).to eq("public")
-        expect(event.get("host")).to eql("127.0.0.1")
-      else
-        expect(event.get("[@metadata][input][snmp][host][protocol]")).to eq("udp")
-        expect(event.get("[@metadata][input][snmp][host][address]")).to eq("127.0.0.1")
-        expect(event.get("[@metadata][input][snmp][host][port]")).to eq('161')
-        expect(event.get("[@metadata][input][snmp][host][community]")).to eq("public")
-        expect(event.get("host")).to eql('ip' => "127.0.0.1")
+        CONFIG
+        event = input(config) { |_, queue| queue.pop }
+
+        if ecs_select.active_mode == :disabled
+          expect(event.get("[@metadata][host_protocol]")).to eq("udp")
+          expect(event.get("[@metadata][host_address]")).to eq("127.0.0.1")
+          expect(event.get("[@metadata][host_port]")).to eq("161")
+          expect(event.get("[@metadata][host_community]")).to eq("public")
+          expect(event.get("host")).to eql("127.0.0.1")
+        else
+          expect(event.get("[@metadata][input][snmp][host][protocol]")).to eq("udp")
+          expect(event.get("[@metadata][input][snmp][host][address]")).to eq("127.0.0.1")
+          expect(event.get("[@metadata][input][snmp][host][port]")).to eq('161')
+          expect(event.get("[@metadata][input][snmp][host][community]")).to eq("public")
+          expect(event.get("host")).to eql('ip' => "127.0.0.1")
+        end
       end
-    end
 
-    it "should add custom host field (legacy metadata)" do
-      config = <<-CONFIG
+      it "should add custom host field (legacy metadata)" do
+        config = <<-CONFIG
           input {
             snmp {
               get => ["1.3.6.1.2.1.1.1.0"]
@@ -180,14 +183,14 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
               add_field => { host => "%{[@metadata][host_protocol]}:%{[@metadata][host_address]}/%{[@metadata][host_port]},%{[@metadata][host_community]}" }
             }
           }
-      CONFIG
-      event = input(config) { |_, queue| queue.pop }
+        CONFIG
+        event = input(config) { |_, queue| queue.pop }
 
-      expect(event.get("host")).to eq("udp:127.0.0.1/161,public")
-    end if ecs_select.active_mode == :disabled
+        expect(event.get("host")).to eq("udp:127.0.0.1/161,public")
+      end if ecs_select.active_mode == :disabled
 
-    it "should add custom host field (ECS mode)" do
-      config = <<-CONFIG
+      it "should add custom host field (ECS mode)" do
+        config = <<-CONFIG
           input {
             snmp {
               get => ["1.3.6.1.2.1.1.1.0"]
@@ -195,14 +198,14 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
               add_field => { "[host][formatted]" => "%{[@metadata][input][snmp][host][protocol]}://%{[@metadata][input][snmp][host][address]}:%{[@metadata][input][snmp][host][port]}" }
             }
           }
-      CONFIG
-      event = input(config) { |_, queue| queue.pop }
+        CONFIG
+        event = input(config) { |_, queue| queue.pop }
 
-      expect(event.get("host")).to eq('formatted' => "tcp://192.168.1.11:1161")
-    end if ecs_select.active_mode != :disabled
+        expect(event.get("host")).to eq('formatted' => "tcp://192.168.1.11:1161")
+      end if ecs_select.active_mode != :disabled
 
-    it "should target event data" do
-      config = <<-CONFIG
+      it "should target event data" do
+        config = <<-CONFIG
           input {
             snmp {
               get => ["1.3.6.1.2.1.1.1.0"]
@@ -210,12 +213,92 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
               target => "snmp_data"
             }
           }
-      CONFIG
-      event = input(config) { |_, queue| queue.pop }
+        CONFIG
+        event = input(config) { |_, queue| queue.pop }
+
+        expect( event.include?('foo') ).to be false
+        expect( event.get('[snmp_data]') ).to eql 'foo' => 'bar'
+      end
 
-      expect( event.include?('foo') ).to be false
-      expect( event.get('[snmp_data]') ).to eql 'foo' => 'bar'
     end
+
+    context 'mocked nil get response' do
+
+      let(:config) do
+        {
+            'get' => ["1.3.6.1.2.1.1.1.0"],
+            "hosts" => [{"host" => "udp:127.0.0.1/161", "community" => "public"}]
+        }
+      end
+
+      let(:logger) { double("Logger").as_null_object }
+
+      before do
+        expect(mock_client).to receive(:get).once.and_return(nil)
+        allow_any_instance_of(described_class).to receive(:logger).and_return(logger)
+        expect(logger).not_to receive(:error)
+      end
+
+      it 'generates no events when client returns no response' do
+        input = described_class.new(config).tap { |input| input.register }
+        input.poll_clients queue = Queue.new
+
+        expect( queue.size ).to eql 0
+      end
+    end
+
+    context 'mocked nil table response' do
+
+      let(:config) do
+        {
+            'tables' => [
+                { 'name' => "a1Table", 'columns' => ["1.3.6.1.4.1.3375.2.2.5.2.3.1.1"] }
+            ],
+            "hosts" => [{"host" => "udp:127.0.0.1/161", "community" => "public"}]
+        }
+      end
+
+      let(:logger) { double("Logger").as_null_object }
+
+      before do
+        expect(mock_client).to receive(:table).once.and_return(nil)
+        allow_any_instance_of(described_class).to receive(:logger).and_return(logger)
+        expect(logger).not_to receive(:error)
+      end
+
+      it 'generates no events when client returns no response' do
+        input = described_class.new(config).tap { |input| input.register }
+        input.poll_clients queue = Queue.new
+
+        expect( queue.size ).to eql 0
+      end
+    end
+
+    context 'mocked nil walk response' do
+
+      let(:config) do
+        {
+            'walk' => ["1.3.6.1.2.1.1"],
+            "hosts" => [{"host" => "udp:127.0.0.1/161", "community" => "public"}]
+        }
+      end
+
+      let(:logger) { double("Logger").as_null_object }
+
+      before do
+        expect(mock_client).to receive(:walk).once.and_return(nil)
+        allow_any_instance_of(described_class).to receive(:logger).and_return(logger)
+        expect(logger).not_to receive(:error)
+      end
+
+      it 'generates no events when client returns no response' do
+        input = described_class.new(config).tap { |input| input.register }
+        input.poll_clients queue = Queue.new
+
+        expect( queue.size ).to eql 0
+      end
+    end
+
   end
 
   context "StoppableIntervalRunner" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement