fluent-plugin-mattermost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 137190fc7cefe9e27caccfe3ae5367ea51bd8cd8121d5bd24b5b9df9c212a4b9
+  data.tar.gz: 9fdee0c49ee52085529a35f427e1ac22cd285ec441f9146565b2ddc7facb405e
+SHA512:
+  metadata.gz: 462bcc71f9d39527e2e9ee6ad69987feb5fc7e49b8a4b10bee5c7cfca39be373e1b6790e17dfc0b611e88790e2a467f5724ac7cb3a4e891f2d2c715e6e780788
+  data.tar.gz: cdcff519b3dbcdfe50db16e2e46b5b8b372663eb0c540a386e883e85dbf00bc08e852b8a8be1a2a51c9a3ed7f2ae1f5c49b4616d02b5d6c206ef0bf9d12ad1d1

data/.gitignore

@@ -0,0 +1 @@
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# fluent-plugin-mattermost
+
+[Fluentd](https://fluentd.org/) output plugin to send message to Mattermost.
+
+With this plugin you can send messages directly to a channel in Mattermost (for example in case of errors).
+
+# Installation requirement
+
+For the plugin to work properly, you need to have the following gems installed
+- fluent-logger
+```
+$ gem install fluent-logger
+```
+
+# Installation
+
+[Installation](documentation/installation.md)  
+[Docker-installation](documentation/docker-installation.md)
+
+# Usage (Incoming Webhook)
+Link for
+[Mattermost incoming webhook](https://docs.mattermost.com/developer/webhooks-incoming.html)
+
+```apache
+<match mattermost>
+    @type mattermost
+    webhook_url https://xxx.xx/hooks/xxxxxxxxxxxxxxx
+    channel_id xxxxxxxxxxxxxxx
+    message_color "#FFA500"
+    message_title mattermost
+    message %s
+    enable_tls true
+</match>
+```
+
+### Parameter
+
+|parameter|description|type|dafault|
+|---|---|---|---|
+|webhook_url|Incoming Webhook URI (Required for Incoming Webhook mode). See https://docs.mattermost.com/developer/webhooks-incoming.html|string|nil|
+|channel_id|the id of the channel where you want to receive the information|string|nil|
+|message_color|color of the message you are sending, the format is hex code|string|#A9A9A9|
+|message_title|title you want to add to the message|string|fluent_title_default
+|message|The message you want to send, can be a static message, which you add at this point, or you can receive the fluent infos with the %s|string|nil
+|enable_tls|you can set the communication channel if it uses tls|bool|true|
+
+## Copyright
+
+* Copyright(c) 2021- [levigo gruppe](https://www.levigo.de/)
+* License

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/documentation/docker-installation.md

@@ -0,0 +1,14 @@
+# Docker installation
+
+### Dockerfile
+
+You need to enter the repository where you can download and later install the plugin. Here is a snippet code  
+**Attention:** If you use gitlab, don't forget to enter the token for oauth2
+
+```docker
+...
+
+RUN gem install fluent-plugin-mattermost
+
+...
+```

data/documentation/installation.md

@@ -0,0 +1,18 @@
+# Installation
+
+To install the plugin you need to download the package directly from Gitlab and run the installation.  
+Link to repository:
+
+[fluent-plugin-mattermost](https://gitlab.levigo.systems/codefactory/fluent-plugin-mattermost)
+
+```
+$ gem install bundler
+```
+```
+$ rake build
+```
+```
+$ gem install --local ./pkg/fluent-plugin-mattermost-0.1.0.gem
+```
+
+The installation is completed

data/fluent-plugin-mattermost.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-mattermost"
+  spec.version = "0.1.0"
+  spec.authors = ["Pierluigi Minardi"]
+  spec.email   = ["p.minardi@levigo.de"]
+
+  spec.summary       = "fluent-plugin-mattemost"
+  spec.description   = "This plugin allows you to send messages to mattermost in case of errors"
+  spec.homepage      = "https://www.levigo.de"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2.31"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "test-unit", "~> 3.3.9"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/out_mattermost.rb

@@ -0,0 +1,109 @@
+require "fluent/plugin/output"
+require 'fluent-logger'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'logger'
+require "json"
+
+module Fluent
+  module Plugin
+    class MattermostOutput < Fluent::Plugin::Output
+      Fluent::Plugin.register_output("mattermost", self)
+
+      # Required parameter: The configuration must have this parameter like 'param1 10'.
+      config_param :webhook_url, :string, default: nil
+
+      config_param :channel_id, :string, default: nil
+
+      config_param :message_title, :string, default: "fluent_title_default"
+
+      config_param :message_color, :string, default: "#A9A9A9"
+
+      config_param :message, :string, default: nil
+
+      config_param :enable_tls,  :bool, default: true
+
+      def configure(conf)
+        super
+      end
+
+      def start
+        super
+        check_config_params
+      end
+
+      def write(chunk)
+        begin
+          message = get_infos(chunk)
+
+          post(message)
+        rescue Timeout::Error => e
+          log.warn "out_mattermost:", :error => e.to_s, :error_class => e.class.to_s
+          raise e # let Fluentd retry
+        rescue => e
+          log.error "out_mattermost:", :error => e.to_s, :error_class => e.class.to_s
+          log.warn_backtrace e.backtrace
+        end
+      end
+
+      def post(payload)
+
+        url = URI(@webhook_url)
+
+        https = Net::HTTP.new(url.host, url.port)
+        https.use_ssl = @enable_tls
+
+        request = Net::HTTP::Post.new(url)
+        request["Content-Type"] = "application/json"
+        request.body = JSON.dump({
+          "channel_id": @channel_id,
+          "attachments": message(payload)
+        })
+        response = https.request(request)
+
+        if response.read_body != "ok"
+          log.error "response from mattermost: ", response.read_body
+        else 
+          puts response.read_body
+        end
+      end
+
+      def message(record)
+        payload = [{
+                    "author_name": "Fluentd",
+                    "thumb_url": "https://coralogix.com/wp-content/uploads/2020/04/fluentd-guide-700x430.png",
+                    "color": @message_color,
+                    "fields": [
+                    {
+                      "short": false,
+                      "title": @message_title,
+                      "value": record
+                    }]
+                  }]
+        return payload
+      end
+
+      def get_infos(chunk) 
+        messages = []
+        messages << "\n"
+        chunk.msgpack_each do |time, record|
+          messages << "#{build_message(record)}\n"
+        end
+
+        return messages
+      end
+
+      def build_message(record)
+        @message % record.to_json
+      end
+
+      def check_config_params()
+        if @webhook_url.nil? || @channel_id.nil? || @message.nil?
+          raise "Check in your Mattermost config, that all parameters in the configuration file are filled"
+          abort
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_out_mattermost.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "fluent/plugin/out_mattermost.rb"
+
+class MattermostOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "failure" do
+    flunk
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::MattermostOutput).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-mattermost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierluigi Minardi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.31
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.31
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.9
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This plugin allows you to send messages to mattermost in case of errors
+email:
+- p.minardi@levigo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- documentation/docker-installation.md
+- documentation/installation.md
+- fluent-plugin-mattermost.gemspec
+- lib/fluent/plugin/out_mattermost.rb
+- test/helper.rb
+- test/plugin/test_out_mattermost.rb
+homepage: https://www.levigo.de
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: fluent-plugin-mattemost
+test_files:
+- test/helper.rb
+- test/plugin/test_out_mattermost.rb