fluent-plugin-kinesis 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 379ee5190624fd7e6003399ecd933305fd141511
-  data.tar.gz: b95a2edb9a9a2c3b3f23bbe3e16c2fbe720903c0
+  metadata.gz: 48189e937b18e7a7ab26165826394ffb37db0f3d
+  data.tar.gz: 2cc691c0c3f6f57b7472f61edc689b99d8955677
 SHA512:
-  metadata.gz: c2e11cc08081b1b73f457a79cd24271127c59244143e76f6586acaedffeb8cf93f11a8af5f284713fdc781f07062a3237450e16ab21176ba59fe5af414c84168
-  data.tar.gz: cdcb6cac9ddb66b045f830de7cb20f15f26cb921ffd99ea38bef59c7fe4e9a688182f8445bd0c7cac492be4f18df6ecc4edceba3b02f4091784f3ae175d97d9e
+  metadata.gz: 0a8d48c3ed01e845ab675b4242f5441af5a8a361f8d557d9bab58be7e8d378900c20f50c9dcb93b1e79863254d3c2e15907e9ed9d06ece30de47a92bda7455f6
+  data.tar.gz: 3f5556e659c9889efd3f5d47c0482ed31f0bc185e91ae3acf9831d8edd38616e553b16d577f5063abee06a5b143932c5487fcfe28d3a8c389a88ff9ba20029b7

data/.gitignore

@@ -1,18 +1,13 @@
-*.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/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/Gemfile*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.cache/
+/amazon-kinesis-producer-native-binarie*
+/.ruby-version

data/.travis.yml

@@ -1,26 +1,26 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
-  - ruby-head
-  - rbx-2
+
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.fluentd-0.10.58
 
 os:
   - linux
   - osx
 
-gemfile:
-  - Gemfile
+before_install:
+  - gem update bundler
 
-script: bundle exec rake
+script: bundle exec rake test
 
 sudo: false
 
 matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx-2
+  exclude:
     - rvm: 2.2
+      os: osx

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # CHANGELOG
 
+## 1.0.0
+
+To support Firehose and KPL, this was refactored and added more tests.
+
+- Feature - Support Firehose
+- Feature - Support KPL
+- Feature - New parameters, such as formatter, data_key, reset_backoff_if_success, batch_request_max_count, batch_request_max_size, log_truncate_max_size
+
 ## 0.4.0
+
 - Feature - Add option to ensure Kinesis Stream connection. [#35](https://github.com/awslabs/aws-fluent-plugin-kinesis/pull/35)
 - Feature - Add option to support zlib compression. [#39](https://github.com/awslabs/aws-fluent-plugin-kinesis/pull/39)
 

data/CONTRIBUTORS.txt

@@ -1,5 +1,5 @@
 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!
+to the Fluent Plugin for Amazon Kinesis Streams and Amazon Kinesis Firehose. Give them a special thanks!
 
 Genki Sugawara
 sgwr_dts@yahoo.co.jp

data/Gemfile

@@ -1,15 +1,18 @@
-# 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
+#  Copyright 2014-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
-#     http://www.apache.org/licenses/LICENSE-2.0
+#  Licensed under the Amazon Software License (the "License").
+#  You may not use this file except in compliance with the License.
+#  A copy of the License is located at
 #
-# 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.
+#  http://aws.amazon.com/asl/
+#
+#  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'
+
+# Specify your gem's dependencies in fluent-plugin-kinesis.gemspec
 gemspec

data/LICENSE.txt

@@ -1,202 +1,40 @@
 
-                                 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.
+Amazon Software License
+
+This Amazon Software License (“License”) governs your use, reproduction, and distribution of the accompanying software as specified below.
+1. Definitions
+
+“Licensor” means any person or entity that distributes its Work.
+
+“Software” means the original work of authorship made available under this License.
+
+“Work” means the Software and any additions to or derivative works of the Software that are made available under this License.
+
+The terms “reproduce,” “reproduction,” “derivative works,” and “distribution” have the meaning as provided under U.S. copyright law; provided, however, that 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.
+
+Works, including the Software, are “made available” under this License by including in or with the Work either (a) a copyright notice referencing the applicability of this License to the Work, or (b) a copy of this License.
+2. License Grants
+
+2.1 Copyright Grant. Subject to the terms and conditions of this License, each Licensor grants to you a perpetual, worldwide, non-exclusive, royalty-free, copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense and distribute its Work and any resulting derivative works in any form.
+
+2.2 Patent Grant. Subject to the terms and conditions of this License, each Licensor grants to you a perpetual, worldwide, non-exclusive, royalty-free patent license to make, have made, use, sell, offer for sale, import, and otherwise transfer its Work, in whole or in part. The foregoing license applies only to the patent claims licensable by Licensor that would be infringed by Licensor’s Work (or portion thereof) individually and excluding any combinations with any other materials or technology.
+3. Limitations
+
+3.1 Redistribution. You may reproduce or distribute the Work only if (a) you do so under this License, (b) you include a complete copy of this License with your distribution, and (c) you retain without modification any copyright, patent, trademark, or attribution notices that are present in the Work.
+
+3.2 Derivative Works. You may specify that additional or different terms apply to the use, reproduction, and distribution of your derivative works of the Work (“Your Terms”) only if (a) Your Terms provide that the use limitation in Section 3.3 applies to your derivative works, and (b) you identify the specific derivative works that are subject to Your Terms. Notwithstanding Your Terms, this License (including the redistribution requirements in Section 3.1) will continue to apply to the Work itself.
+
+3.3 Use Limitation. The Work and any derivative works thereof only may be used or intended for use with the web services, computing platforms or applications provided by Amazon.com, Inc. or its affiliates, including Amazon Web Services, Inc.
+
+3.4 Patent Claims. If you bring or threaten to bring a patent claim against any Licensor (including any claim, cross-claim or counterclaim in a lawsuit) to enforce any patents that you allege are infringed by any Work, then your rights under this License from such Licensor (including the grants in Sections 2.1 and 2.2) will terminate immediately.
+
+3.5 Trademarks. This License does not grant any rights to use any Licensor’s or its affiliates’ names, logos, or trademarks, except as necessary to reproduce the notices described in this License.
+
+3.6 Termination. If you violate any term of this License, then your rights under this License (including the grants in Sections 2.1 and 2.2) will terminate immediately.
+4. Disclaimer of Warranty.
+
+THE WORK IS PROVIDED “AS IS” WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF M ERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER THIS LICENSE. SOME STATES’ CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
+5. Limitation of Liability.
+
+EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER COMM ERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+

data/Makefile

@@ -0,0 +1,40 @@
+#
+#  Copyright 2014-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Amazon Software License (the "License").
+#  You may not use this file except in compliance with the License.
+#  A copy of the License is located at
+#
+#  http://aws.amazon.com/asl/
+#
+#  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.
+
+.PHONY: install streams firehose producer dummer hello $(wildcard test/test_*.rb) $(wildcard test/**/test_*.rb)
+
+all:
+	bundle install
+	bundle exec rake
+
+install:
+	bundle exec rake install:local
+
+streams:
+	bundle exec fluentd -c benchmark/streams.conf -vv
+
+firehose:
+	bundle exec fluentd -c benchmark/firehose.conf -vv
+
+producer:
+	bundle exec fluentd -c benchmark/producer.conf -vv
+
+dummer:
+	bundle exec dummer -c benchmark/dummer.conf
+
+hello:
+	echo Hello World | bundle exec fluent-cat --none dummy
+
+$(wildcard test/test_*.rb) $(wildcard test/**/test_*.rb):
+	bundle exec rake test TEST=$@

data/NOTICE.txt

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

data/README-v0.4.md

@@ -0,0 +1,348 @@
+# Deprecated: Fluent Plugin for Amazon Kinesis v0.4
+
+Please see [the latest README](https://github.com/awslabs/aws-fluent-plugin-kinesis/blob/master/README.md).
+
+## Overview
+
+[Fluentd](http://fluentd.org/) output plugin
+that sends events to [Amazon Kinesis](https://aws.amazon.com/kinesis/).
+
+Also, there is a documentation on [Fluentd official site](http://docs.fluentd.org/articles/kinesis-stream).
+
+## Installation
+
+This fluentd plugin is available as the `fluent-plugin-kinesis` gem from RubyGems.
+
+    gem install fluent-plugin-kinesis
+
+Or you can install this plugin for [td-agent](https://github.com/treasure-data/td-agent) as:
+
+    fluent-gem install fluent-plugin-kinesis
+
+If you would like to build by yourself and install, please see the section below.
+Your need [bundler](http://bundler.io/) for this.
+
+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:
+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 2.0.0+
+ * Fluentd 0.10.58+
+
+## 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.
+
+### role_arn
+
+IAM Role to be assumed with [AssumeRole](http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
+Use this option for cross account access.
+
+### external_id
+
+A unique identifier that is used by third parties when
+[assuming roles](http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in their customers' accounts.
+Use this option with `role_arn` for third party cross account access.
+For detail, please see [How to Use an External ID When Granting Access to Your AWS Resources to a Third Party](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
+
+### 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.
+
+### ensure_stream_connection
+
+When enabled, the plugin checks and ensures a connection to the stream you are using by [DescribeStream](http://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html) and throws exception if it fails. Enabled by default.
+
+### http_proxy
+
+Proxy server, if any.
+It should be in form like "http://squid:3128/"
+
+### 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.
+
+### use_yajl
+
+Boolean, default is false.
+In case you find error `Encoding::UndefinedConversionError` with multibyte texts, you can avoid that error with this option.
+
+### zlib_compression
+
+Boolean, default is false.
+Zlib compresses the message data blob.
+Each zlib compressed message must remain within megabyte in size.
+
+### 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)