sensu-plugins-matrix 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68a839404cf4da8c493f6c179605554be5500d90
+  data.tar.gz: c19e3900384c06849290ac9d73243a31d59da5fb
+SHA512:
+  metadata.gz: 158dc782d2e4ddd9409d422edd18d752fd2fd2e71af3f48a8750001acece55757552c1547f58c8843be761922e36a176db260336794c52f6f3b277978da85d97
+  data.tar.gz: 7bcc16c2bda25d4bda78667d490ff6afdfd7852989902fc277d1a3a780faa727a08d5d1c0590615dfe391c731ba786900184b37172afdb109c8ffd7fca2a24ea

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## 0.0.1 - 2019-07-24
+### Added
+- initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+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,85 @@
+## Sensu-Plugins-Matrix
+
+## Functionality
+
+This plugin provides a handler to send notifications to a Matrix chat.
+
+## Files
+ * bin/handler-matrix.rb
+
+ ## Usage
+
+After installation, you have to set up a `pipe` type handler, like so:
+
+```json
+{
+  "handlers": {
+    "matrix": {
+      "type": "pipe",
+      "command": "/opt/sensu/embedded/bin/handler-matrix.rb",
+      "filter": "occurrences"
+    }
+  }
+}
+```
+
+This gem also expects a JSON configuration file with the following contents:
+
+```json
+{
+    "matrix": {
+        "matrix_user": "sensu",
+        "matrix_access_token": "MDYOURTOKEN_HERE",                                                                                                                                                                                      
+        "matrix_server": "matrix.example.com",
+        "matrix_room_id": "!TBDXXXXXXXXX:matrix.example.com"
+    }
+}   
+```
+
+### Parameters:
+- `matrix_server`: The URL of the Matrix (synapse) instance
+- `matrix_user`: The username of the Matrix account that will be used to send
+  the messages. You probably want to use a special "bot" account for this.
+- `password`: The password of the Matrix account that will be used to send
+  the messages.
+- `matrix_access_token`: You can also specify a access token instead of the password
+- `matrix_room_id`: The room to which the error message is to be sent.
+- `message_template` (optional): An ERB template in Markdown to use to format
+  messages instead of the default. Supports the following variables:
+  - `action_to_string`
+  - `action_symbol`
+  - `client_name`
+  - `check_name`
+  - `status_to_string`
+  - `status_symbol`
+  - `occurrences`
+  - `output`
+- `message_template_file` (optional): A file to read an ERB template in Markdown
+  from to format messages. Supports the same variables as `message_template`.
+
+
+### Advanced configuration
+
+By default, the handler assumes that the config parameters are specified in the
+`matrix` 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 room
+and from a different bot. You could, for example, have critical and non-critical
+Matrix rooms, and send the notifications to one or the other depending on the
+check. For example:
+
+```json
+{
+  "handlers": {
+    "critical_matrix": {
+      "type": "pipe",
+      "command": "/opt/sensu/embedded/bin/handler-matrix.rb -j critical_matrix_options"
+    },
+    "non_critical_matrix": {
+      "type": "pipe",
+      "command": "/opt/sensu/embedded/bin/handler-matrix.rb -j non_critical_matrix_options"
+    }
+  }
+}
+```

data/bin/handler-matrix.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+#
+# Sensu Handler: mailer
+#
+# This handler formats alerts as mails and sends them off to a pre-defined recipient.
+#
+# Copyright 2019 Seji64
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+
+# Note: The default matrix config is fetched from the predefined json config file which is "matrix.json" or any other
+#       file defined using the "json_config" command line option.
+
+require 'sensu-handler'
+require 'matrix_sdk'
+require 'erb'
+
+class Mailer < Sensu::Handler
+    option :json_config,
+           description: 'Name of the JSON Configuration block in Sensu (default: matrix)',
+           short: '-j JsonConfig',
+           long: '--json_config JsonConfigKey',
+           required: false,
+           default: 'matrix'
+
+    def fetch_setting(setting_key)
+        config_key = config[:json_config]  
+        value = @event[setting_key]
+        value ||= settings[config_key][setting_key] if config_key
+    end
+
+    def json_config
+        @json_config ||= config[:json_config]
+    end
+
+    def action_to_string
+        actions = {
+            'create' => 'Created',
+            'resolve' => 'Resolved',
+            'flapping' => 'Flapping'
+        }
+        actions[@event['action']]
+    end
+
+    def action_symbol
+        icons = {
+          'create' => "\xF0\x9F\x98\xB1",
+          'resolve' => "\xF0\x9F\x98\x8D",
+          'flapping' => "\xF0\x9F\x90\x9D"
+        }
+        icons[@event['action']]
+    end
+
+    def check_status
+        @event['check']['status']
+    end
+
+    def occurrences
+        @event['occurrences']
+    end
+    def status_symbol
+        symbol = {
+            0 => '✔',
+            1 => '⚠',
+            2 => '❌',
+            3 => '❓'
+        }
+        symbol[check_status.to_i]
+    end
+
+    def status_to_string
+        status = {
+            0 => 'OK',
+            1 => 'Warning',
+            2 => 'Critical',
+            3 => 'Unknown'
+        }
+        status[check_status.to_i]
+    end
+
+    def short_name
+        client_name + '/' + check_name
+    end
+
+    def client_name
+        @event['client']['name']
+    end
+    
+    def check_name
+        @event['check']['name']
+    end
+
+    def output
+        (@event['check']['output']).to_s.gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
+    end
+
+    def command
+        (@event['check']['command']).to_s.gsub(/(\s-p|\s-P|\s--password)(\s*\S+)/, '\1 <password omitted>')
+    end
+
+    def room_id
+        fetch_setting 'matrix_room_id'
+    end
+    
+    def username
+        fetch_setting 'matrix_user'
+    end
+    
+    def token
+        fetch_setting 'matrix_access_token'
+    end
+
+    def password
+        fetch_setting 'matrix_password'
+    end
+
+    def server
+        fetch_setting 'matrix_server'
+    end
+
+    def timeout
+        fetch_setting 'timeout' || 10
+    end
+
+    def default_message
+        [
+          '<b>Alert <%= action_to_string %></b> <%= action_symbol %>',
+          '<b>Host:</b> <%= client_name %>',
+          '<b>Check:</b> <%= check_name %>',
+          '<b>Status:</b> <%= status_to_string %> <%= status_symbol %>',
+          '<b>Occurrences:</b> <%= occurrences %>',
+          '<b>Output:<b> <pre><%= output %></pre>'
+        ].join("<br>")
+    end
+
+    def build_message
+        template_file = fetch_setting 'message_template_file'
+        if !template_file.nil?
+            template = File.read(template_file)
+        else
+            template = fetch_setting 'message_template'
+            template ||= default_message
+        end
+        message = ERB.new(template).result(binding)
+
+        message
+    end
+
+    def handle
+
+        ENV['SSL_CERT_FILE'] = '/etc/pki/tls/certs/ca-bundle.crt'
+
+        if settings[json_config].nil?
+            p "invalid config: #{options[:json_config]} you need to pass a key and not a file"
+            exit 3 # unknown
+        end
+
+        begin
+            Timeout.timeout timeout do
+                client = MatrixSdk::Client.new "https://#{server}"
+                if !token.nil?
+                    client.api.access_token = token
+                    client.sync
+                else
+                    client.login username, password
+                end
+                room = client.find_room room_id
+                room.send_html build_message
+                # Logout if we logged in before with username and password
+                if token.nil?
+                    client.logout
+                end
+            end  
+            puts 'matrix -- sent alert for #{short_name} to room with id #{room_id}'
+        rescue Timeout::Error
+            puts 'matrix -- timed out while attempting to ' + @event['action'] + ' an incident -- #{short_name}'
+        rescue StandardError => e
+            puts "Matrix handler error '#{e.inspect}' while attempting to report an incident: #{short_name} #{action_to_string}"    
+        end
+    end
+end

data/lib/sensu-plugins-matrix.rb

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

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

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

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-matrix
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Seji64
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: matrix_sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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.73.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Sensu plugins for interfacing with Matrix Chat
+email: <sensu-users@googlegroups.com>
+executables:
+- handler-matrix.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/handler-matrix.rb
+- lib/sensu-plugins-matrix.rb
+- lib/sensu-plugins-matrix/version.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/Seji64/sensu-plugins-matrix
+licenses:
+- MIT
+metadata:
+  maintainer: Seji64
+  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: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Sensu handler for Matrix Chat
+test_files: []