logstash-integration-snmp 4.3.0-java → 4.4.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e4f7e4d6dbba653ef3de8662d2d8d0c78fa5b690482d39a276061ac9c6889c
-  data.tar.gz: 4454382e046d542df2f34aadc5d41586f5c9e813fe560782e10f7ef42212a4ec
+  metadata.gz: 2a79607b130f6d5e1b16fa3979be1cddad462aae22e58a481888a35bebbb0c09
+  data.tar.gz: 17add7304deab345d2e8b77d58e95835749ccd4c710176aa3b89aedca27578ac
 SHA512:
-  metadata.gz: 2dcc0cc28a4fad102391877207ff623c49851de0539123e9b9b58fb76449714cb31e655628c63c535089a6c26961be7cf33eb508aa9c80a4214b99a7524bb89f
-  data.tar.gz: a077b38b4357d6882a181ea95df1a87b205e284f7903d8f3b342b7a383b17e5c596a0e060ed9feeba37404f536de436c86d2597e7d7f33faed6217a632e8ca4e
+  metadata.gz: 22fee9ee3c1b9bcf88682db9fe6ed721c1cb01e46adaacf98e953fe015ef1ff0848b03e0340d0cd26b2e171ace49c9f1d61853de92b41518c89a2cbb2b6a849e
+  data.tar.gz: f94e7f9442e9d3078e2bc519b37e413640081137af6911c8ca114f1b366df86054164c4ec192e924d8add40e5b0fc56f56007f8fd1ae21752729e90e29b396ca

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.4.0
+  - Expose `max_repetitions` config option to the SNMP input plugin, allowing users to control the max-repetitions field in GETBULK PDUs used by walk and table operations. [#97](https://github.com/logstash-plugins/logstash-integration-snmp/pull/97)
+
+## 4.3.1
+  - Fix: generate error events with _snmpfailure tag when all SNMP operations fail and the response data is empty (e.g., timeout) [#92](https://github.com/logstash-plugins/logstash-integration-snmp/pull/92)
+
 ## 4.3.0
   - Handle partial responses and errors gracefully: add `tag_on_failure` (default: `["_snmpfailure"]`) to tag events when SNMP operations fail, and `allow_partial_response` (default: `false`) to preserve partial data from failed `walk`/`table` operations [#91](https://github.com/logstash-plugins/logstash-integration-snmp/pull/91)
 

data/VERSION

@@ -1 +1 @@
-4.3.0
+4.4.0

data/docs/input-snmp.asciidoc

@@ -78,6 +78,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-allow_partial_response>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-local_engine_id>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-max_repetitions>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-mib_paths>> |<<path,path>>|No
 | <<plugins-{type}s-{plugin}-oid_mapping_format>> |<<string,string>>, one of `["default", "ruby_snmp", "dotted_string"]`|No
 | <<plugins-{type}s-{plugin}-oid_map_field_values>> |<<boolean,boolean>>|No
@@ -217,6 +218,32 @@ If polling all configured hosts takes longer than this interval, a warning will
 The SNMPv3 local engine ID. Its length must be greater or equal than 5 and less or equal than 32.
 If not provided, a default ID is generated based on the local IP address and additional four random bytes.
 
+[id="plugins-{type}s-{plugin}-max_repetitions"]
+===== `max_repetitions`
+
+  * Value type is <<number,number>>
+  * Default value is `10`
+
+The `max_repetitions` option sets the max-repetitions field in GETBULK PDUs used by `walk` and `table` operations.
+This value controls how many OID rows are returned in each GETBULK response from the SNMP agent.
+
+A smaller value may help avoid timeouts when polling devices with large tables or limited resources.
+A larger value can improve performance by reducing the number of round trips needed to retrieve a full table.
+
+If not set, the SNMP4J library default of `10` is used.
+
+Example
+[source,ruby]
+-----
+input {
+  snmp {
+    walk => ["1.3.6.1.2.1.2.2"]
+    hosts => [{host => "udp:127.0.0.1/161" community => "public"}]
+    max_repetitions => 5
+  }
+}
+-----
+
 [id="plugins-{type}s-{plugin}-mib_paths"]
 ===== `mib_paths`
 

data/lib/logstash/inputs/snmp.rb

@@ -67,6 +67,11 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   # Timeout in milliseconds to execute all hosts configured operations (get, walk, table).
   config :poll_hosts_timeout, :validate => :number
 
+  # Sets the maximum number of repetitions for GETBULK requests used in `walk` and `table` operations.
+  # This controls how many rows are returned per PDU in SNMPv2c/v3 GETBULK requests.
+  # Lowering this value may help avoid timeouts when polling devices with large tables.
+  config :max_repetitions, :validate => :number, :default => 10
+
   # Append values to the `tags` field when one or more SNMP operations fail
   config :tag_on_failure, :validate => :array, :default => ['_snmpfailure']
 
@@ -195,7 +200,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       definition = req[:definition]
       result_consumer = lambda do |request_result|
         result = request_result.data
-        if result&.any?
+        if result&.any? || request_result.has_errors
           event = targeted_event_factory.new_event(result)
           event.set(@host_protocol_field, definition[:host_protocol])
           event.set(@host_address_field, definition[:host_address])
@@ -263,6 +268,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
     validate_hosts!
     validate_tables!
     validate_local_engine_id!
+    validate_max_repetitions!
   end
 
   def validate_oids!
@@ -328,6 +334,12 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
     end
   end
 
+  def validate_max_repetitions!
+    if @max_repetitions <= 0
+      raise(LogStash::ConfigurationError, '`max_repetitions` must be a positive integer')
+    end
+  end
+
   def create_request_aggregator
     SnmpClientRequestAggregator.new(@threads, 'SnmpRequestWorker')
   end
@@ -335,6 +347,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   def build_client!(mib_manager, supported_transports, hosts_versions)
     client_builder = org.logstash.snmp.SnmpClient.builder(mib_manager, supported_transports)
     client_builder.setLocalEngineId(@local_engine_id) unless @local_engine_id.nil?
+    client_builder.setMaxRepetitions(@max_repetitions)
 
     build_snmp_client!(client_builder, validate_usm_user: hosts_versions.include?('3'))
   end

data/lib/logstash-integration-snmp_jars.rb

@@ -4,4 +4,4 @@ require 'jar_dependencies'
 require_jar('org.snmp4j', 'snmp4j-log4j', '2.8.11')
 require_jar('org.snmp4j', 'snmp4j', '3.8.0')
 require_jar('org.snakeyaml', 'snakeyaml-engine', '2.7')
-require_jar('org.logstash.integrations', 'plugin', '4.3.0')
+require_jar('org.logstash.integrations', 'plugin', '4.4.0')

data/spec/unit/inputs/snmp_spec.rb

@@ -342,21 +342,41 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
         })
       end
 
-      before(:each) do
-        expect(mock_aggregator_request).to receive(:get)
-        expect(mock_aggregator_request).to receive(:get_result_async) do |consumer|
-          consumer.call(RequestResult.new({ 'foo' => 'bar' }, true))
+      context 'when result data is not empty' do
+        before(:each) do
+          expect(mock_aggregator_request).to receive(:get)
+          expect(mock_aggregator_request).to receive(:get_result_async) do |consumer|
+            consumer.call(RequestResult.new({ 'foo' => 'bar' }, true))
+          end
+        end
+
+        it 'should tag event with default failure tag' do
+          plugin.register
+          plugin.poll_clients(queue)
+          event = queue.pop
+
+          expect(event.get("foo")).to eq("bar")
+          expect(event.get("tags")).to include("_snmpfailure")
+          expect(event.get("_snmp_request_errors")).to be_nil
         end
       end
 
-      it 'should tag event with default failure tag' do
-        plugin.register
-        plugin.poll_clients(queue)
-        event = queue.pop
+      context 'when result data is empty' do
+        before(:each) do
+          expect(mock_aggregator_request).to receive(:get)
+          expect(mock_aggregator_request).to receive(:get_result_async) do |consumer|
+            consumer.call(RequestResult.new({}, true))
+          end
+        end
 
-        expect(event.get("foo")).to eq("bar")
-        expect(event.get("tags")).to include("_snmpfailure")
-        expect(event.get("_snmp_request_errors")).to be_nil
+        it 'should generate an event with failure tag when all operations fail' do
+          plugin.register
+          plugin.poll_clients(queue)
+          event = queue.pop
+
+          expect(event).not_to be_nil
+          expect(event.get("tags")).to include("_snmpfailure")
+        end
       end
     end
 
@@ -364,41 +384,32 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
       let(:config) do
         super().merge({
           'get' => ['1.3.6.1.2.1.1.1.0'],
-          'hosts' => [{ 'host' => 'udp:127.0.0.1/161', 'community' => 'public' }],
-          'allow_partial_response' => allow_partial_response_value
+          'hosts' => [{ 'host' => 'udp:127.0.0.1/161', 'community' => 'public' }]
         })
       end
 
       before(:each) do
-        expect(mock_aggregator_request).to receive(:get)
-        expect(mock_aggregator_request).to receive(:get_result_async) do |consumer|
-          consumer.call(RequestResult.new({ 'partial' => 'data' }, true))
-        end
+        allow(mock_aggregator_request).to receive(:get)
+        allow(mock_aggregator_request).to receive(:get_result_async)
       end
 
       context 'when set to false (default)' do
-        let(:allow_partial_response_value) { false }
+        let(:config) { super().merge('allow_partial_response' => false) }
 
-        it 'tags event and preserves data from successful operations' do
+        it 'uses complete result aggregator' do
+          expect(mock_aggregator).to receive(:create_request_for_complete_result).and_return(mock_aggregator_request)
           plugin.register
           plugin.poll_clients(queue)
-          event = queue.pop
-
-          expect(event.get("partial")).to eq("data")
-          expect(event.get("tags")).to include("_snmpfailure")
         end
       end
 
       context 'when set to true' do
-        let(:allow_partial_response_value) { true }
+        let(:config) { super().merge('allow_partial_response' => true) }
 
-        it 'tags event and preserves data including partial results' do
+        it 'uses partial result aggregator' do
+          expect(mock_aggregator).to receive(:create_request_for_partial_result).and_return(mock_aggregator_request)
           plugin.register
           plugin.poll_clients(queue)
-          event = queue.pop
-
-          expect(event.get("partial")).to eq("data")
-          expect(event.get("tags")).to include("_snmpfailure")
         end
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-snmp
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: java
 authors:
 - Elastic
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -468,7 +468,7 @@ files:
 - spec/unit/inputs/common_spec.rb
 - spec/unit/inputs/snmp_spec.rb
 - spec/unit/inputs/snmptrap_spec.rb
-- vendor/jar-dependencies/org/logstash/integrations/plugin/4.3.0/plugin-4.3.0.jar
+- vendor/jar-dependencies/org/logstash/integrations/plugin/4.4.0/plugin-4.4.0.jar
 - vendor/jar-dependencies/org/snakeyaml/snakeyaml-engine/2.7/snakeyaml-engine-2.7.jar
 - vendor/jar-dependencies/org/snmp4j/snmp4j-log4j/2.8.11/snmp4j-log4j-2.8.11.jar
 - vendor/jar-dependencies/org/snmp4j/snmp4j/3.8.0/snmp4j-3.8.0.jar