logstash-input-snmp 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13fdcfbd3e486a466a7fa32e1de3e6bbdccd30779f5eb4fce9ef8645355c8322
-  data.tar.gz: b8e80f54fbe399f262e48aff1fd614d578b16d493cded3e15446593ebffd1f93
+  metadata.gz: 10af98fea9ec23b72d7b713cd503c4b34167cf5cebd494f4e73e52f5b02a12c1
+  data.tar.gz: f009f89f26dc5b8fff9d3fa07dacd577999c13589a175417178db1219063c98c
 SHA512:
-  metadata.gz: fc44139cfc59066ffa89fc916903e4507972b9650cc056ee0bb897a8028dcf93abf30c07627926ce717a0da275d084ebf45b7e631355d04752ef55e868eef3f7
-  data.tar.gz: 1ca064497bd573c6d3de4c00bf0d744fb14339926d61203d6a7e74fcbb6887c64f784e32ecb579db11fc2ff849c329b7479df92a44b24803d653b316ab41cbd6
+  metadata.gz: 1db41b3f534bac5a03dbfd45210ebe2e944b361029d80e1bcc1131c4b1e35f363b72c07ad7771a3c54eca21c31b67e11fac8a725bcabd0b31e11a68bdbecdbdd
+  data.tar.gz: ece59ff5c72ccea90e8223fed33978ed4a7b6d486928d6c63eaf8f5696d85ec41e3a352ead03e6bcdb9abca8ae60a9fe5da6908f1a1cb43ea72666461b13cd8a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.3.3
+  - Silence warnings when loading dictionary MIB files [#118](https://github.com/logstash-plugins/logstash-input-snmp/pull/118)
+
+## 1.3.2
+  -  [DOC] Add troubleshooting help for "failed to locate MIB module" error when using smidump to convert MIBs [#112](https://github.com/logstash-plugins/logstash-input-snmp/pull/112)
+  -  Fix CI failures [#113](https://github.com/logstash-plugins/logstash-input-snmp/pull/113)
+
 ## 1.3.1
   -  Refactor: handle no response(s) wout error logging [#105](https://github.com/logstash-plugins/logstash-input-snmp/pull/105)
 
@@ -12,7 +19,7 @@
   - Added integration tests to ensure SNMP server and IPv6 connections [#90](https://github.com/logstash-plugins/logstash-input-snmp/issues/90). Fixes[#87](https://github.com/logstash-plugins/logstash-input-snmp/issues/87).
 
 ## 1.2.6
-  - Docs: example on setting IPv6 hosts [#89](https://github.com/logstash-plugins/logstash-input-snmp/pull/89)
+  - [DOC] Add example on setting IPv6 hosts [#89](https://github.com/logstash-plugins/logstash-input-snmp/pull/89)
 
 ## 1.2.5
   - Updated snmp4j library to v2.8.4 [#86](https://github.com/logstash-plugins/logstash-input-snmp/pull/86)

data/README.md

@@ -17,7 +17,7 @@ Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/log
 
 ## Developing
 
-### 1. Plugin Developement and Testing
+### 1. Plugin Development and Testing
 
 #### Code
 - To get started, you'll need JRuby with the Bundler gem installed.

data/docs/index.asciidoc

@@ -54,7 +54,7 @@ libsmi is available and installable on most operating systems.
 
 To import a MIB, you need to first convert the ASN.1 MIB file into a `.dic` file using the libsmi `smidump` command line utility.
 
-Example (using `RFC1213-MIB` file)
+*Example (using `RFC1213-MIB` file)*
 
 [source,sh]
 -----
@@ -63,6 +63,48 @@ $ smidump --level=1 -k -f python RFC1213-MIB > RFC1213-MIB.dic
 
 Note that the resulting file as output by `smidump` must have the `.dic` extension.
 
+[id="plugins-{type}s-{plugin}-locate-mibs"]
+===== Preventing a `failed to locate MIB module` error 
+
+The `smidump` function looks for mib dependencies in its pre-configured path lists.
+You may need to provide the paths to locations of MIBs in your particular environment.
+
+You can avoid  to avoid a `failed to locate MIB module` error by providing the additional path configuration information with:
+
+* an environment variable, or 
+* a config file to provide the additional path configuration.
+
+See the "MODULE LOCATIONS" section of the https://www.ibr.cs.tu-bs.de/projects/libsmi/smi_config.html[smi_config documentation] for more info. 
+
+[id="plugins-{type}s-{plugin}-env-var"]
+===== Option 1: Use an environment variable 
+
+Set the `SMIPATH` env var with the path to your mibs.
+Be sure to include a prepended colon (`:`) for the path.
+
+[source,sh]
+-----
+$ SMIPATH=":/path/to/mibs/" smidump -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.dic <1>
+-----
+<1> Notice the colon that preceeds the path definition. 
+
+[id="plugins-{type}s-{plugin}-mib-config"]
+===== Option 2: Provide a coniguration file
+
+The other approach is to create a configuration file with the `path` option. For example, you could create a file called `smi.conf`.
+
+[source,sh]
+-----
+path :/path/to/mibs/
+-----
+
+Use the config with smidump:
+
+[source,sh]
+-----
+$ smidump -c smi.conf -k -f python CISCO-PROCESS-MIB.mib > CISCO-PROCESS-MIB_my.dic
+-----
+
 [id="plugins-{type}s-{plugin}-options"]
 ==== SNMP Input Configuration Options
 

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

@@ -157,11 +157,23 @@ module LogStash
         sub('MIB =', 'mib =')
 
       mib = nil
-      eval(mib_hash)
+      silence_warnings do
+        eval(mib_hash)
+      end
       mib
     rescue Exception => e
       # rescuing Exception class is important here to rescue SyntaxError from eval
       raise(SnmpMibError, "error parsing mib dic file: #{filename}, error: #{e.message}")
     end
+
+    # MIB definition files may have duplicate entries that, since Ruby 2.7, generate warnings when they are converted to a hash.
+    # This method will suppress these warnings, unless `debug` logging is enabled.
+    def silence_warnings
+      warn_level = $VERBOSE
+      $VERBOSE = logger.debug? ? warn_level : nil
+      yield
+    ensure
+      $VERBOSE = warn_level
+    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.1'
+  s.version       = '1.3.3'
   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/integration/it_spec.rb

@@ -2,7 +2,7 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/inputs/snmp"
 
 describe LogStash::Inputs::Snmp do
-  let(:config) { {"get" => ["1.3.6.1.2.1.1.1.0", "1.3.6.1.2.1.1.3.0", "1.3.6.1.2.1.1.5.0"]} }
+  let(:config) { {"get" => %w[1.3.6.1.2.1.1.1.0 1.3.6.1.2.1.1.3.0 1.3.6.1.2.1.1.5.0], "ecs_compatibility" => "disabled" } }
   let(:plugin) { LogStash::Inputs::Snmp.new(config)}
 
   shared_examples "snmp plugin return single event" do
@@ -114,8 +114,8 @@ describe LogStash::Inputs::Snmp do
   end
 
   describe "multiple pipelines and mix of udp tcp hosts", :integration => true do
-    let(:config) { {"get" => ["1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:snmp1/161", "community" => "public"}]} }
-    let(:config2) { {"get" => ["1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "tcp:snmp2/162", "community" => "public"}]} }
+    let(:config) { {"get" => ["1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "udp:snmp1/161", "community" => "public"}], "ecs_compatibility" => "disabled" } }
+    let(:config2) { {"get" => ["1.3.6.1.2.1.1.1.0"], "hosts" => [{"host" => "tcp:snmp2/162", "community" => "public"}], "ecs_compatibility" => "disabled"} }
     let(:plugin) { LogStash::Inputs::Snmp.new(config)}
     let(:plugin2) { LogStash::Inputs::Snmp.new(config2)}
 
@@ -148,10 +148,12 @@ describe LogStash::Inputs::Snmp do
           snmp {
             get => ["1.3.6.1.2.1.1.1.0"]
             hosts => [{host => "udp:snmp1/161" community => "public"}]
+            ecs_compatibility => "disabled"
           }
           snmp {
             get => ["1.3.6.1.2.1.1.1.0"]
             hosts => [{host => "tcp:snmp2/162" community => "public"}]
+            ecs_compatibility => "disabled"
           }
         }
     CONFIG
@@ -171,6 +173,7 @@ describe LogStash::Inputs::Snmp do
             priv_protocol => "aes"
             priv_pass => "STr0ngP@SSWRD161"
             security_level => "authPriv"
+            ecs_compatibility => "disabled"
           }
           snmp {
             get => ["1.3.6.1.2.1.1.1.0"]
@@ -181,6 +184,7 @@ describe LogStash::Inputs::Snmp do
             priv_protocol => "aes"
             priv_pass => "STr0ngP@SSWRD162"
             security_level => "authPriv"
+            ecs_compatibility => "disabled"
           }
         }
     CONFIG

data/spec/inputs/snmp_spec.rb

@@ -390,5 +390,28 @@ describe LogStash::Inputs::Snmp, :ecs_compatibility_support do
       end
     end
   end
+
+  context "close" do
+    let(:config) do
+      <<-CONFIG
+          input {
+            snmp {
+              get => ["1.3.6.1.2.1.1.1.0"]
+              hosts => [{host => "udp:127.0.0.1/161" community => "public"}]
+            }
+          }
+      CONFIG
+    end
+
+    before(:each) do
+      expect(LogStash::SnmpClient).to receive(:new).and_return(mock_client)
+      expect(mock_client).to receive(:get).and_return({"foo" => "bar"})
+    end
+
+    it "should call the close method upon termination" do
+      expect(mock_client).to receive(:close).once
+      input(config) { }
+    end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -483,7 +483,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: SNMP input plugin