sensu-plugins-telegram 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0456677ce532f35d78c76b88a2282b43ed592d2
+  data.tar.gz: 98aef9c764e82803cfdd9f845c563a55442c3014
+SHA512:
+  metadata.gz: 76f5090947b9621d748bd9a95f15f6992ed188026442f39aba2aede7043e9c3cd17fa8e3b80966e82a722c623fc74e85a7838fa27d6f327bb8b656b8b43491dd
+  data.tar.gz: 27804ba3d44b433704bb4ca708d4986a0b01fc6fd4c3360f69c653f897dc2a906b2bfb1bdd59224059cb025e616a485d438436e6f4d933409c362cf19cb8b047

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## [Unreleased]
+## 0.1.0 - 2016-03-18
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Hernan Schmidt
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+## Sensu-Plugins-telegram
+
+<!-- [ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-campfire.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-campfire)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-campfire.svg)](http://badge.fury.io/rb/sensu-plugins-campfire)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-campfire/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-campfire)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-campfire/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-campfire)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-campfire.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-campfire) -->
+
+## Functionality
+
+This plugin provides a handler to send notifications to a Telegram chat.
+
+## Files
+ * bin/handler-telegram.rb
+
+## Usage
+
+This gem requires a JSON configuration file with the following contents:
+
+```json
+{
+  "telegram": {
+    "bot_token": "YOUR_BOT_TOKEN",
+    "chat_id": -123123,
+    "error_file_location": "/tmp/telegram_handler_error"
+  }
+}
+```
+
+### Parameters:
+- `bot_token`: your bot's token, as provided by
+   [@BotFather](https://telegram.me/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. Then, create one handler specification for each channel,
+specifying the corresponding mutator. For example:
+
+```ruby
+#!/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)
+```
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

data/bin/handler-telegram.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+#
+#   handler-telegram
+#
+# DESCRIPTION:
+#   This handler sends messages to a given Telegram chat (person, group
+#   or channel).
+#
+# OUTPUT:
+#   Plain text
+#
+# PLATFORMS:
+#   Linux, BSD, Windows, OS X
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   This gem requires a JSON configuration file with the following contents:
+#     {
+#       "telegram": {
+#         "bot_token": "YOUR_BOT_TOKEN",
+#         "chat_id": -123123,
+#         "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)
+#
+# NOTES:
+#
+# LICENSE:
+#
+#   Copyright 2016 Hernan Schmidt <hschmidt@suse.de>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'sensu-handler'
+require 'restclient'
+
+class TelegramHandler < Sensu::Handler
+
+  def chat_id
+    @event['chat_id'] || settings['telegram']['chat_id']
+  end
+
+  def bot_token
+    settings['telegram']['bot_token']
+  end
+
+  def error_file
+    settings['telegram']['error_file_location']
+  end
+
+  def event_name
+    @event['client']['name'] + '/' + @event['check']['name']
+  end
+
+  def action_name
+    actions = {
+      'create' => 'Created',
+      'resolve' => 'Resolved',
+      'flapping' => 'Flapping'
+    }
+    actions[@event['action']]
+  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']}"
+    ].join("\n")
+  end
+
+  def params
+    {
+      chat_id: chat_id,
+      text: build_message,
+      parse_mode: 'HTML',
+      disable_web_page_preview: true
+    }
+  end
+
+  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
+    end if error_file
+  end
+
+  def clear_error
+    File.delete(error_file) if 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
+  end
+
+  def check_status
+    @event['check']['status']
+  end
+
+  def translate_status
+    status = {
+      0 => 'OK',
+      1 => 'Warning',
+      2 => 'Critical',
+      3 => 'Unknown'
+    }
+    status[check_status.to_i]
+  end
+end

data/lib/sensu-plugins-telegram.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-telegram/version'

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

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

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-telegram
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hernan Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Sensu plugins for interfacing with Telegram messenger
+email: "<hschmidt@suse.de>"
+executables:
+- handler-telegram.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/handler-telegram.rb
+- lib/sensu-plugins-telegram.rb
+- lib/sensu-plugins-telegram/version.rb
+homepage: https://github.com/lagartoflojo/sensu-plugins-telegram
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for interfacing with Telegram messenger
+test_files: []
+has_rdoc: