fluent-plugin-zulip

Fluentd output plugin to post messages to Zulip chat application.

Zulip is a powerful open source group chat.

NOTE: fluent-plugin-zulip doesn't support Fluentd v0.12.x

$ gem install fluent-plugin-zulip

Add following line to your Gemfile:

gem "fluent-plugin-zulip"

And then execute:

$ bundle

• See also: Fluent::Plugin::Output

<source>
  @type dummy
  dummy { "message": "This is a message" }
  tag dummy.log
</source>

<match **>
  @type zulip
  api_endpoint https://zulip.example.com/api/v1/messages
  bot_email_address test-bot@example.com
  bot_api_key xxxxxxxxxxxxxxxxxxxxxxxxxx
</match>

• site (string) (required): Site URI
• bot_email_address (string) (required): Bot email address
• bot_api_key (string) (required): Bot API key
• message_type (enum) (optional): Send message type
  • Available values: private, stream
  • Default value: stream.
• stream_name (string) (optional): Target stream name
  • Default value: social.
• recipients (array) (optional): User names (email address) of the recipients for private message
  • Default value: [].
• subject (string) (optional): Topic subject
• subject_key (string) (optional): Topic subject from record
• content_key (string) (optional): Content from record
  • Default value: message.

• Copyright(c) 2017- Kenji Okimoto
• License
  • Apache License, Version 2.0