sensu-plugins-pagerduty 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5499485d200a12a466209edae02d4a6d1fd9b493
-  data.tar.gz: 1705a7a8347944e01fd4d58d45ffe58f6621ccb9
+  metadata.gz: e4a3db515ce06dab242e7320817c87b43fbd0c2a
+  data.tar.gz: 5b64f3cd4e67a5c0c8ffea459cf67ab219067130
 SHA512:
-  metadata.gz: a63f324f6c6442c56fa59710e114469997baa897c1cef64cdb2cf759b4631703faa2b4fa40bfc0f3ca759af7427403004ee3a5d5d8a2da7985512448baeca1af
-  data.tar.gz: bf252d9c1456ba084213c967a05cde05d8032d49480d4d22e34203fb89c49573705db7db12537083cea9a149a972af8a2c13cf25174abf6f3c2961c57d945838
+  metadata.gz: bd550d76ca2c81a70db7a0d172b21d043bad843c0996e239aaefb700082efb0ce5c506594790df6ff6be52f667f9a916f4a3454516de1800b8e4de55515b605d
+  data.tar.gz: f288cfa4f3d08c0a53b8968f3d6d28f1569d13dc4f0973c49e412850a304c45fd4cd311a54d2bcc0eaa8654eafd1a2eead94907235878edda432667fc743423d

data/CHANGELOG.md

@@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
+## [3.0.0] - 2017-06-01
+### Breaking Change
+- changed the precedence of pager_team evaluation from `client -> check -> json_config`  to `check -> client -> json_config` (@guru-beach)
+### Added
+- support for flapping events to be created (@majormoses)
 
 ## [2.2.0] - 2017-03-23
 ### Added
@@ -98,7 +103,8 @@ marking it as a stable 1.0.0 release.
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.2.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.2.0...3.0.0
 [2.2.0]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/1.0.0...2.0.0

data/README.md

@@ -14,7 +14,7 @@
 
 ## Usage of Handler
 
-PagerDuty supports dedup. Dedup is useful when you want to create a single alert (for a group of checks). Only one alert is sent out even if the checks fail at the same time. The following example groups check_service_`n` together for a single host. `dedup_rules` take in regular expressions as keys and re-write rules as values. `dedup_rules` entry is optional. 
+PagerDuty supports dedup. Dedup is useful when you want to create a single alert (for a group of checks). Only one alert is sent out even if the checks fail at the same time. The following example groups check_service_`n` together for a single host. `dedup_rules` take in regular expressions as keys and re-write rules as values. `dedup_rules` entry is optional.
 
 ```
 {
@@ -33,7 +33,7 @@ PagerDuty supports dedup. Dedup is useful when you want to create a single alert
 }
 ```
 
-In the Client hash you can define a `pager_team` key value pair.  If the the client hash contains the `pager_team` key it will then no longer use the default `pagerduty.api_key` from the above hash but will look for the value given in the client. The following client hash will  alert using the team_name1 api key instead of the default api_key. This will allow different teams/hosts to alert different escalation paths. 
+In the Client hash you can define a `pager_team` key value pair.  If the the client hash contains the `pager_team` key it will then no longer use the default `pagerduty.api_key` from the above hash but will look for the value given in the client. The following client hash will  alert using the team_name1 api key instead of the default api_key. This will allow different teams/hosts to alert different escalation paths.
 
 ```
 {
@@ -54,6 +54,27 @@ Please note, this sets the escalation path on the whole host. If you want more g
 
 In the Check hash you can define a `pagerduty_contexts` list to send contextual links and images with your events. This list should conform to the [PagerDuty documentation](https://developer.pagerduty.com/documentation/integration/events/trigger#contexts) about contexts.
 
+Another approach would be define this on a per check basis like so:
+```
+{
+  "checks": {
+    "cpu": {
+      "command": "check-cpu.rb -w 90 -c 100",
+      "subscribers": [
+        "base"
+      ],
+      "handlers": [
+        "pagerduty"
+      ],
+      "interval": 15,
+      "pager_team": "team1",
+      "notification": "CPU is running hot!",
+      "occurrences": 8
+    }
+  }
+}
+```
+
 ## Usage of Priority Overide Mutator
 
 This mutator allows you to have fine grain control on PagerDuty escalation paths based on data within the client hash.  The mutator will look in the following locations where `#{event_level}` is `warning` and `critical` (unknown, is replaced by critical), and `#{check_name}` is the name of the check. Items located lower in the list take precedence:
@@ -123,7 +144,7 @@ And I also have the following client hash:
 If a `critical` event is triggered from "my.host.fqdn" that is not named `check_disk` it will alert the default (with value api_key: 12345).  If a `warning` event is triggered that is not `check_disk` it will alert the `low_proirity` escalation service.  If any `check_disk` alert is triggerd it will the alert the `ops` escalation.
 
 
-## Adding Dynamic Event Description Prefix 
+## Adding Dynamic Event Description Prefix
 
 You can add a custom field from the Sensu client config as a description prefix, like the host name, to add more context to the event description:
 
@@ -136,6 +157,17 @@ You can add a custom field from the Sensu client config as a description prefix,
 }
 ```
 
+## Flapping Incidents
+By default handlers do not handle flapping incidents: [handler configuration documentation](https://sensuapp.org/docs/0.24/reference/handlers.html#handler-configuration) in order to change this you must set handle_flapping in your handler config like this:
+```json
+{
+  "pagerduty": {
+    "api_key": "12345",
+    "handle_flapping": true
+  }
+}
+```
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/handler-pagerduty.rb

@@ -10,7 +10,7 @@
 #
 # Note: The sensu api token could also be configured on a per client or per check basis.
 #       By defining the "pager_team" attribute in the client config file or the check config.
-#       The override order will be client > check > json_config
+#       The override order will be check > client > json_config
 #
 # Dependencies:
 #
@@ -47,10 +47,10 @@ class PagerdutyHandler < Sensu::Handler
 
   def api_key
     @api_key ||=
-      if @event['client']['pager_team']
-        settings[json_config][@event['client']['pager_team']]['api_key']
-      elsif @event['check']['pager_team']
+      if @event['check']['pager_team']
         settings[json_config][@event['check']['pager_team']]['api_key']
+      elsif @event['client']['pager_team']
+        settings[json_config][@event['client']['pager_team']]['api_key']
       else
         settings[json_config]['api_key']
       end
@@ -98,7 +98,7 @@ class PagerdutyHandler < Sensu::Handler
 
         begin
           case @event['action']
-          when 'create'
+          when 'create', 'flapping'
             pagerduty.trigger([description_prefix, event_summary].compact.join(' '),
                               incident_key: [incident_key_prefix, incident_key].compact.join(''),
                               details: @event,

data/lib/sensu-plugins-pagerduty/version.rb

@@ -1,7 +1,7 @@
 module SensuPluginsPagerduty
   module Version
-    MAJOR = 2
-    MINOR = 2
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-pagerduty
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin