fluent-plugin-typetalk

Overview

Fluentd plugin to emit notifications to Typetalk.

Installation

Install with gem or fluent-gem command as:

# for fluentd
$ gem install fluent-plugin-typetalk

# for td-agent
$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-typetalk

Configuration

Usage

This plugin uses client credentials for authentication. See the developer document how to get your own credential.

<match ...>
  type typetalk
  client_id YOUR_CLIENT_ID
  client_secret YOUR_CLIENT_SECRET
  topic_id YOUR_TOPIC_ID
  message notice: s [s] %s errors found
  out_keys tag,time,count
  time_key time
  time_format Y/m/d H:%M:%S
  tag_key tag
</match>

The notified message will look like this : notice: count.service [2014/05/13 03:34:02] 200 errors found. The meanings of out_keys,time_key,time_format and tag_key are equivalent to those of fluent-plugin-ikachan.

This plugin allows you to use special value namely $hostname in out_keys. By using it, you can include hostname within the notified message.

<match ...>
  type typetalk
  client_id YOUR_CLIENT_ID
  client_secret YOUR_CLIENT_SECRET
  topic_id YOUR_TOPIC_ID
  message notice: s [s] %s errors found on %s
  out_keys tag,time,count,$hostname
  time_key time
  time_format Y/m/d H:%M:%S
  tag_key tag
</match>

TODO

Pull requests are very welcome!!

For developers

You have to run the command below when starting development.

$ bundle install --path vendor/bundle

To run tests, do the following.

$ VERBOSE=1 bundle exec rake test

When releasing, call rake release as follows.

$ bundle exec rake release

Copyright

Apache License, Version 2.0