sensu-plugins-pagerduty 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96b998debaa4f03976e52fed5487054d071152ea
-  data.tar.gz: 09e987da37b3354c519a5b852ab63ab117d82a05
+  metadata.gz: 8013c82be04050d5d1a5be48b6ac670a77b1c0e7
+  data.tar.gz: 9b3a495d37dd59456b85de2ca0f5d414ad5ec1c3
 SHA512:
-  metadata.gz: f5c64e56d2fd26e55ec3dd0f9a9d8c0c53eaab1f1e37e6b62d13da4bc81fe9ab942eac4594d514ce7c89bdb77e49cc50fa5419ac28660636f5e913655c466924
-  data.tar.gz: c4fb2bacb7696b25f5a8937871d48dc2dc192b36effd551e23c8dfb8bd98718af0a09d77cccfbe527b34ca483c1b1636e335980a2d1cbb8cea6d39b2455c606e
+  metadata.gz: 3d852b6dfdac69026817475ab7e3adf5a6f6cf6155b17cdfecc23fc75ee7f9f8d1cce68c5fe86f5669f9883191deb091fbf5153ed6f79280f1cd5801774a0209
+  data.tar.gz: d4d3f55744b81324f7b411de262f7cec5fa828a11d70ae4bbc3d3c86ef794775064cb663f3fc44a3fd93c1ee37c4abd1dcffa1c823bdaa5e7bac41d98718a2db

data/CHANGELOG.md

@@ -5,6 +5,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [2.1.0] - 2017-02-28
+### Added
+- Add contexts support (@zroger)
+- Update timeout syntax and extend to 10 seconds. (@luckymike)
+- Allow adding some dynamic fields (from the event sensu client config) to the PD event description (@Oded-B)
+
 ## [2.0.0] - 2016-06-29
 ### Added
 - Proxy support (@lcrisci)
@@ -37,8 +43,8 @@ marking it as a stable 1.0.0 release.
 
 ## [0.0.8] - 2015-12-10
 ### Added
-- Added a handler to allow overrides based on priority, now you can different 
-  alerts trigger different PagerDuty API endpoints. For example one can hit a high 
+- Added a handler to allow overrides based on priority, now you can different
+  alerts trigger different PagerDuty API endpoints. For example one can hit a high
   priority endpoint but warning can hit a lowpriority point.
 
 ### Changed
@@ -88,7 +94,8 @@ marking it as a stable 1.0.0 release.
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/2.1.0...HEAD
+[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
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/0.0.9...1.0.0
 [0.0.9]: https://github.com/sensu-plugins/sensu-plugins-pagerduty/compare/0.0.8...0.0.9

data/README.md

@@ -52,6 +52,8 @@ In the Client hash you can define a `pager_team` key value pair.  If the the cli
 
 Please note, this sets the escalation path on the whole host. If you want more granular control on escalation paths please view the Mutator section below.
 
+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.
+
 ## 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:
@@ -118,9 +120,22 @@ 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 
+
+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:
+
+```
+{
+  "pagerduty": {
+    "api_key": "12345",
+    "dynamic_description_prefix_key" : "name",
+  }
+}
+```
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/handler-pagerduty.rb

@@ -67,12 +67,24 @@ class PagerdutyHandler < Sensu::Handler
     proxy_settings
   end
 
+  def contexts
+    @contexts ||= @event['check']['pagerduty_contexts'] || []
+  end
+
+  def description_prefix
+    @description_prefix = if @event['client'].key?(settings[json_config]['dynamic_description_prefix_key'])
+                            "(#{@event['client'][settings[json_config]['dynamic_description_prefix_key']]})"
+                          else
+                            settings[json_config]['description_prefix']
+                          end
+  end
+
   def handle(pd_client = nil)
     incident_key_prefix = settings[json_config]['incident_key_prefix']
-    description_prefix = settings[json_config]['description_prefix']
+    description_prefix = description_prefix()
     proxy_settings = proxy_settings()
     begin
-      timeout(5) do
+      Timeout.timeout(10) do
         if proxy_settings['proxy_host']
           pagerduty = pd_client || Pagerduty.new(api_key,
                                                  proxy_host: proxy_settings['proxy_host'],
@@ -88,7 +100,8 @@ class PagerdutyHandler < Sensu::Handler
           when 'create'
             pagerduty.trigger([description_prefix, event_summary].compact.join(' '),
                               incident_key: [incident_key_prefix, incident_key].compact.join(''),
-                              details: @event)
+                              details: @event,
+                              contexts: contexts)
           when 'resolve'
             pagerduty.get_incident([incident_key_prefix, incident_key].compact.join('')).resolve(
               [description_prefix, event_summary].compact.join(' '), @event

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

@@ -1,7 +1,7 @@
 module SensuPluginsPagerduty
   module Version
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     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.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -205,9 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for pagerduty
 test_files: []
-has_rdoc: