fluent-plugin-kinesis-alt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfc7866ce0006f1ffdcfb0f0ecdc30558a5df997
+  data.tar.gz: e45f0d00255c99bc6cd786fc54f322e081c43f36
+SHA512:
+  metadata.gz: 98706b5fe436280c1ab66fa3191137b9936ea9db6dcacc1d6033761438d3f2fd4ef906b8b6174639542b9e63520c8199bb338bdb94ed2da6af2c2fa99bd3b3c3
+  data.tar.gz: 744f4540579994a7ec5448215cdcd2bc57fa767c5ffabdb569c0bb7d87f1c20e7b157c20940d50fa9a58eef10a07d9e01c0f009f01af12821c66efbfd93d2cc1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-kinesis-alt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Genki Sugawara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# fluent-plugin-kinesis-alt
+
+Output filter plugin for Amazon Kinesis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-kinesis-alt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-kinesis-alt
+
+## Usage
+
+### Configuration
+
+```
+<match kinesis.**>
+  type kinesis_alt
+  aws_key_id ...
+  aws_sec_key ...
+  region us-east-1
+
+  stream_name your_stream_name
+
+  #partition_key any_json_key
+
+  # partition_key:
+  #   JSON Object Hash Key for PartitionKey
+  #   e.g.)
+  #     JSON Object: {'foo': 100, 'bar': 200}
+  #     fluent config: partition_key=foo
+  #     -> PutRecord Action: PartitionKey=100
+
+  partition_key_proc proc {|i| Time.now.to_i.to_s }
+
+  # partition_key_proc:
+  #   Ruby Code to create PartitionKey
+  #   e.g.)
+  #     fluent config: partition_key_proc=proc {|i| 100 + 200 }
+  #     -> PutRecord Action: PartitionKey=300
+
+  #explicit_hash_key ...
+  #explicit_hash_key_proc ...
+
+  #debug false
+  #include_tag true
+  #include_time true
+
+  flush_interval 3
+</match>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+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-alt.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-kinesis-alt'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Genki Sugawara']
+  spec.email         = ['sgwr_dts@yahoo.co.jp']
+  spec.description   = 'Output filter plugin for Amazon Kinesis'
+  spec.summary       = 'Output filter plugin for Amazon Kinesis'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fluentd'
+  spec.add_dependency 'aws-sdk', '>= 1.31.3'
+  spec.add_dependency 'json'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/fluent/plugin/out_kinesis_alt.rb

@@ -0,0 +1,142 @@
+module Fluent
+  class KinesisAltOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('kinesis_alt', self)
+
+    def initialize
+      super
+      require 'aws-sdk'
+      require 'base64'
+      require 'json'
+      require 'logger'
+    end
+
+    config_param :aws_key_id,   :string, :default => nil
+    config_param :aws_sec_key,  :string, :default => nil
+    config_param :region,       :string, :default => nil
+
+    config_param :stream_name,            :string, :default => nil
+    config_param :partition_key,          :string, :default => nil
+    config_param :partition_key_proc,     :string, :default => nil
+    config_param :explicit_hash_key,      :string, :default => nil
+    config_param :explicit_hash_key_proc, :string, :default => nil
+
+    config_param :sequence_number_for_ordering, :string, :default => nil
+
+    config_param :include_tag,  :bool, :default => true
+    config_param :include_time, :bool, :default => true
+    config_param :debug,        :bool, :default => false
+
+    def configure(conf)
+      super
+
+      [:aws_key_id, :aws_sec_key, :region, :stream_name].each do |name|
+        unless self.instance_variable_get("@#{name}")
+          raise ConfigError, "'#{name}' is required"
+        end
+      end
+
+      unless @partition_key or @partition_key_proc
+        raise ConfigError, "'partition_key' or 'partition_key_proc' is required"
+      end
+
+      if @partition_key_proc
+        @partition_key_proc = eval(@partition_key_proc)
+      end
+
+      if @explicit_hash_key_proc
+        @explicit_hash_key_proc = eval(@explicit_hash_key_proc)
+      end
+    end
+
+    def start
+      super
+      configure_aws
+      @client = AWS.kinesis.client
+      @client.describe_stream(:stream_name => @stream_name)
+    end
+
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      record['__tag']  = tag  if @include_tag
+      record['__time'] = time if @include_time
+
+      # XXX: The maximum size of the data blob is 50 kilobytes
+      # http://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html
+      data = {
+        :stream_name   => @stream_name,
+        :data          => encode64(record.to_json),
+        :partition_key => get_key(:partition_key, record)
+      }
+
+      if @explicit_hash_key or @explicit_hash_key_proc
+        data[:explicit_hash_key] = get_key(:explicit_hash_key, record)
+      end
+
+      if @sequence_number_for_ordering
+        data[:sequence_number_for_ordering] = @sequence_number_for_ordering
+      end
+
+      pack_data(data)
+    end
+
+    def write(chunk)
+      buf = chunk.read
+
+      while (data = unpack_data(buf))
+        AWS.kinesis.client.put_record(data)
+      end
+    end
+
+    private
+
+    def configure_aws
+      options = {
+        :access_key_id     =>  @aws_key_id ,
+        :secret_access_key => @aws_sec_key,
+        :region            => @region
+      }
+
+      if @debug
+        options.update(
+          :logger          => Logger.new($log.out),
+          :log_level       => :debug,
+          #:http_wire_trace => true
+        )
+      end
+
+      AWS.config(options)
+    end
+
+    def get_key(name, record)
+      key = self.instance_variable_get("@#{name}")
+      key_proc = self.instance_variable_get("@#{name}_proc")
+
+      value = key ? record[key] : record
+      value = key_proc.call(value) if key_proc
+
+      value.to_s
+    end
+
+    def pack_data(data)
+      data = data.to_msgpack(data)
+      data.force_encoding('ascii-8bit')
+      [data.length].pack('L') + data
+    end
+
+    def unpack_data(buf)
+      return nil if buf.empty?
+
+      buf.force_encoding('ascii-8bit')
+      length = buf.slice!(0, 4).unpack('L').first
+      data = buf.slice!(0, length)
+      MessagePack.unpack(data)
+    end
+
+    def encode64(str)
+      Base64.encode64(str).delete("\n")
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+
+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'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+
+  nulllogger.instance_eval do |obj|
+    def method_missing(method, *args); end
+  end
+
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_kinesis_alt'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_kinesis_alt.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class KinesisAltOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+  ]
+  # CONFIG = %[
+  #   path #{TMP_DIR}/out_file_test
+  #   compress gz
+  #   utc
+  # ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::KinesisAltOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    #### set configurations
+    # d = create_driver %[
+    #   path test_path
+    #   compress gz
+    # ]
+    #### check configurations
+    # assert_equal 'test_path', d.instance.path
+    # assert_equal :gz, d.instance.compress
+  end
+
+  def test_format
+    #d = create_driver
+
+    # time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    # d.emit({"a"=>1}, time)
+    # d.emit({"a"=>2}, time)
+
+    # d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":1}\n]
+    # d.expect_format %[2011-01-02T13:14:15Z\ttest\t{"a":2}\n]
+
+    # d.run
+  end
+
+  def test_write
+    #d = create_driver
+
+    # time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    # d.emit({"a"=>1}, time)
+    # d.emit({"a"=>2}, time)
+
+    # ### FileOutput#write returns path
+    # path = d.run
+    # expect_path = "#{TMP_DIR}/out_file_test._0.log.gz"
+    # assert_equal expect_path, path
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kinesis-alt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.31.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.31.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Output filter plugin for Amazon Kinesis
+email:
+- sgwr_dts@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-kinesis-alt.gemspec
+- lib/fluent/plugin/out_kinesis_alt.rb
+- test/helper.rb
+- test/plugin/test_out_kinesis_alt.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Output filter plugin for Amazon Kinesis
+test_files:
+- test/helper.rb
+- test/plugin/test_out_kinesis_alt.rb