sensu-plugins-opsgenie 4.2.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60da9a2150addc0545bb2b0f982c4f803e6fc8444b26499a9ff55a3dc10571a2
-  data.tar.gz: 4af0d744eb11c9e6633c01f2be7f85a7ecccb89b7795f17bdbed220da73a7095
+  metadata.gz: c0608935d141e4ae3e702f438327df42b6c9b932596cbee8a502314f9c2ce899
+  data.tar.gz: 1dbb40c4e8295e52b7c475f0e404e62660559276a522a47386f4199237596925
 SHA512:
-  metadata.gz: 517c8af283e218ef9bef4bda6034c70866d38509ac5eb996f56f6f817b8001e2c1d849fab103fb53cf3c4e07f93e60d49cab3d08524710aefb1a62b8a41c414d
-  data.tar.gz: 27e42a03d769276d52f77ae245bcfce0da47cf74ee2ecc259d860e182623f9b95509f092a13c1c99cebf82b786232d376a5f4fcc761bd4d2e63c5a4760cb0a55
+  metadata.gz: ff77b0452136239a1cc601b9bffbff1b985e8dc966fac57c53a8fd7e90ad4fdde685f54d2a117343f5749eb10cc831fd6ab0efa4deefe3ef2cf6f537f7014475
+  data.tar.gz: 875ef0d4eeff85043caf8c0221340a2003f8fabc13df73e8a5d691b8bea28d1e8d582c6c33914345f5eb4adbf1bfd9e1741ac6a8ee65733b760fa016a9cb7796

data/CHANGELOG.md

@@ -5,6 +5,21 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [5.1.0] - 2022-03-28
+
+### Added
+- adding `details` to handler if present (@saurabh-iitrke)
+
+## [5.0.0] - 2019-03-05
+### Breaking Changes
+- Bump sensu-plugin version from `~> 2.0` to `~> 4.0` for Sensu 1.x to Sensu Go event conversion you can read the changelog entries for [4.0](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#400---2018-02-17) and [3.0](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#300---2018-12-04)
+- drop support and testing for ruby 2.1 and 2.2 as they are EOL
+=======
+
+## [4.3.0] - 2018-03-21
+### Added
+- Added possibility to specify priority per check (@Castaglia)
+
 ## [4.2.0] - 2018-02-20
 ### Changed
 - Providing better alert description field using Sensu check output (@Castaglia)
@@ -106,7 +121,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 - initial release
 - Fixed json configuration load
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.1.2...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/5.1.0...HEAD
+[5.1.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/5.0.0...5.1.0
+[5.0.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.3.0...5.0.0
+[4.3.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/4.2.0...4.3.0
 [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

data/README.md

@@ -130,6 +130,10 @@ assign the default priority of "P3" to the alert.
 
 ## Configuration Notes
 
+### Per Check Attributes
+
+#### `alias`
+
 If the check definition uses the custom `alias` attribute, _e.g._:
 ```
 {
@@ -182,3 +186,25 @@ We can define a custom `alias` attribute in this check:
 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.
+
+#### `priority`
+
+By default, an OpsGenie alert is created with a default [priority](https://docs.opsgenie.com/docs/priority-settings) value of "P3".  The priority for a specific
+check can be explicitly set using the custom `priority` attribute, _e.g._:
+```
+{
+  "checks": {
+    "check_mysql_access": {
+      "opsgenie": {
+        "priority": "P1",
+
+```
+The list of valid values, per [OpsGenie alert docs](https://docs.opsgenie.com/docs/alert-api#section-create-alert), are:
+
+* P1
+* P2
+* P3
+* P4
+* P5
+
+Any value other than these will be ignored.

data/bin/handler-opsgenie.rb

@@ -14,6 +14,8 @@ class Opsgenie < Sensu::Handler
   attr_reader :json_config, :message_template, :verbose
 
   OPSGENIE_URL = 'https://api.opsgenie.com/v2/alerts'.freeze
+  PRIORITIES = %w[P1 P2 P3 P4 P5].freeze
+  DEFAULT_PRIORITY = 'P3'.freeze
 
   option :json_config,
          description: 'Configuration name',
@@ -118,6 +120,12 @@ class Opsgenie < Sensu::Handler
     @event['client']['name']
   end
 
+  def details
+    details = {}
+    return @event['check']['opsgenie']['details'] unless @event['check']['opsgenie'].nil? || @event['check']['opsgenie']['details'].nil?
+    details
+  end
+
   def create_alert
     post_to_opsgenie(:create,
                      alias:       event_id,
@@ -126,7 +134,21 @@ class Opsgenie < Sensu::Handler
                      entity:      client_name,
                      tags:        tags,
                      recipients:  json_config['recipients'],
-                     teams:       json_config['teams'])
+                     teams:       json_config['teams'],
+                     details:     details)
+  end
+
+  def event_priority
+    return DEFAULT_PRIORITY unless json_config['priority']
+    priority = json_config['priority']
+
+    canonical_priority = priority.upcase
+    unless PRIORITIES.include? canonical_priority
+      puts "opsgenie -- ignoring unsupported priority '#{priority}'"
+      canonical_priority = DEFAULT_PRIORITY
+    end
+
+    canonical_priority
   end
 
   def tags
@@ -141,9 +163,13 @@ class Opsgenie < Sensu::Handler
   end
 
   def post_to_opsgenie(action = :create, params = {})
-    # override source if specified, default is ip
+    # Override source if specified, default is ip
     params['source'] = json_config['source'] if json_config['source']
 
+    # Override priority, if specified.
+    priority = event_priority
+    params['priority'] = priority if priority
+
     encoded_alias = URI.escape(params[:alias])
     # TODO: come back and asses if this logic is correct, I left it functionally
     # as it was originally written but I suspect we should have at least three
@@ -167,6 +193,7 @@ class Opsgenie < Sensu::Handler
       puts "Teams: #{params[:teams]}"
       puts "Alias: #{params[:alias]}"
       puts "Description: #{params[:description]}"
+      puts "Details: #{params[:details]}"
     end
 
     http = Net::HTTP.new(uri.host, uri.port)

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

@@ -4,8 +4,8 @@ require 'json'
 module SensuPluginsOpsgenie
   # This defines the version of the gem
   module Version
-    MAJOR = 4
-    MINOR = 2
+    MAJOR = 5
+    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.2.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2022-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.1
+        version: 2.41.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.1
+        version: 2.41.5
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
@@ -259,15 +259,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with opsgenie