fluent-plugin-in-kinesis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ebcfb694d8dbaada79463049e7e433714c030ea
+  data.tar.gz: b4a49fa0a0616af62f27c3c8ada4bcb11ffce8f9
+SHA512:
+  metadata.gz: c14fa067fccac7214cdf06c5f0fe0e78e53c76a2f432a0246e11dc486f11784fbf42d5774fd0f647ae856ab2fcafd53f6bb5e5388b1279fad5f679b063785311
+  data.tar.gz: bed45bcc8a7aa050a6edd31c6711e96d5cb8b5120c0fea398673dc3c14fc26c3c04dc067ddb46b348fa6a2c88d00be21032276b9abaa492129755692d747892c

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+# For TextMate, emacs, vim
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 優介 山谷
+
+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,156 @@
+# Fluent::Plugin::InKinesis
+
+##Overview
+  * This plugin retrieves records from Amazon Kinesis.
+  
+  * 1 thread is used for each shard; record retrieval occurs in parallel.
+  
+  * Number of threads is automatically adjusted to match number of shards.
+  
+  * Sequence numbers from each shard are saved.
+  
+  * Conforms to default fluent format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-in-kinesis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-in-kinesis
+
+
+##Configuration
+### `type`
+  Use the word 'kinesis'.
+
+### `stream_name`
+  Name of the stream to put data.
+ 
+### `aws_key_id`
+  AWS access key id.
+ 
+### `aws_sec_key`
+  AWS secret key.
+     
+### `region`
+  AWS region of your stream.
+  It should be in form like "us-east-1", "us-west-2".
+  
+  Refer to [Regions and Endpoints in AWS General Reference](http://docs.aws.amazon.com/general/latest/gr/rande.html#ak_region)
+  
+  for supported regions.
+
+### `profile` & `credentials_path`
+  Set as needed to specify credentials file.
+  
+### `stream_name`
+  Name of the stream to put data.
+ 
+### `state_dir_path`
+  Directory to save sequence number data.
+  Save file will be created in specified directory.
+  
+### `use_base64`
+  Set if BASE64 decode is necessary.
+ 
+### `load_records_limit`
+  The maximum number of records to return. 
+  
+  Valid range: Minimum value of 1. Maximum value of 10000.
+ 
+### `load_record_interval`
+  Frequency of record retrieval.
+  
+  Value is in seconds.
+ 
+### `load_shard_interval`
+  Frequency of shard state checks.
+  
+  Value is in seconds.
+  
+### `format`
+  Parse strings in log.
+  fluentd default parser.
+  
+### `describe_shard`
+  Set to manually specify target Kinesis shards (see below). 
+   
+### `describe_use_shards`
+  Specify the shards to be used (see below).
+ 
+##Configuration examples
+    <source>
+    
+      type kinesis
+      
+      stream_name YOUR_STREAM_NAME
+      
+      aws_key_id YOUR_AWS_ACCESS_KEY
+      
+      aws_sec_key YOUR_SECRET_KEY
+    
+      region ap-northeast-1
+      
+      load_records_limit 1000
+      
+      load_shard_interval 10
+      
+      load_record_interval 2
+      
+      tag target.log
+      
+      state_dir_path /tmp/kinesis/save_file
+      
+      use_base64 true
+      
+      format json
+      
+    </source>
+    
+##Using describe_shard
+When describe_shard is specified, target shards are manually set using describe_use_shards parameter.
+
+    <source>
+    
+      type kinesis
+      
+      stream_name YOUR_STREAM_NAME
+      
+      aws_key_id YOUR_AWS_ACCESS_KEY
+      
+      aws_sec_key YOUR_SECRET_KEY
+    
+      region ap-northeast-1
+      
+      load_records_limit 1000
+      
+      load_shard_interval 10
+      
+      load_record_interval 2
+      
+      tag target.log
+      
+      state_dir_path /tmp/kinesis/save_file
+      
+      use_base64 true
+      
+      format json
+      
+      describe_shard true
+      
+      describe_use_shards  ["shardId-000000000000", "shardId-000000000002"]
+      
+    </source>
+    
+## Related Resources
+
+* [Amazon Kinesis Developer Guide](http://docs.aws.amazon.com/kinesis/latest/dev/introduction.html)      

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-plugin-in-kinesis.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-in-kinesis"
+  spec.version       = "0.0.1"
+  spec.authors       = ["yusuke yamatani "]
+  spec.homepage      = "https://github.com/yusukeyamatani/fluent-plugin-in-kinesis"
+  spec.summary     = %q{Fluentd plugin to count records with specified regexp patterns}
+  spec.description = %q{To count records with string fields by regexps (To count records with numbers, use numeric-counter)}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd"
+   
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+
+end

data/lib/fluent/plugin/in_kinesis.rb

@@ -0,0 +1,106 @@
+# 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 'multi_json'
+require 'yajl'
+require 'logger'
+require 'securerandom'
+require 'base64'
+require 'fluent/plugin/thread_supervisor'
+require 'fluent/plugin/kinesis_shard'
+
+
+module FluentPluginKinesis
+  class InputFilter < Fluent::Input
+    include Fluent::DetachMultiProcessMixin
+    include KinesisSupervisor
+    include KinesisShard
+
+    USER_AGENT_NAME = 'fluent-plugin-kinesis-input-filter'
+
+    Fluent::Plugin.register_input("kinesis", self)
+    
+    config_param :tag,                    :string, :default => nil
+    config_param :state_dir_path,         :string, :default => nil
+
+    config_param :aws_key_id,             :string, :default => nil, :secret => true
+    config_param :aws_sec_key,            :string, :default => nil, :secret => true
+    config_param :region,                 :string, :default => nil
+    config_param :profile,                :string, :default => nil
+    config_param :credentials_path,       :string, :default => nil
+    config_param :stream_name,            :string
+    
+    config_param :use_base64,             :bool,    :default => false,  :secret => true
+    config_param :load_records_limit,     :integer, :default => 10000,  :secret => true
+    config_param :load_record_interval,   :integer, :default => 1,      :secret => true #=> sec
+    config_param :load_shard_interval,    :integer, :default => 1,      :secret => true #=> sec
+    config_param :format,                 :string,  :default => 'none', :secret => true
+    config_param :describe_shard,         :bool,    :default => false,  :secret => true
+    config_param :describe_use_shards,    :array,   :default => [],     :secret => true
+    
+    def configure(conf)
+      super
+      
+      unless @state_dir_path
+        $log.warn "'state_dir_path PATH' parameter is not set to a 'kinesis' source."
+        $log.warn "this parameter is highly recommended to save the last rows to resume tailing."
+      end
+      @parser = Fluent::Plugin.new_parser(conf['format'])
+      @parser.configure(conf)
+
+      @map = {} #=> Thread Object management
+      @thread_stop_map = {} #=> Thread stop flag management
+      @dead_thread=[] #=> Dead Thread management
+    end
+    
+    def start
+      detach_multi_process do
+        super
+        @stop_flag = false
+        load_client
+        Thread.new(&method(:supervisor_thread))
+      end
+    end
+    
+    def shutdown
+      @stop_flag = true
+    end
+
+    def load_client
+      user_agent_suffix = "#{USER_AGENT_NAME}/#{FluentPluginKinesis::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
+      end
+      
+      @client = Aws::Kinesis::Client.new(options)
+    end
+  end
+end

data/lib/fluent/plugin/kinesis_shard.rb

@@ -0,0 +1,152 @@
+
+
+module KinesisShard
+  
+  def load_records_thread(shard_id)
+    begin
+      state_store = @state_dir_path.nil? ? MemoryStateStore.new : StateStore.new(@state_dir_path, shard_id)
+    rescue => e
+      $log.warn "does not StateStore !!: #{e.message}"
+      state_store = MemoryStateStore.new
+    end
+
+    last_sequence_number = state_store.load_sequence_number
+    shard_iterator_info = get_shard_iterator_info(shard_id, last_sequence_number)
+    shard_iterator = shard_iterator_info.shard_iterator
+    
+    while !@stop_flag && !@thread_stop_map[shard_id] do
+      begin
+        records_info = @client.get_records(shard_iterator: shard_iterator, limit: @load_records_limit)
+      rescue => e
+        $log.error "get record Error: #{e.message}"
+        re_shard_iterator_info = get_shard_iterator_info(shard_id, last_sequence_number)
+        records_info = @client.get_records(
+          shard_iterator: re_shard_iterator_info.shard_iterator, limit: @load_records_limit/10)
+      end
+      
+      if records_info.next_shard_iterator.nil?
+        @thread_stop_map[shard_id] = true
+        break
+      end
+      
+      data = records_info.records.map(&:data)
+      emit_records(data, shard_id)
+      tmp_last_sequence_number = sequence(records_info)
+      
+      unless tmp_last_sequence_number.nil?
+        state_store.update(tmp_last_sequence_number)
+        last_sequence_number = tmp_last_sequence_number
+      end
+
+      shard_iterator = records_info.next_shard_iterator
+      sleep(@load_record_interval)
+    end
+  end
+    
+  def get_shard_iterator_info(shard_id='', last_sequence_number='')
+    if last_sequence_number.empty?
+      shard_iterator_info = @client.get_shard_iterator(
+        stream_name: @stream_name, shard_id: shard_id, shard_iterator_type: 'TRIM_HORIZON')
+    else
+      shard_iterator_info = @client.get_shard_iterator(
+        stream_name: @stream_name, shard_id: shard_id, shard_iterator_type: 'AFTER_SEQUENCE_NUMBER', starting_sequence_number: last_sequence_number)
+    end
+  rescue => e
+    $log.warn "does not AFTER_SEQUENCE_NUMBER : #{e.message}"
+    shard_iterator_info = @client.get_shard_iterator(
+      stream_name: @stream_name, shard_id: shard_id, shard_iterator_type: 'TRIM_HORIZON')
+  end
+
+  def emit_records(data, shard_id)
+    me = Fluent::MultiEventStream.new
+    data.each do |d|
+      if @use_base64
+        d = Base64.decode64(d)
+      end
+      
+      time, record = @parser.parse(d)
+      if record.nil? || record.empty?
+        $log.warn "format error :=> record #{time} : #{d}"
+      else
+        me.add(time, record)
+      end
+    end
+    
+    unless me.empty?
+      router.emit_stream(@tag, me)
+    end
+  end
+
+  def sequence(records_info)
+    sequence_number_list = records_info.records.map(&:sequence_number)
+    if sequence_number_list.length > 0
+      sequence_number = records_info.records.map(&:sequence_number)[-1]
+    else
+      sequence_number = nil
+    end
+  end
+  
+  
+  class StateStore
+    def initialize(dir_path, shard_id)
+      
+      unless Dir.exist?(dir_path)
+        begin
+          FileUtils.mkdir_p(dir_path)
+        rescue => e
+          raise "does not make a directory : #{e.message}"
+        end
+      end
+      @path = "#{dir_path}/last_recode_#{shard_id}.json"
+      
+      if File.exists?(@path)
+        begin
+          load_json_file
+        rescue => e
+          $log.warn "load_json_file: #{e.message}"
+        end
+      end
+      
+      if @data.nil?
+        @data = {'last_sequence_number' => ''}
+      end
+      
+      unless @data.is_a?(Hash)
+        raise "state_file on #{@path.inspect} is invalid"
+      end
+    end
+    
+    def load_json_file()
+      open(@path) do |io|
+        @data =Yajl.load(io)
+      end
+    end
+    
+    def load_sequence_number
+      @data['last_sequence_number']
+    end
+    
+    def update(sequence_number)
+      @data['last_sequence_number'] = sequence_number
+      open(@path, "w") do |io|
+        Yajl.dump(@data, io)
+      end
+    end
+  end
+    
+  class MemoryStateStore
+    
+    def initialize
+      @data = {'last_sequence_number' => ''}
+    end
+    
+    def load_sequence_number
+      @data['last_sequence_number']
+    end
+    
+    def update(sequence_number)
+      @data['last_sequence_number'] = sequence_number
+    end
+  end
+end
+

data/lib/fluent/plugin/thread_supervisor.rb

@@ -0,0 +1,68 @@
+
+
+module KinesisSupervisor
+  
+  def supervisor_thread()
+    until @stop_flag do
+      active_shard_ids = get_shard_ids()
+      update_maping(active_shard_ids)
+      sleep(@load_shard_interval)
+    end
+  end
+
+  def update_maping(active_shard_ids)
+    active_shard_ids.each do |shard_id|
+      if @map.has_key?(shard_id)
+        if @map[shard_id].status.nil?
+          $log.error "Thread dead => shard : #{shard_id}"
+          thread_kill(shard_id)
+        elsif @thread_stop_map[shard_id]
+          thread_kill(shard_id)
+        else
+          next
+        end
+      else
+        @thread_stop_map[shard_id] = false
+        t = Thread.new(shard_id, &method(:load_records_thread))
+        @map[shard_id] = t
+      end
+    end
+    
+    map_shard_ids = @map.keys
+    map_shard_ids.each do |map_shard_id|
+      unless active_shard_ids.include?(map_shard_id)
+        @thread_stop_map[shard_id] = true
+        thread_kill(map_shard_id)
+      end
+    end
+  end
+  
+  def thread_kill(shard_id)
+    $log.info "Thread killing => shard : #{shard_id}"
+    @map[shard_id].join
+    @dead_thread << shard_id
+    @thread_stop_map.delete(shard_id)
+    @map.delete(shard_id)
+  end
+  
+  def get_shard_ids()
+    active_shard_ids = []
+    shards = @client.describe_stream(stream_name: @stream_name).stream_description.shards
+    shards.each do |shard|
+      if @describe_shard & !@describe_use_shards.include?(shard.shard_id)
+        next
+      end
+      
+      unless @dead_thread.include?(shard.shard_id)
+        active_shard_ids << shard.shard_id
+      end
+    end
+    
+    active_shard_ids
+  rescue => e
+    $log.error "get_shard_ids : #{e.message}"
+  end
+end
+
+
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-in-kinesis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 'yusuke yamatani '
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 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: bundler
+  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'
+- !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: To count records with string fields by regexps (To count records with
+  numbers, use numeric-counter)
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-in-kinesis.gemspec
+- lib/fluent/plugin/in_kinesis.rb
+- lib/fluent/plugin/kinesis_shard.rb
+- lib/fluent/plugin/thread_supervisor.rb
+homepage: https://github.com/yusukeyamatani/fluent-plugin-in-kinesis
+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: Fluentd plugin to count records with specified regexp patterns
+test_files: []