fluent-plugin-buffer-event_limited 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bde16a6ec9ee256c8eb1d8eff67a03f15857a67a
+  data.tar.gz: 93341c7a6f0b72d0003e907e31195a0e4703eddc
+SHA512:
+  metadata.gz: d83a6398da1b8e118cffbfb221802396d6da93b530176f526c59b64ce565d69c1975de6b52ba389d7d82707bdc060745c83a14a5f59a762d7907b7c486ad4dce
+  data.tar.gz: 71ee96f41c83236bac796a0184d4dae7a6a9d532ffaf42599a4f2378091ffef9cbf25751033523b0e220c1a9acdb211622670222c555c359c5d0b501cbaea3ad

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-buffer-limit_events.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,61 @@
+# fluent-plugin-buffer-event_limited
+
+[Fluentd](http://fluentd.org) 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.
+
+## Installation
+
+Do `gem install fluent-plugin-buffer-event_limited` or `fluent-gem ...`.
+
+## Configuration
+
+EventLimited 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 event_limited
+  buffer_chunk_records_limit 100
+  # other options...
+</match>
+```
+
+Options of `buffer_type file` are also available:
+```
+<match data.**>
+  type any_buffered_output_plugin
+  buffer_type event_limited
+  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 on Fluentd v0.10.42 or later:
+```
+<match data.**>
+  type any_buffered_output_plugin
+  buffer_type event_limited
+  buffer_chunk_records_limit 100
+  # other options...
+  flush_interval 0.5
+  try_flush_interval 0.1 # 0.6sec delay for worst case
+</match>
+```
+
+## TODO
+
+* 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-event_limited.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-buffer-event_limited"
+  spec.version       = "0.1.0"
+  spec.authors       = ["TAGOMORI Satoshi", 'Gergo Sulymosi']
+  spec.email         = ["tagomoris@gmail.com", 'gergo.sulymosi@gmail.com']
+  spec.description   = %q{Fluentd memory buffer plugin with many types of chunk limits}
+  spec.summary       = %q{Alternative file buffer plugin for Fluentd to realize less delay}
+  spec.homepage      = "https://github.com/trekdemo/fluent-plugin-buffer-event_limited"
+  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_development_dependency "test-unit"
+  spec.add_runtime_dependency "fluentd", ">= 0.10.42"
+end

data/lib/fluent/plugin/buf_event_limited.rb

@@ -0,0 +1,36 @@
+require 'fluent/plugin/buf_file'
+
+module Fluent
+  class EventLimitedBufferChunk < FileBufferChunk
+    attr_reader :record_counter
+
+    def initialize(key, path, unique_id, mode = "a+", symlink_path = nil)
+      super
+      @record_counter = 0
+    end
+
+    def <<(data)
+      super
+      @record_counter += 1
+    end
+  end
+
+  class EventLimitedFileBuffer < FileBuffer
+    Fluent::Plugin.register_buffer('event_limited', self)
+
+    config_param :buffer_chunk_records_limit, :integer, :default => Float::INFINITY
+
+    def new_chunk(key)
+      encoded_key = encode_key(key)
+      path, tsuffix = make_path(encoded_key, 'b')
+      unique_id = tsuffix_to_unique_id(tsuffix)
+
+      EventLimitedBufferChunk.new(key, path, unique_id, 'a+', @symlink_path)
+    end
+
+    def storable?(chunk, data)
+      chunk.record_counter < @buffer_chunk_records_limit &&
+        (chunk.size + data.bytesize) <= @buffer_chunk_limit
+    end
+  end
+end

data/test/plugin/dummy_chain.rb

@@ -0,0 +1,4 @@
+class DummyChain
+  def next
+  end
+end

data/test/plugin/test_buf_event_limited.rb

@@ -0,0 +1,78 @@
+require_relative '../test_helper'
+require_relative 'test_event_recorder_buffered_output'
+require_relative 'dummy_chain'
+
+class EventLimitedFileBufferTest < Test::Unit::TestCase
+  def setup
+    @buffer = Tempfile.new('event-limited-file-buffer')
+  end
+
+  def teardown
+    @buffer.close
+    @buffer.unlink
+  end
+
+  def default_config
+    %[
+      buffer_type event_limited
+      flush_interval 0.1
+      try_flush_interval 0.03
+      buffer_chunk_records_limit 10
+      buffer_path #{@buffer.path}
+    ]
+  end
+
+  def create_driver(conf = default_config, tag = 'test')
+    Fluent::Test::OutputTestDriver
+      .new(Fluent::TestEventRecorderBufferedOutput, tag)
+      .configure(conf)
+  end
+
+  def test_plugin_configuration
+    output = create_driver.instance
+    buffer = output.instance_variable_get(:@buffer)
+
+    assert output # successfully configured
+    assert_equal 0.1,  output.flush_interval
+    assert_equal 0.03, output.try_flush_interval
+    assert_equal 10,   buffer.buffer_chunk_records_limit
+  end
+
+  def test_emit
+    d = create_driver
+
+    buffer = d.instance.instance_variable_get(:@buffer)
+    assert buffer
+    buffer.start
+
+    assert_nil buffer.instance_variable_get(:@map)['']
+
+    d.emit({"a" => 1})
+    assert_equal 1, buffer.instance_variable_get(:@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_variable_get(:@map)[''].record_counter
+
+    chain = DummyChain.new
+    tag = d.instance.instance_variable_get(:@tag)
+    time = Time.now.to_i
+
+    # flush_trigger false
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 9}), chain)
+    assert_equal 9, buffer.instance_variable_get(:@map)[''].record_counter
+
+    # flush_trigger false
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 10}), chain)
+    assert_equal 10, buffer.instance_variable_get(:@map)[''].record_counter
+
+    # flush_trigger true
+    assert buffer.emit(tag, d.instance.format(tag, time, {"a" => 11}), chain)
+    assert_equal 1, buffer.instance_variable_get(:@map)[''].record_counter # new chunk
+
+    # flush_trigger false
+    assert !buffer.emit(tag, d.instance.format(tag, time, {"a" => 12}), chain)
+    assert_equal 2, buffer.instance_variable_get(:@map)[''].record_counter
+  end
+end

data/test/plugin/test_event_recorder_buffered_output.rb

@@ -0,0 +1,24 @@
+module Fluent
+  class TestEventRecorderBufferedOutput < BufferedOutput
+    Fluent::Plugin.register_output('test_event_recorder', 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_msgpack
+    end
+
+    def write(chunk)
+      chunk.msgpack_each do |(tag, time, record)|
+        @written.push([tag, time, record.merge({'write_time' => Time.now.to_f})])
+      end
+
+      true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'test/unit'
+
+unless ENV.has_key?('VERBOSE')
+  class NullLogger
+    def method_missing(method, *args); end
+  end
+  $log = NullLogger.new
+end
+
+require 'fluent/test'
+require 'fluent/plugin/buf_event_limited'
+Fluent::Test.setup

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-buffer-event_limited
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+- Gergo Sulymosi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 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: test-unit
+  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.10.42
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.42
+description: Fluentd memory buffer plugin with many types of chunk limits
+email:
+- tagomoris@gmail.com
+- gergo.sulymosi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-buffer-event_limited.gemspec
+- lib/fluent/plugin/buf_event_limited.rb
+- test/plugin/dummy_chain.rb
+- test/plugin/test_buf_event_limited.rb
+- test/plugin/test_event_recorder_buffered_output.rb
+- test/test_helper.rb
+homepage: https://github.com/trekdemo/fluent-plugin-buffer-event_limited
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Alternative file buffer plugin for Fluentd to realize less delay
+test_files:
+- test/plugin/dummy_chain.rb
+- test/plugin/test_buf_event_limited.rb
+- test/plugin/test_event_recorder_buffered_output.rb
+- test/test_helper.rb