Initial commit

The server seems to work, and can pass along simple notifications

All major features are unimplemented as of yet

Author: ananace

.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock
+config.yml

.gitlab-ci.yml

@@ -0,0 +1,19 @@
+---
+image: "ruby:2.4"
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+before_script:
+  - gem install bundler  --no-ri --no-rdoc
+  - bundle install -j $(nproc) --path vendor
+
+rubocop:
+  script:
+    - bundle exec rubocop
+
+# rspec:
+#   script:
+#   - rspec spec

.rubocop.yml

@@ -0,0 +1,59 @@
+---
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - '*.spec'
+    - 'Rakefile'
+    - 'vendor/**/*'
+
+# Don't enforce documentation
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/LineLength:
+  Max: 190
+
+Metrics/AbcSize:
+  Enabled: false
+
+Performance/FixedSize:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'
+    - 'app/controllers/concerns/foreman/**/*'

Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in grafana_matrix.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Olofsson
+
+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.

README.md

@@ -0,0 +1,19 @@
+# Grafana Matrix
+
+A Grafana webhook ingress for sending Matrix notifications
+
+## Installation
+
+TODO
+
+## Usage
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/grafana_matrix
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

bin/server

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'grafana_matrix'
+require 'json'
+require 'matrix_sdk'
+require 'sinatra'
+
+config = GrafanaMatrix::Config.new 'config.yml'
+renderer = GrafanaMatrix::Renderer.new
+
+puts 'Loaded configuration;'
+puts config.inspect
+
+post '/hook' do
+  rule = params[:rule]
+  halt 400, 'Missing rule name' unless rule
+
+  rule = config.rule(rule)
+  halt 404, 'No such rule configured' unless rule
+
+  data = JSON.parse(request.body.read)
+  halt 400, 'No notification body provided' unless data
+
+  puts 'Data:'
+  puts data
+
+  client = rule.client
+  halt 500, 'Unable to acquire Matrix client from rule' unless client
+
+  room = rule.room if rule.room.start_with? '!'
+  room ||= client.join_room(rule.room)
+  halt 500, 'Unable to acquire Matrix room from rule and client' unless room
+
+  plain = renderer.render_plain(data, rule)
+  html = renderer.render_html(data, rule)
+
+  puts 'Plain:'
+  puts plain
+
+  puts 'HTML:'
+  puts html
+
+  client.send_message_event(room, 'm.room.message',
+                            msgtype: 'm.notice',
+                            body: plain,
+                            formatted_body: html,
+                            format: 'org.matrix.custom.html')
+
+  ''
+end

config.yml.example

@@ -0,0 +1,14 @@
+---
+# Set up HS connections
+matrix:
+- name: matrix-org
+  url: https://matrix.org
+  access_token: <token>
+  device_id: <device>
+
+# Set up notification ingress rules
+rules:
+- name: hq             # Name of the rule
+  room: #hq:matrix.org # Room or ID
+  matrix: matrix-org   # The Matrix HS to use - defaults to first one
+  image: true          # Upload image?

grafana_matrix.gemspec

@@ -0,0 +1,27 @@
+require File.join File.expand_path('lib', __dir__), 'grafana_matrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grafana_matrix'
+  spec.version       = GrafanaMatrix::VERSION
+  spec.authors       = ['Alexander Olofsson']
+  spec.email         = ['[email protected]']
+
+  spec.summary       = 'A Matrix notification target for Grafana'
+  spec.description   = 'Converts Grafana alerts into Matrix notifications ' \
+                       'using Grafana alert webhooks'
+  spec.homepage      = 'https://github.com/ananace/ruby-grafana-matrix'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'matrix_sdk'
+  spec.add_dependency 'sinatra'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+end

lib/grafana_matrix.rb

@@ -0,0 +1,7 @@
+require 'grafana_matrix/config'
+require 'grafana_matrix/renderer'
+require 'grafana_matrix/version'
+
+module GrafanaMatrix
+
+end

lib/grafana_matrix/config.rb

@@ -0,0 +1,79 @@
+require 'matrix_sdk'
+require 'psych'
+
+module GrafanaMatrix
+  class Config
+    Rule = Struct.new(:config, :data) do
+      def name
+        data.fetch(:name)
+      end
+
+      def room
+        data.fetch(:room)
+      end
+
+      def matrix
+        data.fetch(:matrix)
+      end
+
+      def image?
+        data.fetch(:image, true)
+      end
+
+      def embed_image?
+        data.fetch(:embed_image, true)
+      end
+
+      def client
+        @client ||= config.client(matrix)
+      end
+    end
+
+    def initialize(config = {})
+      if config.is_a? String
+        file = config
+        config = {}
+      end
+      @config = config
+      @clients = {}
+
+      load!(file) if file
+    end
+
+    def load!(filename = 'config.yml')
+      raise 'No such file' unless File.exist? filename
+      @config = Psych.load(File.read(filename))
+      true
+    end
+
+    def client(client_name = nil)
+      client_name ||= @config['matrix'].first['name']
+      raise 'No client name provided' unless client_name
+
+      client_data = @config['matrix'].find { |m| m['name'] == client_name }.dup
+      raise 'No client configuration found for name given' unless client_data
+
+      # Symbolize keys
+      client_data.keys.each do |key|
+        client_data[(key.to_sym rescue key)] = client_data.delete key
+      end
+
+      @clients[client_name] ||= begin
+        MatrixSdk::Api.new(client_data[:url],
+                           client_data.reject { |k, _v| %i[url].include? k })
+      end
+    end
+
+    def rule(rule_name)
+      rule_data = @config['rules'].find { |m| m['name'] == rule_name }.dup
+      raise 'No rule configuration found for name given' if rule_data.nil?
+
+      # Symbolize keys
+      rule_data.keys.each do |key|
+        rule_data[(key.to_sym rescue key)] = rule_data.delete key
+      end
+
+      Rule.new self, rule_data
+    end
+  end
+end

lib/grafana_matrix/renderer.rb

@@ -0,0 +1,19 @@
+module GrafanaMatrix
+  class Renderer
+    HTML_TEMPLATE = File.expand_path('templates/html.erb', __dir__).freeze
+    PLAIN_TEMPLATE = File.expand_path('templates/plain.erb', __dir__).freeze
+
+    def render(data, rule, template)
+      erb = ERB.new template, 0, '-'
+      erb.result(binding)
+    end
+
+    def render_html(data, rule, template = HTML_TEMPLATE)
+      render data, rule, File.read(template)
+    end
+
+    def render_plain(data, rule, template = PLAIN_TEMPLATE)
+      render data, rule, File.read(template)
+    end
+  end
+end

lib/grafana_matrix/templates/html.erb

@@ -0,0 +1,30 @@
+<%-
+SeverityColours = {
+  :ok => '#10a345',
+  :paused => '#8e8e8e',
+  :alerting => '#ed2e18',
+  :pending => '#8e8e8e',
+  :no_data => '#f79520',
+}.freeze
+-%>
+<h4><a href="<%= data['ruleUrl'] %>" style="font-weight: bold; font-style: italic; color: <%= SeverityColours[data['state'].to_sym] %>"><%= data['title'] %></a></h4>
+<p><%= data['message'] %></p>
+<%- if data['error'] -%>
+<h5>Error:</h5>
+<p><%= data['error'] %></p>
+<%- end -%>
+<%- if data['state'] != 'ok' -%>
+<%-   unless data['evalMatches'].empty? -%>
+<%-     data['evalMatches'].each do |match| -%>
+<b><%= match['metric'] %></b>: <%= match['value'] %><br/>
+<%-     end -%>
+<%-   end -%>
+<%-   if data['imageUrl'] && rule.image? -%>
+<br/>
+<%-     if rule.embed_image? -%>
+<a href="<%= data['ruleUrl'] %>"><img src="<%= data['imageUrl'] %>" alt="<%= data['ruleName'] %>" /></a>
+<%-     else -%>
+<a href="<%= data['imageUrl'] %>">Image</a>
+<%-     end -%>
+<%-   end -%>
+<%- end -%>