logstash-output-snmptrap 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5836098b934d334b9f965941144acd1055c200a
+  data.tar.gz: 9d011f962c9ae6dcef3b7a6db36cda61fabfffd4
+SHA512:
+  metadata.gz: 6b8e7f1321d0134dd700ad7324e54a098cf994d4cffed86ee6f2b0dc2669c89cb6bd39463b2a99c04a741bb9756c1fd3fa57dd9e1a7de2ce0fb21ffe317a681b
+  data.tar.gz: bf335fd0334b333fb26ada7152e9cee59f8c3e44d6459c285018b3593b577384ee214c9919d2afb286dd0172ea24481fafa5348b34867495be84047321efa984

data/CONTRIBUTORS

@@ -0,0 +1,6 @@
+Contributors:
+Ryan O'Keeffe (DanielRedOak)
+Elmar Vonlanthen (Elmux)
+chrisbentz
+Pieter Baele (Fiddich)
+

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-snmp
+SNMP output plugin.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,94 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+# Documentation #
+## logstash-output-snmptrap ##
+
+SNMP Trap v2c Output for Logstash
+
+#Synopsis
+```
+output {
+  snmptrap {
+    codec => ... # codec (optional), default: "line"
+    host => ... # string (optional), default: "0.0.0.0"
+    port => ... # number (optional), default: "162"
+    community => ... # string (optional), default: "public"
+    oid => ... # string (required)
+    yamlmibdir => ... # string (optional)
+  }
+}
+```
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/snmptrap.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+# An example output that does nothing.
+class LogStash::Outputs::Snmptrap < LogStash::Outputs::Base
+  config_name "snmptrap"
+
+  default :codec, "line"
+
+  #address of the host to send the trap/notification to
+  config :host, :validate => :string, :default => "127.0.0.1"
+
+  #the port to send the trap on
+  config :port, :validate => :number, :default => 162
+
+  #the community string to include
+  config :community, :validate => :string, :default => "public"
+
+  #the OID that specifies the event generating the trap message
+  config :oid, :validate => :string, :required => true
+
+  # directory of YAML MIB maps  (same format ruby-snmp uses)
+  config :yamlmibdir, :validate => :string
+
+  def initialize(*args)
+    super(*args)
+  end
+
+  public
+  def register
+    require "snmp"
+    #from snmp trap input plugin, thanks
+    # if @yamlmibdir
+    #   @logger.info("checking #{@yamlmibdir} for MIBs")
+    #   Dir["#{@yamlmibdir}/*.yaml"].each do |yamlfile|
+    #     mib_name = File.basename(yamlfile, ".*")
+    #     @yaml_mibs ||= []
+    #     @yaml_mibs << mib_name
+    #   end
+    #   @logger.info("found MIBs: #{@yaml_mibs.join(',')}") if @yaml_mibs
+    # end
+    @codec.on_event do |event|
+
+      #set some variables for the trap sender
+      trapsender_opts = {:trap_port => @port, :host => @host, :community => @community }
+
+      #check for and add user specified mibs
+      # if @yaml_mibs && !@yaml_mibs.empty?
+      #   trapsender_opts.merge!({:mib_dir => @yamlmibdir, :mib_modules => @yaml_mibs})
+      # end
+      #prep and do the full send
+      SNMP::Manager.open(trapsender_opts) do |snmp|
+        #set it up and send the whole event using the user specified codec
+        varbind = SNMP::VarBind.new(@oid, SNMP::OctetString.new(event.to_s))
+
+        #we dont actually care about the sys_up_time...do we.  Also I am re-using the oid that was input.
+        snmp.trap_v2(0, @oid, varbind)
+        end
+    end
+  end
+
+  public
+  def receive(event)
+    return unless output?(event)
+    if event == LogStash::SHUTDOWN
+      finished
+      return
+    end
+    @oid = event.sprintf(@oid)
+    @codec.encode(event)
+  end
+end

data/logstash-output-snmptrap.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-snmptrap'
+  s.version       = '0.9.2'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'SNMP Output for Logstash'
+  s.description   = 'This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program'
+  s.homepage      = 'https://github.com/Fiddich/logstash-output-snmptrap'
+  s.authors       = ['Pieter Baele']
+  s.email         = 'pieter.baele@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_development_dependency "logstash-devutils"
+end

data/spec/outputs/snmptrap_spec.rb

@@ -0,0 +1,21 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/example"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Example do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Example.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-snmptrap
+version: !ruby/object:Gem::Version
+  version: 0.9.2
+platform: ruby
+authors:
+- Pieter Baele
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: pieter.baele@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/snmptrap.rb
+- logstash-output-snmptrap.gemspec
+- spec/outputs/snmptrap_spec.rb
+homepage: https://github.com/Fiddich/logstash-output-snmptrap
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.8
+signing_key:
+specification_version: 4
+summary: SNMP Output for Logstash
+test_files:
+- spec/outputs/snmptrap_spec.rb