sensu-extensions-snmp-trap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5697ed45cacaa3306fc6043caeb89d62d5d24b67
+  data.tar.gz: 3822e4f9bbbb4f8f0cc720df3190d5619dbd8329
+SHA512:
+  metadata.gz: 84107ce785291471c9df0876a5ba06ec682dacd346f83813529a16caf4a12056c548d6053e6c6f74ff2d0ed1b9aba649318319ae9ef0c0cfb719683ec9f8bd8d
+  data.tar.gz: d9b4158296fc6352715f2348328fdad82e3d29ec5a76f447e4c21bda29da4d480fc56b69065d65bbded17f4546bde930bc6454e01e043afe11405a0d9ffacc48

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/).
+
+## [Unreleased]
+
+### Fixed
+
+### Added
+
+### Changed
+
+## [1.0.0] - 2016-01-31
+
+### Fixed
+
+### Added
+
+### Changed
+
+## 0.0.1 - 2016-01-31
+
+### Added
+
+- Initial release.
+
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-extensions/sensu-extensions-template/compare/v0.0.1...v1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sensu-Extensions
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Sensu::Extensions::Template
+
+Welcome to the Sensu Extensions repository template! In this repository, you will find the files you need to be able to author your own Sensu Extension for Sensu Core (>= 0.26).
+
+## Usage
+
+1. Fork this repository and name the fork after your new extension, e.g. `"sensu-extensions-docker"`
+
+2. Write your extension (with tests!)
+
+3. Create a GitHub issue on [sensu-extensions/template](https://github.com/sensu-extensions/template/issues) to request a review of your extension, to determine if it is ready to be moved to the [sensu-extensions GitHub organization](https://github.com/sensu-extensions) to be shared with the Sensu community!

data/lib/sensu/extensions/snmp-trap.rb

@@ -0,0 +1,156 @@
+require "sensu/extension"
+require "thread"
+require "snmp"
+
+module Sensu
+  module Extension
+    class SNMPTrap < Check
+
+      RESULT_MAP = [
+        [/checkname/i, :name],
+        [/notification/i, :output],
+        [/severity/i, :status]
+      ]
+
+      RUBY_ASN1_MAP = {
+        "INTEGER" => :to_i,
+        "OCTET STRING" => :to_s,
+        "OBJECT IDENTIFIER" => :to_s,
+        "IpAddress" => :to_s,
+        "Counter32" => :to_i,
+        "Gauge32" => :to_i,
+        "Unsigned32" => :to_i,
+        "TimeTicks" => :to_i,
+        "Opaque" => :to_s,
+        "Counter64" => :to_i
+      }
+
+      def name
+        "snmp_trap"
+      end
+
+      def description
+        "receives snmp traps and translates them to check results"
+      end
+
+      def definition
+        {
+          name: name,
+          publish: false
+        }
+      end
+
+      def options
+        return @options if @options
+        @options = {
+          :bind => "0.0.0.0",
+          :port => 1062,
+          :community => "public",
+          :handlers => ["default"],
+          :mibs_dir => "/etc/sensu/mibs"
+        }
+        @options.merge!(@settings[:snmp_trap]) if @settings[:snmp_trap].is_a?(Hash)
+        @options
+      end
+
+      def start_snmpv2_listener!
+        @listener = SNMP::TrapListener.new(
+          :host => options[:bind],
+          :port => options[:port],
+          :community => options[:community]) do |listener|
+          listener.on_trap_v2c do |trap|
+            @logger.debug("snmp trap check extension received a v2 trap")
+            @traps << trap
+          end
+        end
+      end
+
+      def load_mibs!
+        @logger.debug("snmp trap check extension importing mibs", :mibs_dir => options[:mibs_dir])
+        Dir.glob(File.join(options[:mibs_dir], "*")) do |mib_file|
+          @logger.debug("snmp trap check extension importing mib", :mib_file => mib_file)
+          SNMP::MIB.import_module(mib_file)
+        end
+        @mibs = SNMP::MIB.new
+        @logger.debug("snmp trap check extension loading mibs")
+        SNMP::MIB.list_imported.each do |module_name|
+          @logger.debug("snmp trap check extension loading mib", :module_name => module_name)
+          @mibs.load_module(module_name)
+        end
+        @mibs
+      end
+
+      def send_result(result)
+        socket = UDPSocket.new
+        socket.send(Sensu::JSON.dump(result), 0, "127.0.0.1", 3030)
+        socket.close
+      end
+
+      def determine_hostname(address)
+        begin
+          Resolv.getname(address)
+        rescue Resolv::ResolvError
+          @logger.debug("snmp trap check extension unable to resolve hostname", :address => address)
+          address
+        end
+      end
+
+      def determine_trap_oid(trap)
+        varbind = trap.varbind_list.detect do |varbind|
+          varbind.name.to_oid == SNMP::SNMP_TRAP_OID_OID
+        end
+        varbind.value.to_s rescue "trap_oid_unknown"
+      end
+
+      def process_trap(trap)
+        @logger.debug("snmp trap check extension processing a v2 trap")
+        result = {
+          :source => determine_hostname(trap.source_ip),
+          :handlers => options[:handlers]
+        }
+        trap.varbind_list.each do |varbind|
+          symbolic_name = @mibs.name(varbind.name.to_oid)
+          mapping = RESULT_MAP.detect do |mapping|
+            symbolic_name =~ mapping.first
+          end
+          if mapping && !result[mapping.last]
+            type_conversion = RUBY_ASN1_MAP[varbind.value.asn1_type]
+            if type_conversion
+              result[mapping.last] = varbind.value.send(type_conversion)
+            end
+          end
+        end
+        result[:name] ||= determine_trap_oid(trap)
+        result[:output] ||= trap.inspect
+        result[:status] ||= 3
+        send_result(result)
+      end
+
+      def start_trap_processor!
+        @processor = Thread.new do
+          load_mibs!
+          loop do
+            process_trap(@traps.pop)
+          end
+        end
+        @processor.abort_on_exception = true
+        @processor
+      end
+
+      def post_init
+        @traps = Queue.new
+        start_snmpv2_listener!
+        start_trap_processor!
+      end
+
+      def stop
+        @listener.kill if @listener
+        @processor.kill if @processor
+      end
+
+      def run(event, &callback)
+        yield "no-op", 0
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions-snmp-trap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Extensions and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sensu-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sensu-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check extension to receive SNMP traps and translate them into check results
+email:
+- "<sensu-users@googlegroups.com>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sensu/extensions/snmp-trap.rb
+homepage: https://github.com/sensu-extensions/sensu-extensions-snmp-trap
+licenses: []
+metadata: {}
+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.3
+signing_key: 
+specification_version: 4
+summary: Check extension to receive SNMP traps and translate them into check results
+test_files: []