Build Status

Send your logs to Honeycomb.

Getting started

  1. Install this plugin with gem install fluent-plugin-honeycomb

  2. Edit your fluentd.conf configuration file. A minimal configuration looks like this:

<match your_match>
  @type honeycomb
  writekey "YOUR_WRITEKEY"
  dataset "fluentd_test_dataset"
</match>

Configuration

Basic options

Parameter Type Required? Description
writekey string yes Your Honeycomb write key.
dataset string yes The name of the destination dataset in your Honeycomb account.
sample_rate integer no Sample your event stream by sending 1 out of every N events.
include_tag_key bool no Whether to include the Fluentd tag in the submitted event.
tag_key string no If include_tag_key is true, the tag key name in the event (default: fluentd_tag).
flatten_keys array no Flatten nested JSON data under these keys into

the top-level event.

Buffering options

fluent-plugin-honeycomb supports the standard configuration options for buffered output plugins.

Development

I recommend using rbenv for development.

To set up Fluentd, run:

gem install fluentd
fluentd --setup ./fluent

Edit the configuration file at ./fluent/fluent.conf, then run

fluentd -c ./fluent/fluent.conf -v

A note about naming: This gem must be named fluent-plugin-xxx in order to automatically be included in Fluentd's plugin list. See http://www.fluentd.org/faqs.

Releasing a new version

Travis will automatically upload tagged releases to Rubygems. To release a new version, run

bump patch --tag   # Or bump minor --tag, etc.
git push --tags