fluent-plugin-buffer-lightening 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10e80754b85bcc5fa9bc83d47e75ee7bf7637b68
+  data.tar.gz: 558822e85a83088e88268869ad13cbc121a7c39f
+SHA512:
+  metadata.gz: ef5d463b78bf73975c8c5ddad3e01a09960bc6b115ea578308d4dbf6d0afd5e9c0022b8164ea6f5e6b08573cf342819cfe8245304b6ff6c885019b6f93e8b03b
+  data.tar.gz: f6fdf47d488ecc61ce7efa12e392409686f2b1fbf94c2de8b2807f3e3eb5aa5eb1ca4f3303516ce1144f3e8740269a3c6b8e34994d89f12ac4ec395e2bc08bfa

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-buffer-lightening.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   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/README.md

@@ -0,0 +1,68 @@
+# fluent-plugin-buffer-lightening
+
+Fluentd buffer plugin on memory to flush with many types of chunk limit methods:
+  * events count limit in chunk
+
+These options are to decrease latency from emit to write, and to control chunk sizes and flush sizes.
+
+**NOTICE:** Lightening buffer plugin stores data on memory, so these data will be lost when process/server crashes.
+
+And current version of this plugin adds `try_flush_interval` option to BufferedOutput plugins, to flush buffer chunk with high frequency. For this option, run fluentd with `-r fluent/plugin/output_try_flush_interval_patch`.
+
+## Installation
+
+Do `gem install fluent-plugin-buffer-lightening` or `fluent-gem ...`.
+
+## Configuration
+
+Lightening buffer plugin can be enabled with all of buffered output plugins.
+
+To flush chunks per 100 records, configure like this:
+
+```
+<match data.**>
+  type any_buffered_output_plugin
+  buffer_type lightening
+  buffer_chunk_records_limit 100
+  # other options...
+</match>
+```
+
+Options of `buffer_type memory` are also available:
+```
+<match data.**>
+  type any_buffered_output_plugin
+  buffer_type lightening
+  buffer_chunk_limit 10M
+  buffer_chunk_records_limit 100
+  # other options...
+</match>
+```
+
+### For less delay
+
+For more frequently flushing, use `flush_interval` and `try_flush_interval` with floating point values:
+```
+<match data.**>
+  type any_buffered_output_plugin
+  buffer_type lightening
+  buffer_chunk_records_limit 100
+  # other options...
+  flush_interval 0.5
+  try_flush_interval 0.1 # 0.6sec delay for worst case
+</match>
+```
+
+And, execute fluentd as `fluentd -r fluent/plugin/output_try_flush_interval_patch -c fluentd.conf`.
+
+## TODO
+
+* remove `output_try_flush_interval_patch` with incoming fluentd dependency
+* more limit patterns
+* patches welcome!
+
+## Copyright
+
+* Copyright (c) 2013- TAGOMORI Satoshi (tagomoris)
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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-buffer-lightening.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-buffer-lightening"
+  spec.version       = "0.0.1"
+  spec.authors       = ["TAGOMORI Satoshi"]
+  spec.email         = ["tagomoris@gmail.com"]
+  spec.description   = %q{Fluentd memory buffer plugin with many types of chunk limits}
+  spec.summary       = %q{Alternative memory buffer plugin for Fluentd to realize less delay}
+  spec.homepage      = "https://github.com/tagomoris/fluent-plugin-buffer-lightening"
+  spec.license       = "APLv2"
+
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/buf_lightening.rb

@@ -0,0 +1,84 @@
+require 'fluent/plugin/buf_memory'
+require_relative 'output_try_flush_interval_patch'
+
+module Fluent
+  class LighteningBufferChunk < MemoryBufferChunk
+    attr_reader :record_counter
+
+    def initialize(key, data='')
+      super
+      @record_counter = 0
+    end
+
+    def <<(data)
+      super
+      @record_counter += 1
+    end
+  end
+
+  class LighteningBuffer < MemoryBuffer
+    Fluent::Plugin.register_buffer('lightening', self)
+
+    config_param :buffer_chunk_records_limit, :integer, :default => nil
+
+    def configure(conf)
+      super
+    end
+
+    def new_chunk(key)
+      LighteningBufferChunk.new(key)
+    end
+
+    def storable?(chunk, data)
+      return false if chunk.size + data.bytesize > @buffer_chunk_limit
+      return false if @buffer_chunk_records_limit && chunk.record_counter >= @buffer_chunk_records_limit
+      true
+    end
+
+    # TODO: remove w/ fluentd v0.10.42 (or td-agent including fluentd v0.10.42)
+    def emit(key, data, chain) # copy&paste from BasicBuffer, and fix to add hook point
+      key = key.to_s
+
+      synchronize do
+        top = (@map[key] ||= new_chunk(key))
+
+        if storable?(top, data) # hook point (FIXED THIS LINE ONLY)
+          chain.next
+          top << data
+          return false
+        elsif @queue.size >= @buffer_queue_limit
+          raise BufferQueueLimitError, "queue size exceeds limit"
+        end
+
+        if data.bytesize > @buffer_chunk_limit
+          $log.warn "Size of the emitted data exceeds buffer_chunk_limit."
+          $log.warn "This may occur problems in the output plugins ``at this server.``"
+          $log.warn "To avoid problems, set a smaller number to the buffer_chunk_limit"
+          $log.warn "in the forward output ``at the log forwarding server.``"
+        end
+
+        nc = new_chunk(key)
+        ok = false
+
+        begin
+          nc << data
+          chain.next
+
+          flush_trigger = false
+          @queue.synchronize {
+            enqueue(top)
+            flush_trigger = @queue.empty?
+            @queue << top
+            @map[key] = nc
+          }
+
+          ok = true
+          return flush_trigger
+        ensure
+          nc.purge unless ok
+        end
+
+      end  # synchronize
+    end
+  end
+end

data/lib/fluent/plugin/output_try_flush_interval_patch.rb

@@ -0,0 +1,113 @@
+# MEMO: execute fluentd with "-r fluent/plugin/output_try_flush_interval_patch" switch
+
+# TODO: remove w/ fluentd v0.10.42 (or td-agent including fluentd v0.10.42)
+module Fluent
+  class BufferedOutput < Output
+    config_param :try_flush_interval, :float, :default => 1
+
+    # override with @try_flush_interval
+    def try_flush
+      time = Engine.now
+
+      empty = @buffer.queue_size == 0
+      if empty && @next_flush_time < (now = Engine.now)
+        @buffer.synchronize do
+          if @next_flush_time < now
+            enqueue_buffer
+            @next_flush_time = now + @flush_interval
+            empty = @buffer.queue_size == 0
+          end
+        end
+      end
+      if empty
+        return time + @try_flush_interval
+      end
+
+      begin
+        retrying = !@error_history.empty?
+
+        if retrying
+          @error_history.synchronize do
+            if retrying = !@error_history.empty?  # re-check in synchronize
+              if @next_retry_time >= time
+                # allow retrying for only one thread
+                return time + @try_flush_interval
+              end
+              # assume next retry failes and
+              # clear them if when it succeeds
+              @last_retry_time = time
+              @error_history << time
+              @next_retry_time += calc_retry_wait
+            end
+          end
+        end
+
+        if @secondary && @error_history.size > @retry_limit
+          has_next = flush_secondary(@secondary)
+        else
+          has_next = @buffer.pop(self)
+        end
+
+        # success
+        if retrying
+          @error_history.clear
+          # Note: don't notify to other threads to prevent
+          #       burst to recovered server
+          $log.warn "retry succeeded.", :instance=>object_id
+        end
+
+        if has_next
+          return Engine.now + @queued_chunk_flush_interval
+        else
+          return time + @try_flush_interval
+        end
+
+      rescue => e
+        if retrying
+          error_count = @error_history.size
+        else
+          # first error
+          error_count = 0
+          @error_history.synchronize do
+            if @error_history.empty?
+              @last_retry_time = time
+              @error_history << time
+              @next_retry_time = time + calc_retry_wait
+            end
+          end
+        end
+
+        if error_count < @retry_limit
+          $log.warn "temporarily failed to flush the buffer.", :next_retry=>Time.at(@next_retry_time), :error_class=>e.class.to_s, :error=>e.to_s, :instance=>object_id
+          $log.warn_backtrace e.backtrace
+
+        elsif @secondary
+          if error_count == @retry_limit
+            $log.warn "failed to flush the buffer.", :error_class=>e.class.to_s, :error=>e.to_s, :instance=>object_id
+            $log.warn "retry count exceededs limit. falling back to secondary output."
+            $log.warn_backtrace e.backtrace
+            retry  # retry immediately
+          elsif error_count <= @retry_limit + @secondary_limit
+            $log.warn "failed to flush the buffer, next retry will be with secondary output.", :next_retry=>Time.at(@next_retry_time), :error_class=>e.class.to_s, :error=>e.to_s, :instance=>object_id
+            $log.warn_backtrace e.backtrace
+          else
+            $log.warn "failed to flush the buffer.", :error_class=>e.class, :error=>e.to_s, :instance=>object_id
+            $log.warn "secondary retry count exceededs limit."
+            $log.warn_backtrace e.backtrace
+            write_abort
+            @error_history.clear
+          end
+
+        else
+          $log.warn "failed to flush the buffer.", :error_class=>e.class.to_s, :error=>e.to_s, :instance=>object_id
+          $log.warn "retry count exceededs limit."
+          $log.warn_backtrace e.backtrace
+          write_abort
+          @error_history.clear
+        end
+
+        return @next_retry_time
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,29 @@
+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 {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/output_try_flush_interval_patch'
+require 'fluent/plugin/buf_lightening'
+
+class Test::Unit::TestCase
+end

data/test/plugin/dummy_output.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Fluent
+  class DummyBufferedOutput < BufferedOutput
+    Fluent::Plugin.register_output('lightening_test', self)
+
+    attr_reader :written
+
+    def start
+      super
+      @written = []
+    end
+
+    def format(tag, time, record)
+      [tag, time, record.merge({"format_time" => Time.now.to_f})].to_json + "\n"
+    end
+
+    def write(chunk)
+      chunk_lines = chunk.read.split("\n").select{|line| not line.empty?}
+      @written.push(* chunk.lines.map{ |line|
+          p line
+          tag, time, record = JSON.parse(line)
+          record.update({"write_time" => Time.now.to_f})
+        })
+      true
+    end
+  end
+end

data/test/plugin/test_buf_lightening.rb

@@ -0,0 +1,62 @@
+require 'helper'
+require_relative 'dummy_output'
+
+class DummyChain
+  def next
+  end
+end
+
+class LighteningBufferTest < Test::Unit::TestCase
+  CONFIG = %[
+    buffer_type lightening
+    flush_interval 0.1
+    try_flush_interval 0.03
+    buffer_chunk_records_limit 10
+]
+
+  def create_driver(conf=CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::DummyBufferedOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert d.instance # successfully configured
+    assert_equal 0.1,  d.instance.flush_interval
+    assert_equal 0.03, d.instance.try_flush_interval
+    assert_equal 10,   d.instance.instance_eval{ @buffer }.buffer_chunk_records_limit
+  end
+
+  def test_emit
+    d = create_driver
+    buffer = d.instance.instance_eval{ @buffer }
+    assert buffer
+    buffer.start
+
+    assert_nil buffer.instance_eval{ @map[''] }
+
+    d.emit({"a" => 1})
+    assert_equal 1, buffer.instance_eval{ @map[''] }.record_counter
+
+    d.emit({"a" => 2}); d.emit({"a" => 3}); d.emit({"a" => 4})
+    d.emit({"a" => 5}); d.emit({"a" => 6}); d.emit({"a" => 7});
+    d.emit({"a" => 8});
+    assert_equal 8, buffer.instance_eval{ @map[''] }.record_counter
+
+    chain = DummyChain.new
+    tag = d.instance.instance_eval{ @tag }
+    time = Time.now.to_i
+
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 9}), chain) # flush_trigger false
+    assert_equal 9, buffer.instance_eval{ @map[''] }.record_counter
+
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 10}), chain) # flush_trigger false
+    assert_equal 10, buffer.instance_eval{ @map[''] }.record_counter
+
+    assert buffer.emit(tag, d.instance.format(tag, time, {"a" => 11}), chain) # flush_trigger true
+    assert_equal 1, buffer.instance_eval{ @map[''] }.record_counter # new chunk
+
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 12}), chain) # flush_trigger false
+    assert_equal 2, buffer.instance_eval{ @map[''] }.record_counter
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-buffer-lightening
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Fluentd memory buffer plugin with many types of chunk limits
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-buffer-lightening.gemspec
+- lib/fluent/plugin/buf_lightening.rb
+- lib/fluent/plugin/output_try_flush_interval_patch.rb
+- test/helper.rb
+- test/plugin/dummy_output.rb
+- test/plugin/test_buf_lightening.rb
+homepage: https://github.com/tagomoris/fluent-plugin-buffer-lightening
+licenses:
+- APLv2
+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.3
+signing_key: 
+specification_version: 4
+summary: Alternative memory buffer plugin for Fluentd to realize less delay
+test_files:
+- test/helper.rb
+- test/plugin/dummy_output.rb
+- test/plugin/test_buf_lightening.rb
+has_rdoc: