Skip to content

levigo-systems/fluent-plugin-mattermost

Repository files navigation

fluent-plugin-mattermost

Fluentd 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 gem installed

  • fluent-logger
$ gem install fluent-logger

Installation

Installation
Docker-installation

Usage (Incoming Webhook)

Link for Mattermost incoming webhook

<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
    ca_path /etc/ssl/certs/
</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
ca_path you can set the path of the certificates string nil

Copyright