https://github.com/fluent-plugins-nursery/fluent-plugin-zulip

Fluentd output plugin for Zulip powerful open source group chat
https://github.com/fluent-plugins-nursery/fluent-plugin-zulip

fluentd fluentd-plugin zulip

Last synced: about 1 month ago
JSON representation

Fluentd output plugin for Zulip powerful open source group chat

• Host: GitHub
• URL: https://github.com/fluent-plugins-nursery/fluent-plugin-zulip
• Owner: fluent-plugins-nursery
• License: apache-2.0
• Created: 2017-01-25T08:36:08.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-02-15T04:12:42.000Z (almost 4 years ago)
• Last Synced: 2024-08-09T12:12:07.648Z (5 months ago)
• Topics: fluentd, fluentd-plugin, zulip
• Language: Ruby
• Size: 22.5 KB
• Stars: 0
• Watchers: 7
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fluent-plugin-zulip

[Fluentd](http://fluentd.org/) output plugin to post messages to Zulip chat application.

[Zulip](https://zulip.org/) is a powerful open source group chat.

## Requirements

| fluent-plugin-zulip | fluentd    | ruby   |

|---------------------|------------|--------|

| >= 0.1.0            | >= v0.14.0 | >= 2.1 |

| N/A                 | >= v0.12.0 | >= 1.9 |

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

## Installation

### RubyGems

```

$ gem install fluent-plugin-zulip

```

### Bundler

Add following line to your Gemfile:

```

gem "fluent-plugin-zulip"

```

And then execute:

```

$ bundle

```

## Configuration

* See also: Fluent::Plugin::Output

```aconf

  @type dummy

  dummy { "message": "This is a message" }

  tag dummy.log

  @type zulip

  api_endpoint https://zulip.example.com/api/v1/messages

  bot_email_address [email protected]

  bot_api_key xxxxxxxxxxxxxxxxxxxxxxxxxx

```

## Fluent::Plugin::ZulipOutput

* **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

* Copyright(c) 2017- Kenji Okimoto

* License

  * Apache License, Version 2.0