fluent-plugin-buffer-pullpool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a042d29887fdbb84c7c15b72c91a02b507118c8
+  data.tar.gz: 591e5419b7a7d8330c95fe8549b17324cdb945ac
+SHA512:
+  metadata.gz: 7dcfad83e69f51b2e4cd5fd5c9f3df6f8d80a5de8de63e9464f248fa7bb20ef50aac7ad4c8f948ec351e1e5603a51278268eb3b836ad9cfc229da4dd36b066c2
+  data.tar.gz: d1f869cd4a019dae6ff0e3663003efed963d2fe0db392992927c424d298ab33fe9b0b7082578802d30eb75de14f69e6cd52f75c9dade11be7e14cb2d4c3ac739

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TAGOMORI Satoshi
+
+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,36 @@
+# fluent-plugin-buffer-pullpool
+
+[Fluentd](http://fluentd.org) file buffer plugin to store events until output plugin's pull actions.
+
+**NOTICE:** PullPool buffer plugin works just as same as normal file buffer plugin for normal buffered/time-sliced output plugins. Use this plugin with output plugins written to use this plugin.
+
+## Installation
+
+Do `gem install fluent-plugin-buffer-pullpool` or `fluent-gem ...`.
+
+## Configuration
+
+PullPool buffer plugin has options just same with File buffer plugin. `buffer_path` option must be specified.
+
+```
+<match data.**>
+  type buffered_plugin_to_use_pullpool
+  
+  buffer_type pullpool
+  buffer_path /home/myuser/tmp/pullbuffer
+  buffer_chunk_limit 256M
+  buffer_queue_limit 256
+</match>
+```
+
+Specifing short time for `flush_interval` makes a lot of chunk files.
+
+## TODO
+
+* patches welcome!
+
+## Copyright
+
+* Copyright (c) 2014- 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-pullpool.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-buffer-pullpool"
+  spec.version       = "0.0.1"
+  spec.authors       = ["TAGOMORI Satoshi"]
+  spec.email         = ["tagomoris@gmail.com"]
+  spec.summary       = %q{Fluentd file buffer plugin to buffer data for pullers}
+  spec.description   = %q{Alternative file buffer plugin to store data to wait to be pulled by plugin}
+  spec.homepage      = "https://github.com/tagomoris/fluent-plugin-buffer-pullpool"
+  spec.license       = "APLv2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/buf_pullpool.rb

@@ -0,0 +1,108 @@
+require 'fluent/plugin/buf_file'
+
+module Fluent
+  class PullBufferChunk < FileBufferChunk
+    attr_accessor :flushed
+
+    def initialize(key, path, unique_id, mode="a+", symlink_path = nil)
+      super
+      @flushed = false
+    end
+
+    def purge
+      # do not anything if not flushed yet: call actual_purge explicitly.
+      if @flushed
+        actual_purge
+      end
+    end
+
+    def actual_purge
+      @file.close
+      File.unlink(@path) rescue nil # TODO: check @path exists or not, and remove-or-rename if exists
+    end
+  end
+
+  class PullPoolBuffer < FileBuffer
+    Plugin.register_buffer('pullpool', self)
+
+    def initialize
+      super
+      @mutex = Mutex.new
+      @pool = []
+    end
+
+    def write_chunk(chunk, out)
+      if out.respond_to?(:write) # for normal BufferedOutput plugins: works just same as FileBuffer
+        out.write(chunk)
+        chunk.flushed = true
+      else
+        @pool.push(chunk)
+      end
+    end
+
+    def pull_chunks
+      raise "BUG: block not given" unless block_given?
+      chunks = nil
+      @mutex.synchronize do
+        chunks = @pool
+        @pool = []
+      end
+      chunks.each do |chunk|
+        begin
+          yield chunk
+          chunk.actual_purge
+        rescue => e
+          # TODO: Chunks should be returned to @pool ?
+          #       It may make infinite error loops. Hmmm....
+        end
+      end
+    end
+
+    def new_chunk(key) # copy&paste from FileBuffer, but s/FileBufferChunk/PullBufferChunk/
+      encoded_key = encode_key(key)
+      path, tsuffix = make_path(encoded_key, "b")
+      unique_id = tsuffix_to_unique_id(tsuffix)
+      PullBufferChunk.new(key, path, unique_id, "a+", @symlink_path)
+    end
+
+    def resume # copy&paste from FileBuffer, but s/FileBufferChunk/PullBufferChunk/
+      maps = []
+      queues = []
+
+      Dir.glob("#{@buffer_path_prefix}*#{@buffer_path_suffix}") {|path|
+        match = path[@buffer_path_prefix.length..-(@buffer_path_suffix.length+1)]
+        if m = PATH_MATCH.match(match)
+          key = decode_key(m[1])
+          bq = m[2]
+          tsuffix = m[3]
+          timestamp = m[3].to_i(16)
+          unique_id = tsuffix_to_unique_id(tsuffix)
+
+          if bq == 'b'
+            chunk = PullBufferChunk.new(key, path, unique_id, "a+")
+            maps << [timestamp, chunk]
+          elsif bq == 'q'
+            chunk = PullBufferChunk.new(key, path, unique_id, "r")
+            queues << [timestamp, chunk]
+          end
+        end
+      }
+
+      map = {}
+      maps.sort_by {|(timestamp,chunk)|
+        timestamp
+      }.each {|(timestamp,chunk)|
+        map[chunk.key] = chunk
+      }
+
+      queue = queues.sort_by {|(timestamp,chunk)|
+        timestamp
+      }.map {|(timestamp,chunk)|
+        chunk
+      }
+
+      return queue, map
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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/buf_pullpool'
+
+class Test::Unit::TestCase
+end

data/test/plugin/dummy_output.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module Fluent
+  class DummyBuffered1Output < BufferedOutput
+    Fluent::Plugin.register_output('pullpool_test1', 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?}
+      chunk_lines.each do |line|
+        tag, time, record = JSON.parse(line)
+        record.update({"write_time" => Time.now.to_f})
+        @written.push record
+      end
+    end
+  end
+
+  class DummyBuffered2Output < BufferedOutput
+    Fluent::Plugin.register_output('pullpool_test2', 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 execute_pull
+      @buffer.pull_chunks do |chunk|
+        chunk_lines = chunk.read.split("\n").select{|line| not line.empty?}
+        chunk_lines.each do |line|
+          tag, time, record = JSON.parse(line)
+          record.update({"write_time" => Time.now.to_f})
+          @written.push record
+        end
+      end
+    end
+  end
+end

data/test/plugin/test_buf_pullpool.rb

@@ -0,0 +1,106 @@
+require 'helper'
+require_relative 'dummy_output'
+
+class DummyChain
+  def next
+  end
+end
+
+class PullPoolBufferTest < Test::Unit::TestCase
+  CONFIG = %[
+    buffer_type pullpool
+    buffer_path /tmp/pullpooltest
+    flush_interval 1s
+  ]
+
+  def create_driver1(conf=CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::DummyBuffered1Output, tag).configure(conf)
+  end
+
+  def create_driver2(conf=CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::DummyBuffered2Output, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver1
+    assert d.instance # successfully configured
+
+    d = create_driver2
+    assert d.instance # successfully configured
+  end
+
+  def test_emit1
+    d = create_driver1
+    buffer = d.instance.instance_eval{ @buffer }
+    assert buffer
+    d.instance.start
+
+    chain = DummyChain.new
+    tag = d.instance.instance_eval{ @tag }
+    time = Time.now.to_i
+
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 1}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 2}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 3}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 4}), chain)
+
+    d.instance.instance_eval{ @next_flush_time = Time.now.to_i - 30 }
+    d.instance.try_flush
+
+    assert_equal 4, d.instance.written.size
+  end
+
+
+  def test_emit2
+    d = create_driver2
+    buffer = d.instance.instance_eval{ @buffer }
+    assert buffer
+    d.instance.start
+
+    chain = DummyChain.new
+    tag = d.instance.instance_eval{ @tag }
+    time = Time.now.to_i
+
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 1}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 2}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 3}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 4}), chain)
+
+    d.instance.instance_eval{ @next_flush_time = Time.now.to_i - 30 }
+    d.instance.try_flush
+
+    assert_equal 0, d.instance.written.size
+
+    d.instance.execute_pull
+    assert_equal 4, d.instance.written.size
+
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 5}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 6}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 7}), chain)
+
+    d.instance.instance_eval{ @next_flush_time = Time.now.to_i - 30 }
+    d.instance.try_flush
+
+    assert_equal 4, d.instance.written.size
+
+    d.instance.execute_pull
+    assert_equal 7, d.instance.written.size
+
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 8}), chain)
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 9}), chain)
+
+    d.instance.instance_eval{ @next_flush_time = Time.now.to_i - 30 }
+    d.instance.try_flush
+
+    buffer.emit(tag, d.instance.format(tag, time, {"a" => 10}), chain)
+
+    d.instance.instance_eval{ @next_flush_time = Time.now.to_i - 30 }
+    d.instance.try_flush
+
+    assert_equal 7, d.instance.written.size
+
+    d.instance.execute_pull
+    assert_equal 10, d.instance.written.size
+
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-buffer-pullpool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Alternative file buffer plugin to store data to wait to be pulled by
+  plugin
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-buffer-pullpool.gemspec
+- lib/fluent/plugin/buf_pullpool.rb
+- test/helper.rb
+- test/plugin/dummy_output.rb
+- test/plugin/test_buf_pullpool.rb
+homepage: https://github.com/tagomoris/fluent-plugin-buffer-pullpool
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Fluentd file buffer plugin to buffer data for pullers
+test_files:
+- test/helper.rb
+- test/plugin/dummy_output.rb
+- test/plugin/test_buf_pullpool.rb
+has_rdoc: