sensu-plugins-telegram 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44dcdd9f2bbeb114f84c725b7df2f2e7d23b2a38
-  data.tar.gz: ca812cdac116189c7657804385292d2c7ddcd6bb
+  metadata.gz: b27c66b68f1ee795b6aa43157a5fd6f41d215582
+  data.tar.gz: d5819eb9b5e000459f20265a4e4e60461ccee9da
 SHA512:
-  metadata.gz: c72fe5c116dd5e7fcd749762d2006780e12855d4b87e5f7f45df5acb355495ad489c5a10e9384e0b4d75c8aa5cf197428f0adb08a0927a51262cab0652759117
-  data.tar.gz: bccb86613026e1cf88d2e5393d103deec939f9749021b851d26f73f8e676a09588019de8994d75d16750adf6a5c14b8ea3e8196cff43260784d91de726bd33ea
+  metadata.gz: 7a27771ac2da30b8a25a711777c6450d605876c73c8cd586af2ed7b99d469f433744fa5caf98cc78ed6b40d866e337357f93e4ead52937c328b53242aa19b36a
+  data.tar.gz: c104cab7aa44ec827173e55fe3f087a8820637519824f88973057da4dc576a8f3a51a9798ff67037b8c16a6b1918ccf20376b968e2d889e1a18ca9d03e9c9c42

data/README.md

@@ -15,7 +15,20 @@ This plugin provides a handler to send notifications to a Telegram chat.
 
 ## Usage
 
-This gem requires a JSON configuration file with the following contents:
+After installation, you have to set up a `pipe` type handler, like so:
+
+```json
+{
+  "handlers": {
+    "telegram": {
+      "type": "pipe",
+      "command": "handler-telegram.rb"
+    }
+  }
+}
+```
+
+This gem also expects a JSON configuration file with the following contents:
 
 ```json
 {
@@ -39,10 +52,53 @@ This gem requires a JSON configuration file with the following contents:
   be written to a file in this location. You can then monitor this
   location to detect any errors with the Telegram handler.
 
-If you want to send some events to one chat, and other events to another
-chat, you can directly add the chat_id to the event data (the `@event` hash)
-using a mutator. Then, create one handler specification for each channel,
-specifying the corresponding mutator. For example:
+### Advanced configuration
+
+By default, the handler assumes that the config parameters are specified in the
+`telegram` top-level key of the JSON, as shown above. You also have the option
+to make the handler fetch the config from a different key. To do this, pass the
+`-j` option to the handler with the name of the desired key You can define
+multiple handlers, and each handler can send notifications to a different chat
+and from a different bot. You could, for example, have critical and non-critical
+Telegram groups, and send the notifications to one or the other depending on the
+check. For example:
+
+```json
+{
+  "handlers": {
+    "critical_telegram": {
+      "type": "pipe",
+      "command": "handler-telegram.rb -j critical_telegram_options"
+    },
+    "non_critical_telegram": {
+      "type": "pipe",
+      "command": "handler-telegram.rb -j non_critical_telegram_options"
+    }
+  }
+}
+```
+
+This example will fetch the options from a JSON like this:
+
+```json
+{
+  "telegram": {
+    "bot_token": "YOUR_BOT_TOKEN"
+  },
+  "critical_telegram_options": {
+    "chat_id": -123123
+  },
+  "non_critical_telegram_options": {
+    "chat_id": -456456
+  }
+}
+```
+
+As you can see, you can specify the default config in the `telegram` key, and
+the rest of the config in their own custom keys.
+
+You can also directly add the configuration parameters to the event data using a
+mutator. For example:
 
 ```ruby
 #!/usr/bin/env ruby
@@ -53,6 +109,14 @@ event.merge!(chat_id: -456456)
 puts JSON.dump(event)
 ```
 
+### Configuration precedence
+
+The handler will load the config as follows (from least to most priority):
+
+* Default `telegram` key
+* Custom config keys
+* Event data
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/handler-telegram.rb

@@ -25,27 +25,7 @@
 #         "error_file_location": "/tmp/telegram_handler_error"
 #       }
 #     }
-#
-#   Parameters:
-#     - bot_token: your bot's token, as provided by @BotFather
-#     - chat_id: the chat to which the error message is to be sent.
-#       The bot must be a member of this channel or group.
-#       You can get this chat_id by adding the bot to the corresponding group
-#       and then accessing https://api.telegram.org/bot<TOKEN>/getUpdates
-#     - error_file_location (optional): in case there is a failure sending the
-#       message to Telegram (ie. connectivity issues), the exception mesage will
-#       be written to a file in this location. You can then monitor this
-#       location to detect any errors with the Telegram handler.
-#
-#   If you want to send some events to one chat, and other events to another
-#   chat, you can directly add the chat_id to the event data (the `@event` hash)
-#   using a mutator. For example:
-#     #!/usr/bin/env ruby
-#     require 'rubygems'
-#     require 'json'
-#     event = JSON.parse(STDIN.read, :symbolize_names => true)
-#     event.merge!(chat_id: -456456)
-#     puts JSON.dump(event)
+#   For more details, please see the README.
 #
 # NOTES:
 #
@@ -58,23 +38,37 @@
 require 'rubygems' if RUBY_VERSION < '1.9.0'
 require 'sensu-handler'
 require 'restclient'
+require 'cgi'
 
 class TelegramHandler < Sensu::Handler
+  option :json_config,
+         description: 'Config name',
+         short: '-j config_key',
+         long: '--json_config config_key',
+         required: false
 
   def chat_id
-    @event['chat_id'] || settings['telegram']['chat_id']
+    fetch_setting 'chat_id'
   end
 
   def bot_token
-    settings['telegram']['bot_token']
+    fetch_setting 'bot_token'
   end
 
   def error_file
-    settings['telegram']['error_file_location']
+    fetch_setting 'error_file_location'
+  end
+
+  def fetch_setting(setting_key)
+    config_key = config[:json_config]
+
+    value = @event[setting_key]
+    value ||= settings[config_key][setting_key] if config_key
+    value || settings['telegram'][setting_key]
   end
 
   def event_name
-    @event['client']['name'] + '/' + @event['check']['name']
+    client_name + '/' + check_name
   end
 
   def action_name
@@ -86,17 +80,42 @@ class TelegramHandler < Sensu::Handler
     actions[@event['action']]
   end
 
+  def action_icon
+    icons = {
+      'create' => "\xF0\x9F\x98\xB1",
+      'resolve' => "\xF0\x9F\x98\x8D",
+      'flapping' => "\xF0\x9F\x90\x9D"
+    }
+    icons[@event['action']]
+  end
+
+  def client_name
+    escape_html @event['client']['name']
+  end
+
+  def check_name
+    escape_html @event['check']['name']
+  end
+
+  def output
+    escape_html @event['check']['output']
+  end
+
+  def escape_html(string)
+    CGI.escapeHTML(string)
+  end
+
   def telegram_url
     "https://api.telegram.org/bot#{bot_token}/sendMessage"
   end
 
   def build_message
     [
-      "<b>Alert #{action_name}</b>",
-      "<b>Host:</b> #{@event['client']['name']}",
-      "<b>Check:</b> #{@event['check']['name']}",
-      "<b>Status:</b> #{translate_status}",
-      "<b>Output:</b> #{@event['check']['output']}"
+      "<b>Alert #{action_name}</b> #{action_icon}",
+      "<b>Host:</b> #{client_name}",
+      "<b>Check:</b> #{check_name}",
+      "<b>Status:</b> #{status} #{status_icon}",
+      "<b>Output:</b> <code>#{output}</code>"
     ].join("\n")
   end
 
@@ -111,33 +130,31 @@ class TelegramHandler < Sensu::Handler
 
   def handle_error(exception)
     open(error_file, 'w') do |f|
-      f.puts "URL: " + telegram_url
-      f.puts "Params: " + params.inspect
-      f.puts "Exception: " + exception.inspect
+      f.puts 'URL: ' + telegram_url
+      f.puts 'Params: ' + params.inspect
+      f.puts 'Exception: ' + exception.inspect
     end if error_file
   end
 
   def clear_error
-    File.delete(error_file) if File.exist?(error_file)
+    File.delete(error_file) if error_file && File.exist?(error_file)
   end
 
   def handle
-    begin
-      print "Sending to Telegram: " + params.inspect
-      RestClient.post(telegram_url, params, format: :json)
-      puts "... done."
-      clear_error
-    rescue SocketError, RestClient::Exception => e
-      handle_error(e)
-      puts "... Telegram handler error '#{e.inspect}' while attempting to report an incident: #{event_name} #{action_name}"
-    end
+    print 'Sending to Telegram: ' + params.inspect
+    RestClient.post(telegram_url, params, format: :json)
+    puts '... done.'
+    clear_error
+  rescue SocketError, RestClient::Exception => e
+    handle_error(e)
+    puts "... Telegram handler error '#{e.inspect}' while attempting to report an incident: #{event_name} #{action_name}"
   end
 
   def check_status
     @event['check']['status']
   end
 
-  def translate_status
+  def status
     status = {
       0 => 'OK',
       1 => 'Warning',
@@ -146,4 +163,14 @@ class TelegramHandler < Sensu::Handler
     }
     status[check_status.to_i]
   end
+
+  def status_icon
+    icons = {
+      0 => "\xF0\x9F\x91\x8D",
+      1 => "\xE2\x9A\xA1",
+      2 => "\xF0\x9F\x9A\xA8",
+      3 => "\xF0\x9F\x8C\x80"
+    }
+    icons[check_status.to_i]
+  end
 end

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

@@ -1,8 +1,8 @@
 module SensuPluginsTelegram
   module Version
     MAJOR = 0
-    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-telegram
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Hernan Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin