sensu-extensions-check-dependencies 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d977bb2e39d5c5632903ee1b398471bc26444ec1
-  data.tar.gz: 81bc9b8e744b6dbf1164c3f6e9db1fc4a2c04aaa
+  metadata.gz: 39743c7fcd8b25f612cc82a2f5a0ff489d3af94f
+  data.tar.gz: 91a0e1327220c042b83a6dd886e8ddccc3df2304
 SHA512:
-  metadata.gz: 9980c6005bf198117ccd05b3e415e4dab7afbe4e880dcc0156fdc6d23a92bbac7a0e6a2b0985ce4b419bba456c2a3d760256e6292571903ec2b44325511460a7
-  data.tar.gz: 2a10c067c7e988ab5fbded2eb77e5af44ece60e7e0dcbe8c8edc9a2e3bbcf9f716d0594e3eb3a819a0e7bc14c6655c64902bf24ff9ea5f817889a2f1619bf28e
+  metadata.gz: 4b673e3f89b99151a5e7697176088d52dcef84668251de281f512c0ff33e10f95d8c54d98689ef06521950f5d868fab73a94327bcf386838caca49e045c754ae
+  data.tar.gz: e71797d1c07b3814e6a9b8ba60aacea120af2610f6ee855b935e04cc1865021768a633586addaff807501ea4a026552ffd2c4c9ec2560021c7cc38e24936a0f5

data/CHANGELOG.md

@@ -12,6 +12,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ### Changed
 
+## [1.1.0] - 2018-06-21
+
+### Added
+
+- Add support for setting a subscription/check pair as a check dependency. #12 (@testeddoughnut)
+
 ## [1.0.1] - 2017-03-15
 
 ### Fixed
@@ -24,6 +30,7 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 - Initial release.
 
-[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/sensu-extensions/sensu-extensions-check-dependencies/compare/v1.0.0...v1.0.0

data/README.md

@@ -1,19 +1,25 @@
 ## Sensu::Extensions::CheckDependencies
 
+This filter extension provides the Sensu Core built-in filter `check_dependencies`.
+
 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`).
+dependencies, an array of checks (e.g. `check_app`), Sensu client/check pairs
+(e.g. `db-01/check_mysql`), or a subscription/check pair
+(e.g. `subscription:mysql/check_mysql`).
+
+[![Build Status](https://travis-ci.org/sensu-extensions/sensu-extensions-check-dependencies.svg?branch=master)](https://travis-ci.org/sensu-extensions/sensu-extensions-check-dependencies)
 
 ### Installation
 
-This extension requires Sensu version >= 0.26.
+This extension requires Sensu version >= 0.26 and is provided as a built-in 
+filter in Sensu >= 0.29.
 
-On a Sensu server machine:
+To manually install this extension on a Sensu server machine:
 
 ```
-$ sudo sensu-install -e check-dependencies:1.0.1
+$ sudo sensu-install -e check-dependencies:1.1.0
 ```
 
 Edit `/etc/sensu/conf.d/extensions.json` to load it:
@@ -22,7 +28,7 @@ Edit `/etc/sensu/conf.d/extensions.json` to load it:
 {
   "extensions": {
     "check-dependencies": {
-      "version": "1.0.1"
+      "version": "1.1.0"
     }
   }
 }
@@ -68,6 +74,26 @@ Specify a dependency on the `mysql` check:
 }
 ```
 
+... or specify a dependency on any `mysql` check in the `mysql_nodes`
+subscription:
+
+``` javascript
+{
+  "checks": {
+    "web_application_api": {
+      "command": "check-http.rb -u https://localhost:8080/api/v1/health",
+      "subscribers": [
+        "web_application"
+      ],
+      "interval": 20,
+      "dependencies": [
+        "subscription:mysql_nodes/mysql"
+      ]
+    }
+  }
+}
+```
+
 Apply the `check_dependencies` filter to one or more handlers:
 
 ``` javascript

data/lib/sensu/extensions/check-dependencies.rb

@@ -36,17 +36,31 @@ module Sensu
       # @param client_name [String]
       # @param check_name [String]
       # @return [Boolean]
-      def event_exists?(client_name, check_name)
+      def client_event_exists?(client_name, check_name)
         path = "/events/#{client_name}/#{check_name}"
         response = sensu_api_get_request(path)
         response.code.to_i == 200
       end
 
+      # Check to see if an event exists for a subscription/check pair. This
+      # method is looking for a HTTP response code of `200`.
+      #
+      # @param subscription_name [String]
+      # @param check_name [String]
+      # @return [Boolean]
+      def subscription_event_exists?(subscription_name, check_name)
+        path = "/events"
+        response = sensu_api_get_request(path)
+        events = JSON.load(response.body)
+        !events.select { |event| event[:client][:subscriptions].include?(subscription_name) && event[:check][:name] == check_name}.empty?
+      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`).
+      # executed by the same Sensu client (eg. `check_app`), a
+      # client/check pair (eg.`i-424242/check_mysql`), or a
+      # subscription/check pair (eg. `subscription:mysql/check_mysql`).
       #
       # @param event [Hash]
       # @return [Boolean]
@@ -54,9 +68,15 @@ module Sensu
         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)
+              check_name, entity = dependency.split("/").reverse
+              if entity =~ /^subscription:.*$/
+                subscription_name = entity.split(":")[1]
+                subscription_event_exists?(subscription_name, check_name)
+              else
+                client_name = entity
+                client_name ||= event[:client][:name]
+                client_event_exists?(client_name, check_name)
+              end
             rescue => error
               @logger.error("failed to query api for a check dependency event", :error => error)
               false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-extensions-check-dependencies
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-extension
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Filter events when an event already exists for a defined check dependency