dtaniwaki/fluent-plugin-fork

# fluent-plugin-fork

[![Gem Version](https://badge.fury.io/rb/fluent-plugin-fork.png)](https://rubygems.org/gems/fluent-plugin-fork) [![Build Status](https://secure.travis-ci.org/dtaniwaki/fluent-plugin-fork.png)](http://travis-ci.org/dtaniwaki/fluent-plugin-fork) [![Coverage Status](https://coveralls.io/repos/dtaniwaki/fluent-plugin-fork/badge.png)](https://coveralls.io/r/dtaniwaki/fluent-plugin-fork) [![Code Climate](https://codeclimate.com/github/dtaniwaki/fluent-plugin-fork.png)](https://codeclimate.com/github/dtaniwaki/fluent-plugin-fork)

Fork output by separating values for [fluentd](http://fluentd.org/).

### Example

You can fork the following data

```
{"id": "1", "key": "2", "segments": "1,2,3"}
```

to

```
{"id": "1", "key": "2", "segments": "1"}
{"id": "1", "key": "2", "segments": "2"}
{"id": "1", "key": "2", "segments": "3"}
```

## Requirements

| fluent-plugin-fork | Fluentd          | Ruby   |
|--------------------|------------------|--------|
| >= 0.2.0           | >= v0.14, < v2.0 | >= 2.1 |
| < 0.2.0            | <= v0.14         | >= 1.9 |

## Installation

### td-agent(Linux)

```
/usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-fork
```

### td-agent(Mac)

```
sudo /usr/local/Cellar/td-agent/1.1.XX/bin/fluent-gem install fluent-plugin-fork
```

### fluentd only

```
gem install fluent-plugin-fork
```

## Configuration

```
output_tag   tag_to_output
output_key   key_to_output
separator    ,
fork_key     key_to_fork
max_size     15
max_fallback log
no_unique    true
index_key    idx
```

### output_tag

Tag to output forked values

### output_key

Key name to output forked values

### fork_key

Key name to fork

### separator (Optional)

Separator to separate the values

Default: `,`

### max_size (Optional)

Max size of forked values.

Default: `nil`

### max_fallback (Optional)

Strategy when the size of values exceeds `max_size`. Only effective when you set `max_size`.

`log` to log the record

`drop` to drop exceeded values

`skip` to skip the values

Default: `log`

### no_unique (Optional)

Flag to emit redundant values.

Default: `false`

### index_key (Optional)

Field name to add index number of each values.

Default: `nil`

## Contributing

1. Fork it
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 new [Pull Request](../../pull/new/master)

## Copyright

Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.