sensu-plugins-slack 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b457dae81022f3260abe503cef2919e2703112061173b097f60cbec5828313
-  data.tar.gz: 02c17b9e8b9349b5e284e338599dc690f1a314d9149935718a94ab21985f04a0
+  metadata.gz: fbc28b57823791c32fb8d544c1dcffd13bb6f34378de1a3076ffe01bcd99ed4c
+  data.tar.gz: 17adcc1cbcc70332b177a4e0b954e8f9f12a6e089ddbb57151a1444e06f4ae4e
 SHA512:
-  metadata.gz: 1f2a8f97b6870cbf4c9e9c0c9ae36c0401888406db29c89ff9f5ab7bee082cdd0be67027ae17312e889806f6015dde11aaf7c5ac81f62a01d7449a7d4092c963
-  data.tar.gz: 8be3d636a03ab8eb64b6e3da44850c873dbeda9219c0e3a044e0bce6b17b32f9c021360d482a9bfac4819e723abaaa006893baf1a452a5fb2521a85f8be08924
+  metadata.gz: 726ad96b3ab0602eb51f1969047c93f1e8a1eed9e6ef7060be5ea12edfdf54a3074955d451838d3c8055bcae5aa383867ac757ebbf09bd58764edeb7f1c832a1
+  data.tar.gz: b80b09535f11cc5526f6204a4b63e85ff0a14d54f0c4ce0a1d8a1a1abceb61c693f57b4cead2fd226e411f4703ca68497b4c25aa39fdd48b2c9a0e3706be59ec

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [4.1.0]- 2019-05-16
+### Added
+- `handler-slack`: added `webhook_retries` (default: 5), `webhook_timeout` (default: 10), and `webhook_retry_sleep` configuration properties to harden against failures due to networking, rate limits, etc. (@kali-brandwatch)
+
 ## [4.0.0] - 2019-04-02
 ### 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)
@@ -134,7 +138,8 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/4.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/4.0.0..4.1.0
 [4.0.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/3.1.1...4.0.0
 [3.1.1]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/3.1.0...3.1.1
 [3.1.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/3.0.0...3.1.0

data/bin/handler-slack.rb

@@ -30,6 +30,21 @@ class Slack < Sensu::Handler
     get_setting('webhook_url')
   end
 
+  def slack_webhook_retries
+    # The number of retries to deliver the payload to the slack webhook
+    get_setting('webhook_retries') || 5
+  end
+
+  def slack_webhook_timeout
+    # The amount of time (in seconds) to give for the webhook request to complete before failing it
+    get_setting('webhook_timeout') || 10
+  end
+
+  def slack_webhook_retry_sleep
+    # The amount of time (in seconds) to wait in between webhook retries
+    get_setting('webhook_retry_sleep') || 5
+  end
+
   def slack_icon_emoji
     get_setting('icon_emoji')
   end
@@ -149,27 +164,47 @@ class Slack < Sensu::Handler
            end
     http.use_ssl = true
 
-    req = Net::HTTP::Post.new("#{uri.path}?#{uri.query}", 'Content-Type' => 'application/json')
-
-    if payload_template.nil?
-      text = slack_surround ? slack_surround + body + slack_surround : body
-      req.body = payload(text).to_json
-    else
-      req.body = body
-    end
-
-    response = http.request(req)
-    verify_response(response)
-  end
-
-  def verify_response(response)
-    case response
-    when Net::HTTPSuccess
-      true
-    else
-      raise response.error!
-    end
-  end
+    # Implement a retry-timeout strategy to handle slack api issues like network. Should solve #15
+    begin # retries loop
+      tries = slack_webhook_retries
+      Timeout.timeout(slack_webhook_timeout) do
+        begin # main loop for trying to deliver the message to slack webhook
+          req = Net::HTTP::Post.new("#{uri.path}?#{uri.query}", 'Content-Type' => 'application/json')
+
+          if payload_template.nil?
+            text = slack_surround ? slack_surround + body + slack_surround : body
+            req.body = payload(text).to_json
+          else
+            req.body = body
+          end
+
+          http.request(req)
+
+        # replace verify_response with a rescue within the loop
+        rescue Net::HTTPServerException => error
+          if (tries -= 1) > 0
+            sleep slack_webhook_retry_sleep
+            puts "retrying incident #{incident_key}... #{tries} left"
+            retry
+          else
+            # raise error for sensu-server to catch and log
+            puts "slack api failed (retries) #{incident_key}: #{error.response.code} #{error.response.message}: channel '#{slack_channel}', message: #{body}"
+            exit 1
+          end
+        end # of main loop for trying to deliver the message to slack webhook
+      end # of timeout:do loop
+    # if the timeout is exceeded, consider this try failed
+    rescue Timeout::Error
+      if (tries -= 1) > 0
+        puts "timeout hit, retrying... #{tries} left"
+        retry
+      else
+        # raise error for sensu-server to catch and log
+        puts "slack webhook failed (timeout) #{incident_key}: channel '#{slack_channel}', message: #{body}"
+        exit 1
+      end
+    end # of retries loop
+  end # of post_data
 
   def payload(notice)
     client_fields = []

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

@@ -1,7 +1,7 @@
 module SensuPluginsSlack
   module Version
     MAJOR = 4
-    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-slack
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis