sensu-plugins-slack 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9db07df331e402395365319e4772798ce55f79ba
-  data.tar.gz: 5c44de22dd791ddf483ddcb9b355721cb7cef070
+  metadata.gz: a9e17d470810e6c1b420fd9978176d83068be519
+  data.tar.gz: 92bc6643bb39dd91419fd92a532b3a51637c9a34
 SHA512:
-  metadata.gz: 74fb4ba744491325b6c151329c95cb727d3bb392044d7c95fd91a745066ba387dd61e84b5c4839bf23d226ca73f2206669e8c95250d25b72d794789391dde230
-  data.tar.gz: 021347360047ba11bc4e35aa86e8c6f32f897dc7a69377a0b97dc008801bc231735280c691ebdb01df773bd26f6a184529a9fb795d98b29bfa3bd062e3609aac
+  metadata.gz: 28f88ff3cf8228d5fada54e72e0c902ed08b7cd38729b247162bbf483f1643e14f8b09aba012b29754e48d4aec1f83e4757e9ced821e8be6a01492af6957c58d
+  data.tar.gz: f1bc4b64b7297383b597c6f20bb4bad8e9f8994e42b761bc047e3e4b3b5b01d9eb7577379f6a3b540c055bd556e65713fe05c2633d0a105596940a2f8e6463af

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.2.0] - 2017-07-13
+### Added
+- ruby 2.4 testing in travis (@majormoses)
+- `slack-handler-multichannel.rb`: Add custom_field options to supply additional fields (@justbkuz)
+
 ## [1.1.1] - 2017-06-24
 ### Fixed
 - Ran rubocop against `bin/slack-handler.rb` and `bin/slack-handler-multichannel.rb` (@pgporada)
@@ -80,7 +85,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.1.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.2.0...HEAD
+[1.2.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.1.1...1.2.0
 [1.1.1]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.1.0...1.1.1.
 [1.1.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.0.0...1.1.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/v0.1.2...1.0.0

data/README.md

@@ -12,7 +12,7 @@
  * bin/handler-slack.rb
  * bin/handler-slack-multichannel.rb
 
-## Usage
+## Usage for handler-slack.rb
 ```
 {
   "slack": {
@@ -41,6 +41,39 @@
   }
 }
 ```
+## Usage for handler-slack-multichannel.rb
+```
+{
+  "slack": {
+    "webhook_url": "webhook url",
+    "channel": {
+      "default": [ "#no-team-alerts" ],
+      "compulsory": [ "#all-alerts" ]
+    }
+    "message_prefix": "optional prefix - can be used for mentions",
+    "surround": "optional - can be used for bold(*), italics(_), code(`) and preformatted(```)",
+    "bot_name": "optional bot name, defaults to slack defined",
+    "link_names": "optional - find and link channel names and usernames",
+    "message_template": "optional description erb template file - /some/path/to/template.erb",
+    "payload_template": "optional json payload template file (note: overrides most other template options.)",
+    "template": "backwards-compatible alias for message_template",
+    "proxy_address": "The HTTP proxy address (example: proxy.example.com)",
+    "proxy_port": "The HTTP proxy port (if there is a proxy)",
+    "proxy_username": "The HTTP proxy username (if there is a proxy)",
+    "proxy_password": "The HTTP proxy user password (if there is a proxy)",
+    "icon_url": "https://raw.githubusercontent.com/sensu/sensu-logo/master/sensu1_flat%20white%20bg_png.png",
+    "icon_emoji": ":snowman:",
+    "custom_field": [
+      "list",
+      "of",
+      "optional",
+      "check_fields",
+      "to_render"
+    ]
+  }
+}
+```
+
 
 ## Installation
 

data/bin/handler-slack-multichannel.rb

@@ -41,6 +41,27 @@
 #       ...,
 #     }
 # }
+#
+# Custom Field support added:
+#
+# Adding custom_field to handler will add a field to message with that fields content, if that field doesn't exist it will be ignored.
+#
+#       "slack" {
+#         "channels" [ "#db-team-alerts" ],
+#         "custom_field" [
+#           "field_name",
+#           "field_name_2"
+#         ]
+#        }
+#
+# On your check.json
+#
+# {
+#   "checks": {
+#     "check_disk_usage": {
+#        "command": " ~/check-disk-usage.rb -w 90 -c 95",
+#        "field_name": "https://someurl.somewhere",
+#        "field_name_2: "something_you_want_added"
 
 require 'sensu-handler'
 require 'json'
@@ -107,6 +128,10 @@ class Slack < Sensu::Handler
     return false
   end
 
+  def custom_field
+    get_setting('custom_field')
+  end
+
   def compile_channel_list
     channels = []
 
@@ -231,12 +256,26 @@ class Slack < Sensu::Handler
   end
 
   def payload(notice, channel)
+    client_fields = []
+
+    unless custom_field.nil?
+      custom_field.each do |field|
+        is_short = true unless @event['client'].key?(field) && @event['client'][field].length > 50
+        field_title = field unless @event['check'][field].nil?
+        client_fields << {
+          title: field_title,
+          value: @event['check'][field],
+          short: is_short
+        }
+      end
+    end
     {
       icon_url: slack_icon_url ? slack_icon_url : 'https://raw.githubusercontent.com/sensu/sensu-logo/master/sensu1_flat%20white%20bg_png.png',
       attachments: [{
         title: "#{@event['client']['address']} - #{translate_status}",
         text: [slack_message_prefix, notice].compact.join(' '),
-        color: color
+        color: color,
+        fields: client_fields
       }]
     }.tap do |payload|
       payload[:channel] = channel

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

@@ -1,8 +1,8 @@
 module SensuPluginsSlack
   module Version
     MAJOR = 1
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-slack
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis