winebarrel / fluent-plugin-kinesis

Fluent::Plugin::Kinesis

Overview

Output plugin for Amazon Kinesis.

Configuration

    type kinesis

    stream_name YOUR_STREAM_NAME

    aws_key_id YOUR_AWS_ACCESS_KEY
    aws_sec_key YOUR_SECRET_KEY
    region us-east-1

    partition_key PARTITION_KEY

    # partition_key is JSON Object Hash Key for PartitionKey
    # e.g.)
    #   JSON Object: {'foo': 100, 'bar': 200}
    #   fluentd conf: partition_key=foo
    #   -> PutRecord Action: PartitionKey=100

    #partition_key_proc proc {|record| record['foo'] }

    #explicit_hash_key ...
    #explicit_hash_key_proc ...

    #debug false
    #include_tag true
    #include_time true

    #sequence_number_for_ordering SEQUENCE_NUMBER

[stream_name] Name of the stream to put data.

[aws_key_id] AWS access key id. This parameter is required when your agent is not running on EC2 instance with an IAM Instance Profile.

[aws_sec_key] AWS secret key. This parameter is required when your agent is not running on EC2 instance with an IAM Instance Profile.

[region] AWS region of your stream. It should be in form like these "us-east-1", "us-west-1".

[partition_key] The key to designate for partition key in Amazon Kinesis.

Install

Install via gem/fluent-gem. Currently this code is not published in rugygems.org not yet, so you have to build by yourself. Please be patient.

git clone https://github.com/imaifactory/fluent-plugin-kinesis.git
cd fluent-plugin-kinesis
rake build
(gem|fluent-gem) install pkg/fluent-plugin-kinesis-0.0.1.gem

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