sensu-plugins-opsgenie 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 929407b301ce32ca0b432eb4a1208ba85b1e8451
-  data.tar.gz: e07861ef0a65c865461674731700b117259b8b85
+SHA256:
+  metadata.gz: 323357f14532830637c6a10405ac536583d62e69800bf3826e779d96df4b9bf6
+  data.tar.gz: 35402983316c7d647a512e4744b79a2db7143e5d26a2fe96772a862a5cd1cd9d
 SHA512:
-  metadata.gz: c2b0764e5ad806549f18d25b2c1ed1fa7af5a82a1f1e0f737dc792310bfd8a699fe3134b6f18fd0f44846e44828fa4afa55a0ed4791b15f50f0c759d12ca23c1
-  data.tar.gz: c840e61929c62e6b7d69e36fb3f44198a7004567a8522ebce2b662d666de4ff5230296a93e6ef56ca50e80a4902df2bb74f8520e68eb6806c63ceebdd2850875
+  metadata.gz: 187b11496746b73be05ed9b7f945e49b7b25cb221599a17ea4a4a0a3efe76973c496e17dc26fff98e924cdd31a4e6ce3fe8d23cdcadf32d24ea9324172667d02
+  data.tar.gz: 25c68795b90f82b52a46e6941338590dce27c54b480a3388f7234f2e0651270db79689c89fceef887bb06d49a561bd07133da969c00aa2e4be289605ea952efc

data/CHANGELOG.md

@@ -5,6 +5,12 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [3.1.0] - 2017-11-12
+### Added
+- Added optional `-t, --template` parameter to specify the location of a ERB template file
+- Added possibility to specify custom timeout
+- Some cleanup and minor refactorings
+
 ## [3.0.0] - 2017-07-13
 ### Added
 - Testing on Ruby 2.4.1
@@ -58,7 +64,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/3.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/3.1.0...HEAD
+[3.1.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/3.0.0...3.1.0
 [3.0.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/2.0.1...3.0.0
 [2.0.1]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-opsgenie/compare/1.0.0...2.0.0

data/bin/handler-opsgenie.rb

@@ -8,39 +8,72 @@ require 'sensu-handler'
 require 'net/https'
 require 'uri'
 require 'json'
+require 'erb'
 
 class Opsgenie < Sensu::Handler
+  attr_reader :json_config, :message_template
+
+  OPSGENIE_URL = 'https://api.opsgenie.com/v1/json/alert'.freeze
+
   option :json_config,
          description: 'Configuration name',
          short: '-j <config-name>',
          long: '--json <config-name>',
          default: 'opsgenie'
 
+  option :message_template,
+         description: 'Location of custom erb template for advanced message formatting',
+         short: '-t <file_path>',
+         long:  '--template <file_path>',
+         default: nil
+
   def handle
-    @json_config = settings[config[:json_config]]
+    init
+    process
+  end
+
+  private
+
+  def init
+    @json_config      = settings[config[:json_config]] || {}
+    @message_template = config[:message_template]
     # allow config to be changed by the check
-    if @event['check']['opsgenie']
-      @json_config.merge!(@event['check']['opsgenie'])
-    end
-    message = @event['notification'] || [@event['client']['name'], @event['check']['name'], @event['check']['output'].chomp].join(' : ')
-
-    begin
-      Timeout.timeout(30) do
-        response = case @event['action']
-                   when 'create'
-                     create_alert(message)
-                   when 'resolve'
-                     close_alert
-                   end
-        if response['code'] == 200
-          puts 'opsgenie -- ' + @event['action'].capitalize + 'd incident -- ' + event_id
-        else
-          puts 'opsgenie -- failed to ' + @event['action'] + ' incident -- ' + event_id
-        end
+    json_config.merge!(@event['check']['opsgenie']) if @event['check']['opsgenie']
+  end
+
+  def process
+    timeout = json_config[:timeout] || 30
+    Timeout.timeout(timeout) do
+      response = case @event['action']
+                 when 'create'
+                   create_alert
+                 when 'resolve'
+                   close_alert
+                 end
+      if response['code'] == 200
+        puts 'opsgenie -- ' + @event['action'].capitalize + 'd incident -- ' + event_id
+      else
+        puts 'opsgenie -- failed to ' + @event['action'] + ' incident -- ' + event_id
       end
-    rescue Timeout::Error
-      puts 'opsgenie -- timed out while attempting to ' + @event['action'] + ' a incident -- ' + event_id
     end
+  rescue Timeout::Error
+    puts 'opsgenie -- timed out while attempting to ' + @event['action'] + ' a incident -- ' + event_id
+  end
+
+  def message
+    return @event['notification'] unless @event['notification'].nil?
+    return default_message if message_template.nil? || !File.exist?(message_template)
+    custom_message
+  rescue StandardError
+    default_message
+  end
+
+  def custom_message
+    ERB.new(File.read(message_template)).result(binding)
+  end
+
+  def default_message
+    [@event['client']['name'], @event['check']['name'], @event['check']['output'].chomp].join(' : ')
   end
 
   def event_id
@@ -63,39 +96,36 @@ class Opsgenie < Sensu::Handler
     @event['client']['name']
   end
 
-  def create_alert(message)
+  def create_alert
+    post_to_opsgenie(:create,
+                     alias:       event_id,
+                     message:     message,
+                     description: json_config['description'],
+                     entity:      client_name,
+                     tags:        tags.join(','),
+                     recipients:  json_config['recipients'],
+                     teams:       json_config['teams'])
+  end
+
+  def tags
     tags = []
-    tags << @json_config['tags'] if @json_config['tags']
-    tags << 'OverwriteQuietHours' if event_status == 2 && @json_config['overwrite_quiet_hours'] == true
+    tags << json_config['tags'] if json_config['tags']
+    tags << 'OverwriteQuietHours' if event_status == 2 && json_config['overwrite_quiet_hours'] == true
     tags << 'unknown' if event_status >= 3
     tags << 'critical' if event_status == 2
     tags << 'warning' if event_status == 1
-    unless event_tags.nil?
-      event_tags.each { |tag, value| tags << "#{tag}_#{value}" }
-    end
-
-    description = @json_config['description'] if @json_config['description']
-    recipients = @json_config['recipients'] if @json_config['recipients']
-    teams = @json_config['teams'] if @json_config['teams']
-
-    post_to_opsgenie(:create,
-                     alias: event_id,
-                     message: message,
-                     description: description,
-                     entity: client_name,
-                     tags: tags.join(','),
-                     recipients: recipients,
-                     teams: teams)
+    event_tags.each { |tag, value| tags << "#{tag}_#{value}" } unless event_tags.nil?
+    tags
   end
 
   def post_to_opsgenie(action = :create, params = {})
-    params['customerKey'] = @json_config['customerKey']
+    params['customerKey'] = json_config['customerKey']
 
     # override source if specified, default is ip
-    params['source'] = @json_config['source'] if @json_config['source']
+    params['source'] = json_config['source'] if json_config['source']
 
     uripath = (action == :create) ? '' : 'close'
-    uri = URI.parse("https://api.opsgenie.com/v1/json/alert/#{uripath}")
+    uri = URI.parse("#{OPSGENIE_URL}/#{uripath}")
     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,7 +5,7 @@ module SensuPluginsOpsgenie
   # This defines the version of the gem
   module Version
     MAJOR = 3
-    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-opsgenie
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for working with opsgenie