sensu-plugins-opsgenie 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b331b034218de65cc7d965a6136348bb39ea74af1b09b3cde378b0e19af985b
-  data.tar.gz: 06755ff6af1bf028ff6705af8cd17a9f335a8104d1331fce85b41905c7731117
+  metadata.gz: 60da9a2150addc0545bb2b0f982c4f803e6fc8444b26499a9ff55a3dc10571a2
+  data.tar.gz: 4af0d744eb11c9e6633c01f2be7f85a7ecccb89b7795f17bdbed220da73a7095
 SHA512:
-  metadata.gz: a31eda02fa5551796050e3c0248a2c9e5a84a3691156c4a4e225cff1564c2613ee40a68e6546e1044fb9975713888bb37a126a6ad4ca13877297159040a3801c
-  data.tar.gz: 0d05f8a9e29149ea4199f511d6fb9ec0edf62f05189a0bcb86497e1f0e693f68b6f1fc86d37584d6aeee6241b1af4be0491977d2558449a433f92ac46fa5375a
+  metadata.gz: 517c8af283e218ef9bef4bda6034c70866d38509ac5eb996f56f6f817b8001e2c1d849fab103fb53cf3c4e07f93e60d49cab3d08524710aefb1a62b8a41c414d
+  data.tar.gz: 27e42a03d769276d52f77ae245bcfce0da47cf74ee2ecc259d860e182623f9b95509f092a13c1c99cebf82b786232d376a5f4fcc761bd4d2e63c5a4760cb0a55

data/CHANGELOG.md

@@ -5,6 +5,13 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [4.2.0] - 2018-02-20
+### Changed
+- Providing better alert description field using Sensu check output (@Castaglia)
+
+### Added
+- `handler-opsgenie.rb`: Added flag of `--verbose` to enable verbose/debugging output (@Castaglia)
+
 ## [4.1.2] - 2018-02-05
 ### Fixed
 - Handling of tags for events (@Castaglia)
@@ -100,6 +107,7 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 - Fixed json configuration load
 
 [Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.2...HEAD
+[4.2.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.2...4.2.0
 [4.1.2]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.1...4.1.2
 [4.1.1]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.0...4.1.1
 [4.1.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.0.1...4.1.0

data/README.md

@@ -81,7 +81,54 @@ To get this to work you need to specify a few different things. For a list of fi
 }
 ```
 
-## Notes
+## OpsGenie Alerts
+
+How does the handler map the various Sensu values into the OpsGenie
+[alerts and alert fields](https://docs.opsgenie.com/docs/alerts-and-alert-fields) created?
+
+### Message
+
+The OpsGenie _message_ alert field is comprised of the Sensu client name, and
+the Sensu check name, _e.g._:
+```
+web01 : check_mysql_access
+```
+
+### Teams
+
+The OpsGenie _team_ alert field uses the values in the Sensu check configuration
+if any, otherwise it uses the value from the handler configuration.
+
+### Recipients
+
+The OpsGenie _recipients_ alert field uses the values in the Sensu check
+configuration if any, otherwise it uses the value from the handler
+configuration.
+
+### Alias
+
+The OpsGenie _alias_ alert is field is comprised of the Sensu client name,
+and the Sensu check name to create a unique key, _e.g._:
+```
+web01:check_mysql_access
+```
+Note that this can be changed via configuration; see notes below.
+
+### Entity
+
+The OpsGenie _entity_ alert field uses the Sensu client name.
+
+### Description
+
+The OpsGenie _description_ alert field is populated with the Sensu check output.
+
+### Priority
+
+The OpsGenie _priority_ alert field is not explicitly set; OpsGenie will thus
+assign the default priority of "P3" to the alert.
+
+
+## Configuration Notes
 
 If the check definition uses the custom `alias` attribute, _e.g._:
 ```

data/bin/handler-opsgenie.rb

@@ -11,7 +11,7 @@ require 'json'
 require 'erb'
 
 class Opsgenie < Sensu::Handler
-  attr_reader :json_config, :message_template
+  attr_reader :json_config, :message_template, :verbose
 
   OPSGENIE_URL = 'https://api.opsgenie.com/v2/alerts'.freeze
 
@@ -27,6 +27,12 @@ class Opsgenie < Sensu::Handler
          long:  '--template <file_path>',
          default: nil
 
+  option :verbose,
+         description: 'Enable verbose/debugging output',
+         short: '-v',
+         long: '--verbose',
+         default: false
+
   def handle
     init
     process
@@ -66,6 +72,11 @@ class Opsgenie < Sensu::Handler
     puts "opsgenie -- timed out while attempting to #{@event['action']} a incident -- #{event_id}"
   end
 
+  def description
+    return json_config['description'] unless json_config['description'].nil?
+    @event['check']['output'].chomp
+  end
+
   def message
     return @event['notification'] unless @event['notification'].nil?
     return default_message if message_template.nil? || !File.exist?(message_template)
@@ -79,7 +90,7 @@ class Opsgenie < Sensu::Handler
   end
 
   def default_message
-    [@event['client']['name'], @event['check']['name'], @event['check']['output'].chomp].join(' : ')
+    [@event['client']['name'], @event['check']['name']].join(' : ')
   end
 
   def event_id
@@ -111,7 +122,7 @@ class Opsgenie < Sensu::Handler
     post_to_opsgenie(:create,
                      alias:       event_id,
                      message:     message,
-                     description: json_config['description'],
+                     description: description,
                      entity:      client_name,
                      tags:        tags,
                      recipients:  json_config['recipients'],
@@ -145,6 +156,19 @@ class Opsgenie < Sensu::Handler
                 "#{encoded_alias}/close?identifierType=alias"
               end
     uri = URI.parse("#{OPSGENIE_URL}/#{uripath}")
+
+    if config[:verbose]
+      # Note that the ordering of these lines roughly follows the order
+      # alert fields are displayed in the OpsGenie web UI.
+      puts "URL: #{uri}"
+      puts "Message: #{params[:message]}"
+      puts "Tags: #{params[:tags]}"
+      puts "Entity: #{params[:entity]}"
+      puts "Teams: #{params[:teams]}"
+      puts "Alias: #{params[:alias]}"
+      puts "Description: #{params[:description]}"
+    end
+
     http = Net::HTTP.new(uri.host, uri.port)
     http.use_ssl = true
     http.verify_mode = OpenSSL::SSL::VERIFY_NONE

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 = 1
-    PATCH = 2
+    MINOR = 2
+    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.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -267,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with opsgenie