logstash-input-snmp 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d344864bfc29473393a8d06527a52b5a606efcb8384ce300751898be6daec7ca
-  data.tar.gz: 3fdf527c93de3d59a6f7c3f20e07e3bfc02d893706b649d2ee7c5e310097e7d0
+  metadata.gz: 5599c9705618d89025096ef93521fc9af9c3459b34e57e1dabe3b697918ffca1
+  data.tar.gz: 3b86026c9b6239f0628408d39926a757d7308c0d72b6fdf6a5742f2cc2cc2c1b
 SHA512:
-  metadata.gz: 8d2dc6418f15151c5ade6a900fb28f352020c78e9b95b579b9d8a594f84f539e6bb65570c074f41d9b7ed4c5ba96c6ffac5a745512094af74cb2f3860e0cc277
-  data.tar.gz: 827ed778277f612c1e99982bd8a039d99fcc87b9221f7b26e400c1a672d1b2cf12c21e4a83f4a32ca208a619db9ae31a8fac468d249a3b8e2ee47c6f76bc5a76
+  metadata.gz: c03af9c1da2efbbdccff38d322ed7b8f15331cca3de4b987d22145c2b150d1c93a65035a664d88a245c89e0461ba3a89236a429b3d806cc996503ecce55fa60a
+  data.tar.gz: da07ed21485a35b58b915f974003ad747c3ff6d4a36ed1b6ccb07d3f8066e7910ed826e8ff5f63454f2fb4af5cc663aceb8755f18959f35d016bc19e137e46a2

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0.beta2
+  - add host info in metadata and host field, https://github.com/logstash-plugins/logstash-input-snmp/pull/7
+
 ## 0.1.0.beta1
   - First beta version
 

data/lib/logstash/inputs/snmp.rb

@@ -53,6 +53,9 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   # The default, `30`, means poll each host every 30second.
   config :interval, :validate => :number, :default => 30
 
+  # Add the default "host" field to the event.
+  config :add_field, :validate => :hash, :default => { "host" => "%{[@metadata][host_address]}" }
+
   def register
     validate_oids!
     validate_hosts!
@@ -71,10 +74,19 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
       retries = host["retries"] || 2
       timeout = host["timeout"] || 1000
 
+      host_details = host_name.match(HOST_REGEX)
+      raise(LogStash::ConfigurationError, "invalid format for host option '#{host_name}'") unless host_details
+      raise(LogStash::ConfigurationError, "only the udp protocol is supported for now") unless host_details[:host_protocol].to_s =~ /udp/i
+
       definition = {
         :client => LogStash::SnmpClient.new(host_name, community, version, retries, timeout, mib),
         :get => Array(get),
         :walk => Array(walk),
+
+        :host_protocol => host_details[:host_protocol],
+        :host_address => host_details[:host_address],
+        :host_port => host_details[:host_port],
+        :host_community => community,
       }
       @client_definitions << definition
     end
@@ -104,6 +116,14 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
         end
 
         unless result.empty?
+          metadata = {
+              "host_protocol" => definition[:host_protocol],
+              "host_address" => definition[:host_address],
+              "host_port" => definition[:host_port],
+              "host_community" => definition[:host_community],
+          }
+          result["@metadata"] = metadata
+
           event = LogStash::Event.new(result)
           decorate(event)
           queue << event
@@ -120,7 +140,7 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
   private
 
   OID_REGEX = /^\.?([0-9\.]+)$/
-  HOST_REGEX = /^(udp|tcp):.+\/\d+$/i
+  HOST_REGEX = /^(?<host_protocol>udp|tcp):(?<host_address>.+)\/(?<host_port>\d+)$/i
 
   def validate_oids!
     @get = Array(@get).map do |oid|
@@ -149,10 +169,6 @@ class LogStash::Inputs::Snmp < LogStash::Inputs::Base
 
     @hosts.each do |host|
       raise(LogStash::ConfigurationError, "each host definition must have a \"host\" option") if !host.is_a?(Hash) || host["host"].nil?
-      unless host["host"] =~ HOST_REGEX
-        raise(LogStash::ConfigurationError, "invalid host option format")
-      end
-      raise(LogStash::ConfigurationError, "tcp is not yet supported, only udp") if $1 =~ /tcp/i
     end
   end
 end

data/logstash-input-snmp.gemspec

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

@@ -82,4 +82,45 @@ describe LogStash::Inputs::Snmp do
       end
     end
   end
+
+  context "@metadata" do
+    before do
+      expect(LogStash::SnmpClient).to receive(:new).and_return(mock_client)
+      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 }
+
+      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 eq("127.0.0.1")
+    end
+
+    it "shoud add custom 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"}]
+              add_field => { host => "%{[@metadata][host_protocol]}:%{[@metadata][host_address]}/%{[@metadata][host_port]},%{[@metadata][host_community]}" }
+            }
+          }
+      CONFIG
+      event = input(config) { |_, queue| queue.pop }
+
+      expect(event.get("host")).to eq("udp:127.0.0.1/161,public")
+    end
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmp
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement