fluent-plugin-kinesis-aggregation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5548ac33732637507260fd93ab07af9ffefd9838
+  data.tar.gz: 4775107634ec7271130fe2b3338f29659626ec1d
+SHA512:
+  metadata.gz: 607e54b746d6b9dd127ece2f481998b93c30140296c261753c108e3ee6e30d4fbbcb4ffd23322b4d5cef45c6f51f14805d1c65faba0f1d325a405e691a3c3dc9
+  data.tar.gz: 3ce44451659fb57bffc3bf4cf91b6b15b0d31422627b033ced0c32ee51bdfec7581ff8b41864df955dbddda928c8235a65e0a47513000539db884a9b11f935aa

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,14 @@
+language: ruby
+
+rvm:
+  - 2.2
+
+os:
+  - linux
+
+gemfile:
+  - Gemfile
+
+script: bundle exec rake
+
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,47 @@
+# CHANGELOG
+
+## 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)
+
+Note: We introduced [Semantic Versioning](http://semver.org/) here.
+
+## 0.3.6
+
+- **Cross account access support**: Added support for cross account access for Amazon Kinesis stream. With this update, you can put reocrds to streams those are owned by other AWS account. This feature is achieved by [AssumeRole](http://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
+
+## 0.3.5
+
+- **1MB record size limit**: Increased record size limit from 50KB to 1MB due to [Amazon Kinesis improvement.](http://aws.amazon.com/jp/about-aws/whats-new/2015/06/amazon-kinesis-announces-put-pricing-change-1mb-record-support-and-the-kinesis-producer-library/)
+- **Switching IAM user support**: Added support for [shared credential file](http://docs.aws.amazon.com/ja_jp/AWSSdkDocsRuby/latest/DeveloperGuide/prog-basics-creds.html#creds-specify-provider).
+
+## 0.3.4
+
+- **Multi-byte UTF-8 support**: We now support multi-byte UTF-8 by using *use_yajl* option.
+
+## 0.3.3
+
+- **Security improvements**: Disabled logging `aws_key_id` and `aws_sec_key` into log file.
+
+## 0.3.2
+
+- **http_proxy support**: Added HTTP proxy support.
+
+## 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,251 @@
+# Fluent Plugin for Amazon Kinesis producing KPL records
+
+[![Build Status](https://travis-ci.org/atlassian/fluent-plugin-kinesis-aggregation.svg?branch=master)](https://travis-ci.org/atlassian/fluent-plugin-kinesis-aggregation)
+
+## Before you start...
+
+This is a rewrite of [aws-fluent-plugin-kinesis](https://github.com/awslabs/aws-fluent-plugin-kinesis) to implement
+a different shipment method using the
+[KPL aggregation format](https://github.com/awslabs/amazon-kinesis-producer/blob/master/aggregation-format.md).
+
+The basic idea is to have one PutRecord === one chunk. This has a number of advantages:
+
+- much less complexity in plugin (less CPU/memory)
+- by aggregating, we increase the throughput and decrease the cost
+- since a single chunk either succeeds or fails,
+  we get to use fluentd's more complex/complete retry mechanism
+  (which is also exposed in the monitor). The existing retry mechanism
+  has [unfortunate issues under heavy load](https://github.com/awslabs/aws-fluent-plugin-kinesis/issues/42)
+- we get ordering within a chunk without having to rely on sequence
+  numbers (though not overall ordering)
+
+However, there are drawbacks:
+
+- you have to use a KCL library to ingest
+- you can't use a calculated partition key (based on the record);
+  essentially, you need to use a random partition key
+
+## Overview
+
+[Fluentd](http://fluentd.org/) output plugin
+that sends events to [Amazon Kinesis](https://aws.amazon.com/kinesis/).
+
+## Installation
+
+In case of using with Fluentd:
+Fluentd will be also installed via the process below.
+
+    git clone https://github.com/atlassian/fluent-plugin-kinesis-aggregation.git
+    cd fluent-plugin-kinesis-aggregation
+    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/atlassian/fluent-plugin-kinesis-aggregation.git
+    cd fluent-plugin-kinesis-aggregation
+    bundle install
+    rake build
+    fluent-gem install pkg/fluent-plugin-kinesis-aggregation
+
+Or just download specify your Ruby library path.
+Below is the sample for specifying your library path via RUBYLIB.
+
+    git clone https://github.com/atlassian/fluent-plugin-kinesis-aggregation.git
+    cd fluent-plugin-kinesis-aggregation
+    bundle install
+    export RUBYLIB=$RUBYLIB:/path/to/fluent-plugin-kinesis-aggregation/lib
+
+## Dependencies
+
+ * Ruby 2.2+
+ * 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-aggregation'.
+
+### 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 details, 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.
+
+### http_proxy
+
+Proxy server, if any.
+It should be in form like "http://squid:3128/"
+
+### fixed_partition_key
+
+Instead of using a random partition key, used a fixed one. This
+forces all writes to a specific shard, and if you're using
+a single thread/process will probably keep event ordering
+(not recommended - watch out for hot shards!).
+
+### 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. 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*.
+
+### 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, a value 'foo' will be used as the partition key,
+then events will be sent to the stream specified in 'stream_name'.
+
+    <match your_tag>
+    type kinesis-aggregation
+
+    stream_name YOUR_STREAM_NAME
+
+    aws_key_id YOUR_AWS_ACCESS_KEY
+    aws_sec_key YOUR_SECRET_KEY
+
+    region us-east-1
+
+    fixed_partition_key foo
+
+    # You should set the buffer_chunk_limit to substantially less
+    # than the kinesis 1mb record limit, since we ship a chunk at once.
+    buffer_chunk_limit 300k
+    </match>
+
+### Improving throughput to Amazon Kinesis
+
+The achievable throughput to Amazon Kinesis is limited to single-threaded
+PutRecord calls, which should be at most around 300kb each.
+The plugin can also be configured to execute in parallel.
+The **detach_process** and **num_threads** configuration settings control
+parallelism.
+
+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
+    buffer_chunk_limit 300k
+    </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
+    buffer_chunk_limit 300k
+    </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
+    buffer_chunk_limit 300k
+    </match>
+
+## Related Resources
+
+* [Amazon Kinesis Developer Guide](http://docs.aws.amazon.com/kinesis/latest/dev/introduction.html)

data/Rakefile

@@ -0,0 +1,23 @@
+# 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.
+
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-kinesis-aggregation.gemspec

@@ -0,0 +1,42 @@
+# 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.
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "fluent/plugin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-kinesis-aggregation"
+  spec.version       = FluentPluginKinesisAggregation::VERSION
+  spec.author        = 'Someone'
+  spec.summary       = %q{Fluentd output plugin that sends KPL style aggregated events to Amazon Kinesis.}
+  spec.homepage      = "https://github.com/wryun/fluent-plugin-kinesis-aggregation"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit-rr", "~> 1.0"
+
+  spec.add_dependency "fluentd", ">= 0.10.53", "< 0.13"
+  spec.add_dependency "aws-sdk-core", ">= 2.0.12", "< 3.0"
+  spec.add_dependency "msgpack", ">= 0.5.8"
+  spec.add_dependency "protobuf", ">= 3.5.5"
+end

data/lib/fluent/plugin/out_kinesis-aggregation.rb

@@ -0,0 +1,197 @@
+# 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.
+
+require 'aws-sdk-core'
+require 'yajl'
+require 'logger'
+require 'securerandom'
+require 'fluent/plugin/version'
+require 'digest'
+
+require 'protobuf'
+require 'protobuf/message'
+
+
+# https://github.com/awslabs/amazon-kinesis-producer/blob/master/aggregation-format.md
+class AggregatedRecord < ::Protobuf::Message; end
+class Tag < ::Protobuf::Message; end
+class Record < ::Protobuf::Message; end
+
+class AggregatedRecord
+  repeated :string, :partition_key_table, 1
+  repeated :string, :explicit_hash_key_table, 2
+  repeated ::Record, :records, 3
+end
+
+class Tag
+  required :string, :key, 1
+  optional :string, :value, 2
+end
+
+class Record
+  required :uint64, :partition_key_index, 1
+  optional :uint64, :explicit_hash_key_index, 2
+  required :bytes, :data, 3
+  repeated ::Tag, :tags, 4
+end
+
+
+module FluentPluginKinesisAggregation
+  class OutputFilter < Fluent::BufferedOutput
+
+    include Fluent::DetachMultiProcessMixin
+    include Fluent::SetTimeKeyMixin
+    include Fluent::SetTagKeyMixin
+
+    USER_AGENT_NAME = 'fluent-plugin-kinesis-aggregation-output-filter'
+    PUT_RECORD_MAX_DATA_SIZE = 1024 * 1024
+    # 200 is an arbitrary number more than the envelope overhead
+    # and big enough to store partition/hash key table in
+    # AggregatedRecords. Note that you shouldn't really ever have
+    # the buffer this high, since you're likely to fail the write
+    # if anyone else is writing to the shard at the time.
+    FLUENTD_MAX_BUFFER_SIZE = PUT_RECORD_MAX_DATA_SIZE - 200
+
+    Fluent::Plugin.register_output('kinesis-aggregation', self)
+
+    config_set_default :include_time_key, true
+    config_set_default :include_tag_key,  true
+
+    config_param :aws_key_id,  :string, default: nil, :secret => true
+    config_param :aws_sec_key, :string, default: nil, :secret => true
+    # The 'region' parameter is optional because
+    # it may be set as an environment variable.
+    config_param :region,      :string, default: nil
+
+    config_param :profile,          :string, :default => nil
+    config_param :credentials_path, :string, :default => nil
+    config_param :role_arn,         :string, :default => nil
+    config_param :external_id,      :string, :default => nil
+
+    config_param :stream_name,            :string
+    config_param :fixed_partition_key,    :string, default: nil
+
+    config_param :debug, :bool, default: false
+
+    config_param :http_proxy, :string, default: nil
+
+    def configure(conf)
+      super
+
+      if @buffer.chunk_limit > FLUENTD_MAX_BUFFER_SIZE
+        raise Fluent::ConfigError, "Kinesis buffer_chunk_limit is set to more than the 1mb shard limit (i.e. you won't be able to write your chunks!"
+      end
+
+      if @buffer.chunk_limit > FLUENTD_MAX_BUFFER_SIZE / 3
+        log.warn 'Kinesis buffer_chunk_limit is set at more than 1/3 of the per second shard limit (1mb). This is not good if you have many producers.'
+      end
+    end
+
+    def start
+      detach_multi_process do
+        super
+        load_client
+      end
+    end
+
+    def format(tag, time, record)
+      return AggregatedRecord.new(
+        records: [Record.new(
+          partition_key_index: 0,
+          data: Yajl.dump(record)
+        )]
+      ).encode
+    end
+
+    def write(chunk)
+      records = chunk.read
+      if records.length > FLUENTD_MAX_BUFFER_SIZE
+        log.error "Can't emit aggregated record of length #{records.length} (more than #{FLUENTD_MAX_BUFFER_SIZE})"
+        return # do not throw, since we can't retry
+      end
+
+      partition_key = @fixed_partition_key || SecureRandom.uuid
+
+      # confusing magic. Because of the format of protobuf records,
+      # it's valid (in this case) to concatenate the AggregatedRecords
+      # to form one AggregatedRecord, since we only have a repeated field
+      # in records.
+      message = AggregatedRecord.new(
+        partition_key_table: [partition_key]
+      ).encode + records
+
+      @client.put_record(
+        stream_name: @stream_name,
+        data: kpl_aggregation_pack(message),
+        partition_key: partition_key
+      )
+    end
+
+    private
+
+    # https://github.com/awslabs/amazon-kinesis-producer/blob/master/aggregation-format.md
+    KPL_MAGIC_NUMBER = "\xF3\x89\x9A\xC2"
+    def kpl_aggregation_pack(message)
+        [
+          KPL_MAGIC_NUMBER, message, Digest::MD5.digest(message)
+        ].pack("A4A*A16")
+    end
+
+    # This code is unchanged from https://github.com/awslabs/aws-fluent-plugin-kinesis
+    def load_client
+      user_agent_suffix = "#{USER_AGENT_NAME}/#{FluentPluginKinesisAggregation::VERSION}"
+
+      options = {
+        user_agent_suffix: user_agent_suffix
+      }
+
+      if @region
+        options[:region] = @region
+      end
+
+      if @aws_key_id && @aws_sec_key
+        options.update(
+          access_key_id: @aws_key_id,
+          secret_access_key: @aws_sec_key,
+        )
+      elsif @profile
+        credentials_opts = {:profile_name => @profile}
+        credentials_opts[:path] = @credentials_path if @credentials_path
+        credentials = Aws::SharedCredentials.new(credentials_opts)
+        options[:credentials] = credentials
+      elsif @role_arn
+        credentials = Aws::AssumeRoleCredentials.new(
+          client: Aws::STS::Client.new(options),
+          role_arn: @role_arn,
+          role_session_name: "fluent-plugin-kinesis-aggregation",
+          external_id: @external_id,
+          duration_seconds: 60 * 60
+        )
+        options[:credentials] = credentials
+      end
+
+      if @debug
+        options.update(
+          logger: Logger.new(log.out),
+          log_level: :debug
+        )
+      end
+
+      if @http_proxy
+        options[:http_proxy] = @http_proxy
+      end
+
+      @client = Aws::Kinesis::Client.new(options)
+    end
+  end
+end

data/lib/fluent/plugin/version.rb

@@ -0,0 +1,16 @@
+# 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.
+
+module FluentPluginKinesisAggregation
+  VERSION = '0.1.0'
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+# 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.
+
+require 'rubygems'
+require 'bundler'
+require 'stringio'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'test/unit/rr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'fluent/plugin/out_kinesis-aggregation'

data/test/plugin/test_out_kinesis-aggregation.rb

@@ -0,0 +1,223 @@
+# 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.
+
+require 'helper'
+
+class KinesisOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    aws_key_id test_key_id
+    aws_sec_key test_sec_key
+    stream_name test_stream
+    region us-east-1
+    fixed_partition_key test_partition_key
+    buffer_chunk_limit 100k
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver
+      .new(FluentPluginKinesisAggregation::OutputFilter, tag).configure(conf)
+  end
+
+  def create_mock_client
+    client = mock(Object.new)
+    mock(Aws::Kinesis::Client).new({}) { client }
+    return client
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'test_key_id', d.instance.aws_key_id
+    assert_equal 'test_sec_key', d.instance.aws_sec_key
+    assert_equal 'test_stream', d.instance.stream_name
+    assert_equal 'us-east-1', d.instance.region
+    assert_equal 'test_partition_key', d.instance.fixed_partition_key
+  end
+
+  def test_configure_with_credentials
+    d = create_driver(<<-EOS)
+      profile default
+      credentials_path /home/scott/.aws/credentials
+      stream_name test_stream
+      region us-east-1
+      fixed_partition_key test_partition_key
+      buffer_chunk_limit 100k
+    EOS
+
+    assert_equal 'default', d.instance.profile
+    assert_equal '/home/scott/.aws/credentials', d.instance.credentials_path
+    assert_equal 'test_stream', d.instance.stream_name
+    assert_equal 'us-east-1', d.instance.region
+    assert_equal 'test_partition_key', d.instance.fixed_partition_key
+  end
+
+  def test_configure_with_more_options
+    conf = %[
+      stream_name test_stream
+      region us-east-1
+      http_proxy http://proxy:3333/
+      fixed_partition_key test_partition_key
+      buffer_chunk_limit 100k
+    ]
+    d = create_driver(conf)
+    assert_equal 'test_stream', d.instance.stream_name
+    assert_equal 'us-east-1', d.instance.region
+    assert_equal 'http://proxy:3333/', d.instance.http_proxy
+    assert_equal 'test_partition_key', d.instance.fixed_partition_key
+  end
+
+  def test_configure_fails_on_big_chunk_limit
+    conf = %[
+      stream_name test_stream
+      region us-east-1
+      http_proxy http://proxy:3333/
+      fixed_partition_key test_partition_key
+      buffer_chunk_limit 1m
+    ]
+    assert_raise Fluent::ConfigError do
+      create_driver(conf)
+    end
+  end
+
+  def test_load_client
+    client = stub(Object.new)
+    client.put_record { {} }
+
+    stub(Aws::Kinesis::Client).new do |options|
+      assert_equal("test_key_id", options[:access_key_id])
+      assert_equal("test_sec_key", options[:secret_access_key])
+      assert_equal("us-east-1", options[:region])
+      client
+    end
+
+    d = create_driver
+    d.run
+  end
+
+  def test_load_client_with_credentials
+    client = stub(Object.new)
+    client.put_record { {} }
+
+    stub(Aws::Kinesis::Client).new do |options|
+      assert_equal(nil, options[:access_key_id])
+      assert_equal(nil, options[:secret_access_key])
+      assert_equal("us-east-1", options[:region])
+
+      credentials = options[:credentials]
+      assert_equal("default", credentials.profile_name)
+      assert_equal("/home/scott/.aws/credentials", credentials.path)
+
+      client
+    end
+
+    d = create_driver(<<-EOS)
+      profile default
+      credentials_path /home/scott/.aws/credentials
+      stream_name test_stream
+      region us-east-1
+      fixed_partition_key test_partition_key
+      buffer_chunk_limit 100k
+    EOS
+
+    d.run
+  end
+
+  def test_load_client_with_role_arn
+    client = stub(Object.new)
+    client.put_record { {} }
+
+    stub(Aws::AssumeRoleCredentials).new do |options|
+      assert_equal("arn:aws:iam::001234567890:role/my-role", options[:role_arn])
+      assert_equal("fluent-plugin-kinesis-aggregation", options[:role_session_name])
+      assert_equal("my_external_id", options[:external_id])
+      assert_equal(3600, options[:duration_seconds])
+      "sts_credentials"
+    end
+
+    stub(Aws::Kinesis::Client).new do |options|
+      assert_equal("sts_credentials", options[:credentials])
+      client
+    end
+
+    d = create_driver(<<-EOS)
+      role_arn arn:aws:iam::001234567890:role/my-role
+      external_id my_external_id
+      stream_name test_stream
+      region us-east-1
+      fixed_partition_key test_partition_key
+      buffer_chunk_limit 100k
+    EOS
+    d.run
+  end
+
+  def test_format
+    d = create_driver
+
+    data1 = {"test_partition_key"=>"key1","a"=>1,"time"=>"2011-01-02T13:14:15Z","tag"=>"test"}
+    data2 = {"test_partition_key"=>"key2","a"=>2,"time"=>"2011-01-02T13:14:15Z","tag"=>"test"}
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit(data1, time)
+    d.emit(data2, time)
+    d.expect_format("\u001AR\b\u0000\u001AN{\"test_partition_key\":\"key1\",\"a\":1,\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}")
+    d.expect_format("\u001AR\b\u0000\u001AN{\"test_partition_key\":\"key2\",\"a\":2,\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}")
+
+    client = create_mock_client
+    client.put_record(
+      stream_name: 'test_stream',
+      data: "\xF3\x89\x9A\xC2\n\x12test_partition_key\x1AR\b\x00\x1AN{\"test_partition_key\":\"key1\",\"a\":1,\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}\x1AR\b\x00\x1AN{\"test_partition_key\":\"key2\",\"a\":2,\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}\xB6j\x1E\xF7q\xC9}v\vU\xAD\xA3@<\x82\xA9".force_encoding("ASCII-8BIT"),
+      partition_key: 'test_partition_key'
+    ) { {} }
+
+    d.run
+  end
+
+  def test_multibyte
+    d = create_driver
+
+    data1 = {"test_partition_key"=>"key1","a"=>"\xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB","time"=>"2011-01-02T13:14:15Z","tag"=>"test"}
+    data1["a"].force_encoding("ASCII-8BIT")
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    d.emit(data1, time)
+
+    d.expect_format(
+        "\x1Ae\b\x00\x1Aa{\"test_partition_key\":\"key1\",\"a\":\"\xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\",\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}".force_encoding("ASCII-8BIT")
+    )
+
+    client = create_mock_client
+    client.put_record(
+      stream_name: 'test_stream',
+      data: "\xF3\x89\x9A\xC2\n\x12test_partition_key\x1Ae\b\x00\x1Aa{\"test_partition_key\":\"key1\",\"a\":\"\xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\",\"time\":\"2011-01-02T13:14:15Z\",\"tag\":\"test\"}\xC8\x13{\xFBL_\x8FE\x02\xEEC\xC9_~\xEF(".force_encoding("ASCII-8BIT"),
+      partition_key: 'test_partition_key'
+    ) { {} }
+
+    d.run
+  end
+
+  def test_fail_on_bigchunk
+    d = create_driver
+
+    d.emit(
+      {"msg": "z" * 1024 * 1024},
+      Time.parse("2011-01-02 13:14:15 UTC").to_i)
+    client = dont_allow(Object.new)
+    client.put_record
+    mock(Aws::Kinesis::Client).new({}) { client }
+
+    d.run
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kinesis-aggregation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Someone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.53
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.53
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+- !ruby/object:Gem::Dependency
+  name: protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.5
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTORS.txt
+- Gemfile
+- LICENSE.txt
+- NOTICE.txt
+- README.md
+- Rakefile
+- fluent-plugin-kinesis-aggregation.gemspec
+- lib/fluent/plugin/out_kinesis-aggregation.rb
+- lib/fluent/plugin/version.rb
+- test/helper.rb
+- test/plugin/test_out_kinesis-aggregation.rb
+homepage: https://github.com/wryun/fluent-plugin-kinesis-aggregation
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fluentd output plugin that sends KPL style aggregated events to Amazon Kinesis.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_kinesis-aggregation.rb