Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sue445/fluent-plugin-chatwork

fluentd output plugin for post to chatwork
https://github.com/sue445/fluent-plugin-chatwork

chatwork-api fluent-plugin gem

Last synced: 27 days ago
JSON representation

fluentd output plugin for post to chatwork

Host: GitHub
URL: https://github.com/sue445/fluent-plugin-chatwork
Owner: sue445
License: mit
Created: 2014-06-25T16:52:01.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-08-02T13:37:35.000Z (5 months ago)
Last Synced: 2024-11-19T07:19:47.634Z (about 1 month ago)
Topics: chatwork-api, fluent-plugin, gem
Language: Ruby
Homepage: https://sue445.github.io/fluent-plugin-chatwork/
Size: 109 KB
Stars: 6
Watchers: 3
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # fluent-plugin-chatwork

fluentd output plugin for post to [ChatWork](http://www.chatwork.com/)

[![Gem Version](https://badge.fury.io/rb/fluent-plugin-chatwork.svg)](http://badge.fury.io/rb/fluent-plugin-chatwork)

[![Build Status](https://github.com/sue445/fluent-plugin-chatwork/workflows/test/badge.svg?branch=master)](https://github.com/sue445/fluent-plugin-chatwork/actions?query=workflow%3Atest)

[![Coverage Status](https://coveralls.io/repos/github/sue445/fluent-plugin-chatwork/badge.svg?branch=master)](https://coveralls.io/github/sue445/fluent-plugin-chatwork?branch=master)

[![Code Climate](https://codeclimate.com/github/sue445/fluent-plugin-chatwork.png)](https://codeclimate.com/github/sue445/fluent-plugin-chatwork)

[![Inline docs](http://inch-ci.org/github/sue445/fluent-plugin-chatwork.svg?branch=master)](http://inch-ci.org/github/sue445/fluent-plugin-chatwork)

## Requirements

| fluent-plugin-chatwork | fluentd | ruby |

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

| >= 2.0.0 | >= v0.14.0 | >= 2.1 |

|  < 2.0.0 | >= v0.12.0 | >= 1.9 |

## Installation

    $ gem install fluent-plugin-chatwork

## Configure

### For non-buffered

```

  @type        chatwork

  api_token    YOUR_SECRET_TOKEN

  room_id      0000000000

  message      Hello ChatWork!\n<%= record["value"] %>

```

### For buffered

```

  @type        chatwork

  api_token    YOUR_SECRET_TOKEN

  room_id      0000000000

  message      Hello ChatWork!\n<%= record["value"] %>

  buffered     true

  

    @type memory

  

```

* api_token

  * secret api token

* room_id

  * send message to this room

* message

  * message content

  * support erb format

  * support newline character (\n)

* buffered

  * Switch non-buffered/buffered output

## Contributing

1. Fork it ( https://github.com/sue445/fluent-plugin-chatwork/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request