sensu-plugins-opsgenie 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bd3826a3acb4f4fb2321c7a82774d9e9bb2f0da41b4f0ae7ba3bccb0c6c5946
-  data.tar.gz: a393ec78de3a7c46f97754da70e3a5bb0e11c203a77175e87ce6982835f13819
+  metadata.gz: faf5d85fd7a0b67c548f58d23def4e94a60c371898ae21a8def6b85190a90d13
+  data.tar.gz: c30d35754b9edf57a5293895701918eb09290900636258ad57d7f62e06cafd37
 SHA512:
-  metadata.gz: 632312ea4f30eaeb5158fd2d5ba993b3413decf572e22d6afa15c41c0bf8f0d991c610e0239fa42132b8a4039731ebda15779b47dbd6d774968060f0e2e18206
-  data.tar.gz: 3a7806f26770a42e7fe833e3188b97c6560d287ea00037db7cee96a8b1acdad258658e79aa34563b29f3d23d99a98a184171c2b665d81e0165770ff94f9e6c30
+  metadata.gz: 462592d60faf80d7bbd44bf97b0e77f8576ce393cb9463cd28d04b5a76f44a8edf71f2019462eeacf4c89c9f0a9d54668433946e7756ed02384ef12528b4873f
+  data.tar.gz: 6979f09f5efde25851ee26ca38ee2686b98277f57c358c5ae841f50a5c7dfe9df66ac16058664cbe39d146dca8605a0b9a59d1c71454a845e54de1842530c3a6

data/CHANGELOG.md

@@ -1,10 +1,17 @@
-#Change Log
+# Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
 
+## [4.1.0] 2018-01-14
+### Added
+- Added possibility to specify custom alias for event ID, this acts in a similar way to proxy/JIT clients to dedupe alerts (@Castaglia)
+
+### Changed
+- updated Changelog guidelines location (@majormoses)
+
 ## [4.0.1] - 2018-01-06
 ### Fixed
 - Use Alert v2 API, as the Alert v1 API is deprecated (@Castaglia)
@@ -78,7 +85,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 - initial release
 - Fixed json configuration load
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.0.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.0.1...4.1.0
 [4.0.1]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.0.0...4.0.1
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/3.1.0...4.0.0
 [3.1.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/3.0.0...3.1.0

data/README.md

@@ -79,3 +79,56 @@ To get this to work you need to specify a few different things. For a list of fi
 ```
 
 ## Notes
+
+If the check definition uses the custom `alias` attribute, _e.g._:
+```
+{
+  "checks": {
+    "check_mysql_access": {
+      "opsgenie": {
+        "alias": "MyCustomAlias",
+
+```
+then the `handler-opsgenie.rb` handler will use that attribute value as the
+OpsGenie event ID.  This can be useful for alert deduplication; checks on
+different clients for the same downstream resource can specify the same
+`alias` attribute, so that multiple alerts for the same resource are
+de-duplicated.
+
+By default, `handler-opsgenie.rb` creates an event ID from the client name
+and the check name.  Thus:
+```
+{
+  "checks": {
+    "check_mysql_access": {
+      "command": "/opt/sensu/embedded/bin/check-database.rb -h mysqldb",
+      "interval": 60,
+      "handlers": [ "opsgenie" ],
+      "standalone": true
+    }
+  }
+```
+running on a client named `web01` will create an alert using an event ID of
+`web01:check_mysql_access`.  And on a client named `web02`, it would create an
+alert with a _different_ event ID of `web02:check_mysql_access`, even though
+the `mysqldb` server being checked is the same for these clients.
+
+We can define a custom `alias` attribute in this check:
+```
+{
+  "checks": {
+    "check_mysql_access": {
+      "command": "/opt/sensu/embedded/bin/check-database.rb -h mysqldb",
+      "interval": 60,
+      "handlers": [ "opsgenie" ],
+      "standalone": true,
+
+      "opsgenie": {
+        "alias": "mysqldb"
+      }
+    }
+  }
+```
+And with this, running on multiple clients, any alerts would be generated
+with the same event ID of `mysqldb`, by using that `alias` attribute as the
+event ID.

data/bin/handler-opsgenie.rb

@@ -52,18 +52,18 @@ class Opsgenie < Sensu::Handler
                  end
       case response.code.to_s
       when '200', '202'
-        puts 'opsgenie -- ' + @event['action'].capitalize + 'd incident -- ' + event_id
+        puts "opsgenie -- #{@event['action'].capitalize}d incident -- #{event_id}"
       when '401'
-        puts 'opsgenie -- failed to ' + @event['action'] + ' incident -- not authorized'
+        puts "opsgenie -- failed to #{@event['action']} incident -- #{event_id}: not authorized"
       when '404'
-        puts 'opsgenie -- failed to ' + @event['action'] + ' incident -- ' + event_id + ' not found'
+        puts "opsgenie -- failed to #{@event['action']} incident -- #{event_id} not found"
       else
-        puts 'opsgenie -- failed to ' + @event['action'] + ' incident -- ' + event_id
+        puts "opsgenie -- failed to #{@event['action']} incident -- #{event_id}"
         puts "HTTP #{response.code} #{response.message}: #{response.body}"
       end
     end
   rescue Timeout::Error
-    puts 'opsgenie -- timed out while attempting to ' + @event['action'] + ' a incident -- ' + event_id
+    puts "opsgenie -- timed out while attempting to #{@event['action']} a incident -- #{event_id}"
   end
 
   def message
@@ -83,6 +83,8 @@ class Opsgenie < Sensu::Handler
   end
 
   def event_id
+    return @event['check']['opsgenie']['alias'] unless @event['check']['opsgenie'].nil? || @event['check']['opsgenie']['alias'].nil?
+
     # Do not use slashes in the event ID, as this alias becomes part of the URI
     # in the RESTful interactions with OpsGenie; use characters which can be
     # easily embedded into a URI.

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

@@ -5,8 +5,8 @@ module SensuPluginsOpsgenie
   # This defines the version of the gem
   module Version
     MAJOR = 4
-    MINOR = 0
-    PATCH = 1
+    MINOR = 1
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-opsgenie
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin