fluent-plugin-kinesis 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35e38cb880a0cdcd20e9b18028f0b3d1d543afc4
+  data.tar.gz: ee69de13c5e5e210010e74f54c9622be5468b5f9
+SHA512:
+  metadata.gz: ae6b44445f454f9eff1310b9df28e2c28a004dc074465c22346de1bb2ae1a071ee22ffbc21cc24e6919a75e6d62ba0d56aecebd61913fbcba28e609d4f471d85
+  data.tar.gz: d42a53dcc0b3861983f6336c443ebb26218d865b8b6c84e62fd249fa357fb4a12c5f5b212f57935b033746e65f869e2fde39cb856b8c09938d3490c4d58d981e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+config/

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - rbx-2
+
+os:
+  - linux
+  - osx
+
+gemfile:
+  - Gemfile
+
+script: bundle exec rake
+
+sudo: false
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2
+    - rvm: 2.2

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+## 0.3.1
+
+- **Fluentd v0.12 support**: We now support Fluentd v0.12.
+
+## 0.3.0
+
+- **Throughput improvement**: Added support for [PutRecords API](http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html) by default.
+- **Bug fix**: Removed redundant Base64 encoding of data for each Kinesis record emitted. Applications consuming these records will need to be updated accordingly.
+
+## 0.2.0
+
+- **Partition key randomization**: Added support for partition key randomization.
+- **Throughput improvements**: Added support for spawning additional processes and threads to increase throughput to Amazon Kinesis.
+- **AWS SDK for Ruby V2**: Added support for [AWS SDK for Ruby V2](https://github.com/aws/aws-sdk-core-ruby).
+
+## 0.1.0
+
+- Release on Github

data/CONTRIBUTORS.txt

@@ -0,0 +1,6 @@
+This file contains a list of people who have made large or regular contributions
+to the Fluent Plugin for Amazon Kinesis. Give them a special thanks!
+
+Genki Sugawara
+sgwr_dts@yahoo.co.jp
+https://github.com/winebarrel

data/Gemfile

@@ -0,0 +1,15 @@
+# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.txt

@@ -0,0 +1,2 @@
+Fluent Plugin for Amazon Kinesis
+Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. 

data/README.md

@@ -0,0 +1,307 @@
+# Fluent Plugin for Amazon Kinesis
+
+ [![Build Status](https://travis-ci.org/awslabs/aws-fluent-plugin-kinesis.svg?branch=master)](https://travis-ci.org/awslabs/aws-fluent-plugin-kinesis)
+
+## Overview
+
+[Fluentd](http://fluentd.org/) output plugin
+that sends events to [Amazon Kinesis](https://aws.amazon.com/kinesis/).
+
+## Installation
+
+This project has not been published in rubygems.org at this time,
+so you have to build and install by yourself.
+Your need [bundler](http://bundler.io/) to install.
+
+In case of using with Fluentd:
+Fluentd will be also installed via the process below.
+
+    git clone https://github.com/awslabs/aws-fluent-plugin-kinesis.git
+    cd aws-fluent-plugin-kinesis
+    bundle install
+    rake build
+    rake install
+
+Also, you can use this plugin with [td-agent](https://github.com/treasure-data/td-agent):
+You have to install td-agent before installing this plugin.
+
+    git clone https://github.com/awslabs/aws-fluent-plugin-kinesis.git
+    cd aws-fluent-plugin-kinesis
+    bundle install
+    rake build
+    fluent-gem install pkg/fluent-plugin-kinesis
+
+Or just download specify your Ruby library path.
+Below is the sample for specifying your library path via RUBYLIB.
+
+    git clone https://github.com/awslabs/aws-fluent-plugin-kinesis.git
+    cd aws-fluent-plugin-kinesis
+    bundle install
+    export RUBYLIB=$RUBYLIB:/path/to/aws-fluent-plugin-kinesis/lib
+
+## Dependencies
+
+ * Ruby 1.9.3+
+ * Fluentd 0.10.43+
+
+## Basic Usage
+
+Here are general procedures for using this plugin:
+
+ 1. Install.
+ 1. Edit configuration
+ 1. Run Fluentd or td-agent
+
+You can run this plugin with Fluentd as follows:
+
+ 1. Install.
+ 1. Edit configuration file and save it as 'fluentd.conf'.
+ 1. Then, run `fluentd -c /path/to/fluentd.conf`
+
+To run with td-agent, it would be as follows:
+
+ 1. Install.
+ 1. Edit configuration file provided by td-agent.
+ 1. Then, run or restart td-agent.
+
+## Configuration
+
+Here are items for Fluentd configuration file.
+
+To put records into Amazon Kinesis,
+you need to provide AWS security credentials.
+If you provide aws_key_id and aws_sec_key in configuration file as below,
+we use it. You can also provide credentials via environment variables as
+AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.  Also we support IAM Role for
+authentication. Please find the [AWS SDK for Ruby Developer Guide](http://docs.aws.amazon.com/AWSSdkDocsRuby/latest/DeveloperGuide/ruby-dg-setup.html)
+for more information about authentication.
+We support all options which AWS SDK for Ruby supports.
+
+### type
+
+Use the word 'kinesis'.
+
+### stream_name
+
+Name of the stream to put data.
+
+### aws_key_id
+
+AWS access key id.
+
+### aws_sec_key
+
+AWS secret key.
+
+### region
+
+AWS region of your stream.
+It should be in form like "us-east-1", "us-west-2".
+Refer to [Regions and Endpoints in AWS General Reference](http://docs.aws.amazon.com/general/latest/gr/rande.html#ak_region)
+for supported regions.
+
+### random_partition_key
+
+Boolean. If true, the plugin uses randomly generated
+partition key for each record. Note that this parameter
+overrides *partition_key*, *partition_key_expr*,
+*explicit_hash_key* and *explicit_hash_key_expr*.
+
+### partition_key
+
+A key to extract partition key from JSON object.
+
+### partition_key_expr
+
+A Ruby expression to extract partition key from JSON object.
+We treat your expression as below.
+
+    a_proc = eval(sprintf('proc {|record| %s }', YOUR_EXPRESSION))
+    a_proc.call(record)
+
+You should write your Ruby expression that receives input data
+as a variable 'record', process it and return it. The returned
+value will be used as a partition key. For use case example,
+see 'Configuration examples' part.
+
+### explicit_hash_key
+
+A key to extract explicit hash key from JSON object.
+Explicit hash key is hash value used to explicitly
+determine the shard the data record is assigned to
+by overriding the partition key hash.
+
+### explicit_hash_key_expr
+
+A Ruby expression to extract explicit hash key from JSON object.
+Your expression will be treat in the same way as we treat partition_key_expr.
+
+### order_events
+
+Boolean. By enabling it, you can strictly order events in Amazon Kinesis,
+according to arrival of events. Without this, events will be coarsely ordered
+based on arrival time. For detail,
+see [Using the Amazon Kinesis Service API](http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-api-java.html#kinesis-using-api-defn-sequence-number).
+
+Please note that if you set *detach_process* or *num_threads greater than 1*,
+this option will be ignored.
+
+### detach_process
+
+Integer. Optional. This defines the number of parallel processes to start.
+This can be used to increase throughput by allowing multiple processes to
+execute the plugin at once. This cannot be used together with **order_events**.
+Setting this option to > 0 will cause the plugin to run in a separate
+process. The default is 0.
+
+### num_threads
+
+Integer. The number of threads to flush the buffer. This plugin is based on
+Fluentd::BufferedOutput, so we buffer incoming records before emitting them to
+Amazon Kinesis. You can find the detail about buffering mechanism [here](http://docs.fluentd.org/articles/buffer-plugin-overview).
+Emitting records to Amazon Kinesis via network causes I/O Wait, so parallelizing
+emitting with threads will improve throughput.
+
+This option can be used to parallelize writes into the output(s)
+designated by the output plugin. The default is 1.
+Also you can use this option with *detach_process*.
+
+### retries_on_putrecords
+
+Integer, default is 3. When **order_events** is false, the plugin will put multiple
+records to Amazon Kinesis in batches using PutRecords. A set of records in a batch
+may fail for reasons documented in the Kinesis Service API Reference for PutRecords.
+Failed records will be retried **retries_on_putrecords** times. If a record
+fails all retries an error log will be emitted. 
+
+### debug
+
+Boolean. Enable if you need to debug Amazon Kinesis API call. Default is false.
+
+## Configuration examples
+
+Here are some configuration examles.
+Assume that the JSON object below is coming to with tag 'your_tag'.
+
+    {
+      "name":"foo",
+      "action":"bar"
+    }
+
+### Simply putting events to Amazon Kinesis with a partition key
+
+In this example, simply a value 'foo' will be used as partition key,
+then events will be sent to the stream specified in 'stream_name'.
+
+    <match your_tag>
+    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 name
+    </match>
+
+### Using partition_key_expr to add specific prefix to partition key
+
+In this example, we add partition_key_expr to the example above.
+This expression adds string 'some_prefix-' to partition key 'name',
+then partition key finally will be 'some_prefix-foo'.
+
+With specifying parition_key and parition_key_expr both,
+the extracted value for partition key from JSON object will be
+passed to your Ruby expression as a variable 'record'.
+
+    <match your_tag>
+    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 name
+    partition_key_expr 'some_prefix-' + record
+    </match>
+
+### Using partition_key_expr to extract a value for partition key
+
+In this example, we use only partition_key_expr to extract
+a value for partition key. It will be 'bar'.
+
+Specifying partition_key_expr without partition_key,
+hash object that is converted from whole JSON object will be
+passed to your Ruby expression as a variable 'record'.
+
+    <match your_tag>
+    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_expr record['action']
+    </match>
+
+### Improving throughput to Amazon Kinesis
+
+The achievable throughput to Amazon Kinesis is limited to single-threaded
+PutRecord calls if **order_events** is set to true. By setting **order_events**
+to false records will be sent to Amazon Kinesis in batches. When operating in
+this mode the plugin can also be configured to execute in parallel.
+The **detach_process** and **num_threads** configuration settings control
+parallelism.
+
+Please note that **order_events** option will be ignored if you choose to
+use either **detach_process** or **num_threads**.
+
+In case of the configuration below, you will spawn 2 processes.
+
+    <match your_tag>
+    type kinesis
+
+    stream_name YOUR_STREAM_NAME
+    region us-east-1
+
+    detach_process 2
+
+    </match>
+
+You can also specify a number of threads to put.
+The number of threads is bound to each individual processes.
+So in this case, you will spawn 1 process which has 50 threads.
+
+    <match your_tag>
+    type kinesis
+
+    stream_name YOUR_STREAM_NAME
+    region us-east-1
+
+    num_threads 50
+    </match>
+
+Both options can be used together, in the configuration below,
+you will spawn 2 processes and 50 threads per each processes.
+
+    <match your_tag>
+    type kinesis
+
+    stream_name YOUR_STREAM_NAME
+    region us-east-1
+
+    detach_process 2
+    num_threads 50
+    </match>
+
+## Related Resources
+
+* [Amazon Kinesis Developer Guide](http://docs.aws.amazon.com/kinesis/latest/dev/introduction.html)