sensu-extensions-check-dependencies 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b1e09684897fdf40f7c969aa0d59720c0a0ca2d
+  data.tar.gz: 8088c80f569f0e823ae392514f40ba033bc0215b
+SHA512:
+  metadata.gz: 1a5371f6b55f6efd9330e911bd19f4a7d1833432fd89d00ef67b316ed0717dda6cce55e8d46b1693de6e809ba6a7800c9c73a29b33c70605e287dce145a65995
+  data.tar.gz: 2b9827fd4d830d196c9887a790ba80f97f0971e60b120966aa91c10301b06532c04e601f7541f2c0648dfef3044a0cdfc32d060203175e9c6df66fc79cd28392

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log for Sensu::Extension::CheckDependencies
+
+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] - 2017-02-13
+
+### Added
+
+- Initial release.
+
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/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,82 @@
+## Sensu::Extensions::CheckDependencies
+
+This filter matches events when an event already exists, enabling the user to
+reduce notification noise and only be notified for the “root cause” of a given
+failure. Check dependencies can be defined in the check definition, using
+dependencies, an array of checks (e.g. `check_app`) or Sensu client/check pairs
+(e.g. `db-01/check_mysql`).
+
+### Installation
+
+This extension requires Sensu version >= 0.26.
+
+On a Sensu server machine:
+
+```
+$ sudo sensu-install -e check_dependencies:1.0.0
+```
+
+Edit `/etc/sensu/conf.d/extensions.json` to load it:
+
+```
+{
+  "extensions": {
+    "check_dependencies": {
+      "version": "1.0.0"
+    }
+}
+```
+
+### Example Check/Handler Configuration
+
+Specify a dependency on the `mysql` check:
+
+``` javascript
+{
+  "checks": {
+    "web_application_api": {
+      "command": "check-http.rb -u https://localhost:8080/api/v1/health",
+      "subscribers": [
+        "web_application"
+      ],
+      "interval": 20,
+      "dependencies": [
+        "mysql"
+      ]
+    }
+  }
+}
+```
+
+... or specify a dependency on another client's `mysql` check:
+
+``` javascript
+{
+  "checks": {
+    "web_application_api": {
+      "command": "check-http.rb -u https://localhost:8080/api/v1/health",
+      "subscribers": [
+        "web_application"
+      ],
+      "interval": 20,
+      "dependencies": [
+        "db-01/mysql"
+      ]
+    }
+  }
+}
+```
+
+Apply the `check_dependencies` filter to one or more handlers:
+
+``` javascript
+{
+  "handlers": {
+    "custom_mailer": {
+      "type": "pipe",
+      "command": "custom_mailer.rb",
+      "filters": ["check_dependencies"]
+    }
+  }
+}
+```

data/lib/sensu/extensions/check_dependencies.rb

@@ -0,0 +1,89 @@
+require "sensu/extension"
+require "timeout"
+require "net/http"
+
+module Sensu
+  module Extension
+    class CheckDependencies < Filter
+      def name
+        "check_dependencies"
+      end
+
+      def description
+        "filter events when an event exists for a check dependency"
+      end
+
+      # Make an HTTP GET request to the Sensu API, using the URI
+      # path provided. Uses Sensu settings to determine how to
+      # connect to the API.
+      #
+      # @param path [String]
+      # @return [Object] http response object.
+      def sensu_api_get_request(path)
+        api = @settings[:api] || {}
+        request = Net::HTTP::Get.new(path)
+        if api[:user]
+          request.basic_auth(api[:user], api[:password])
+        end
+        Net::HTTP.new(api[:host] || '127.0.0.1', api[:port] || 4567).start do |http|
+          http.request(request)
+        end
+      end
+
+      # Check to see if an event exists for a client/check pair. This
+      # method is looking for a HTTP response code of `200`.
+      #
+      # @param client_name [String]
+      # @param check_name [String]
+      # @return [Boolean]
+      def event_exists?(client_name, check_name)
+        path = "/events/#{client_name}/#{check_name}"
+        response = sensu_api_get_request(path)
+        response.code.to_i == 200
+      end
+
+      # Determine if an event exists for any of the check
+      # dependencies declared in the event data, specified in array,
+      # check `dependencies`. A check dependency can be a check
+      # executed by the same Sensu client (eg. `check_app`), or a
+      # client/check pair (eg.`i-424242/check_mysql`).
+      #
+      # @param event [Hash]
+      # @return [Boolean]
+      def dependency_events_exist?(event)
+        if event[:check][:dependencies].is_a?(Array)
+          event[:check][:dependencies].any? do |dependency|
+            begin
+              check_name, client_name = dependency.split("/").reverse
+              client_name ||= event[:client][:name]
+              event_exists?(client_name, check_name)
+            rescue => error
+              @logger.error("failed to query api for a check dependency event", :error => error)
+              false
+            end
+          end
+        else
+          false
+        end
+      end
+
+      def run(event, &callback)
+        filter = Proc.new do
+          begin
+            Timeout::timeout(10) do
+              if dependency_events_exist?(event)
+                ["event exists for check dependency", 0]
+              else
+                ["no current events for check dependencies", 1]
+              end
+            end
+          rescue => error
+            @logger.error("check dependencies filter error", :error => error.to_s)
+            ["check dependencies filter error: #{error}", 1]
+          end
+        end
+        EM.defer(filter, callback)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions-check-dependencies
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sensu Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-14 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: 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: webmock
+  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: Filter events when an event already exists for a defined check dependency
+email:
+- "<support@sensu.io>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sensu/extensions/check_dependencies.rb
+homepage: https://github.com/sensu-extensions/sensu-extensions-check-dependencies
+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.6
+signing_key: 
+specification_version: 4
+summary: Filter events when an event already exists for a defined check dependency
+test_files: []