logstash-input-snmptrap 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5177deda174aa3b2f20f4b3722cb523913a4abf0
-  data.tar.gz: 20d082b031b83ac36126b6a5fcfdd2faa2087c9a
+  metadata.gz: 77088e35cbb7f1aae01213ca3181fa6ad3133137
+  data.tar.gz: 9724128b3f0b109fe3f6d2efb33e61483617f215
 SHA512:
-  metadata.gz: 2436620cb08c55c5c9ab1d542604b888c76db3d4f2ac5111867037634baa2559c5a6717b6fb4325f595563cca474f742adc619503f5e02d6e548098e856a4ac0
-  data.tar.gz: 2fd8a3952ac47f943624c61aecac5b3622c0f1dc638703c722205926329d3e8aea3c6ef4d45d81ea2f5a9b82734cb2c67295f131be2e1a9e386ff618b26b356a
+  metadata.gz: afcb7980861e2d43696ab222fef975febb05330a49dfde8f2e3b112234b67f3ea6fa5a30d8eac0ce57676f9ee26a05fa8f455240c2de984497a9491aba915fbd
+  data.tar.gz: 6c640cdbb9a813701986a4098a45c661d03ed421a75ca0e9d90531bfa3e794769ced4fbbf5ca1dbec67cf6c80176fdd4bb2a7f18c66c38f8ce41e03935a5e713

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,88 @@
+:plugin: snmptrap
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Snmptrap input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read snmp trap messages as events
+
+Resulting `@message` looks like :
+[source,ruby]
+  #<SNMP::SNMPv1_Trap:0x6f1a7a4 @varbind_list=[#<SNMP::VarBind:0x2d7bcd8f @value="teststring",
+  @name=[1.11.12.13.14.15]>], @timestamp=#<SNMP::TimeTicks:0x1af47e9d @value=55>, @generic_trap=6,
+  @enterprise=[1.2.3.4.5.6], @source_ip="127.0.0.1", @agent_addr=#<SNMP::IpAddress:0x29a4833e @value="\xC0\xC1\xC2\xC3">,
+  @specific_trap=99>
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Snmptrap Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-community>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-yamlmibdir>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-community"]
+===== `community` 
+
+  * Value type is <<array,array>>
+  * Default value is `"public"`
+
+SNMP Community String to listen for.
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"0.0.0.0"`
+
+The address to listen on
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `1062`
+
+The port to listen on. Remember that ports less than 1024 (privileged
+ports) may require root to use. hence the default of 1062.
+
+[id="plugins-{type}s-{plugin}-yamlmibdir"]
+===== `yamlmibdir` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+directory of YAML MIB maps  (same format ruby-snmp uses)
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/inputs/snmptrap.rb

@@ -3,6 +3,7 @@ require "logstash/inputs/base"
 require "logstash/namespace"
 
 require "snmp"
+require_relative "snmptrap/patches/trap_listener"
 
 # Read snmp trap messages as events
 #

data/lib/logstash/inputs/snmptrap/patches/trap_listener.rb

@@ -0,0 +1,22 @@
+require "snmp"
+
+# Patch SNMP::TrapListener#process_traps to ignore exceptions when stopping.
+class SNMP::TrapListener
+  alias_method :original_exit, :exit
+  def exit
+    @stop = true
+    original_exit
+  end
+
+  def stop?
+    @stop
+  end
+
+  alias_method :original_process_traps, :process_traps
+  def process_traps(*args)
+    original_process_traps(*args)
+  rescue
+    raise unless stop?
+  end
+end
+

data/logstash-input-snmptrap.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-snmptrap'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read snmp trap messages as events"
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-snmptrap
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,9 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/snmptrap.rb
+- lib/logstash/inputs/snmptrap/patches/trap_listener.rb
 - logstash-input-snmptrap.gemspec
 - spec/inputs/snmptrap_spec.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
@@ -109,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Read snmp trap messages as events