fluent-plugin-combiner 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjI2MTFmNDQxOTgxNjNjZDg2ZTZmNGNiMzljYzhjNTZlNDU2MmExOQ==
+  data.tar.gz: !binary |-
+    ZGYzZWU1NjExZjAyYTlhZTIyNzVlZWVmOWZkZjU1NmFhNDlkYWY3Mg==
+SHA512:
+  metadata.gz: !binary |-
+    ZGU5NjM4N2NhZjBmNTdiODFhYzhjZjgxZmRjY2E4YWY3YmE5YzNkMzVmYjc1
+    NjhjMjJkOWQ2MTc2Yzc1OTRjY2NkZDQxYzdhMWQzMmE0N2ZhMjIwNzdkNTRk
+    YjI0NzZkNDhhNDdhYTcwY2Q2MWMxMTIwYmE2ZDNmNGI1YjE3Mjk=
+  data.tar.gz: !binary |-
+    MzM2ZjQ5ZWY5ZGViMjAxY2M0NGY3ZjM2ZWYwOGIzY2U1OTE1ZTk0ZTMyYmM1
+    MmVkNGQxMGQ5YjEzYThkNDBhOTBmNDRjMzMwOWM2MjBhOWQyODc4YTc2OTE5
+    YzQwNmY4MjUzY2E5OTI0MGJlNDYyMTdjNTU3ZGMwMGFhOWJkYTM=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 karahiyo
+
+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,27 @@
+# fluent-plugin-combiner
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-combiner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-combiner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,11 @@
+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 => true
+

data/fluent-plugin-combiner.gemspec

@@ -0,0 +1,25 @@
+# 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-combiner"
+  spec.version       = "0.0.1"
+  spec.authors       = ["karahiyo"]
+  spec.email         = ["a.ryuklnm@gmail.com"]
+  spec.summary       = "Combine buffer output data to cut-down net-i/o load"
+  spec.description   = "Combine buffer output data to cut-down net-i/o load"
+  spec.homepage      = "https://github.com/karahiyo/fluent-plugin-combiner"
+
+  spec.rubyforge_project = "fluent-plugin-combiner"
+
+  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/out_combiner.rb

@@ -0,0 +1,144 @@
+module Fluent
+  class CombinerOutput < Fluent::Output
+    Fluent::Plugin.register_output('combiner', self)
+
+    # config_param :hoge, :string, :default => 'hoge'
+    config_param :tag, :string, :default => 'combined'
+    config_param :tag_prefix, :string, :default => nil
+    config_param :input_tag_remove_prefix, :string, :default => nil
+    config_param :count_interval, :time, :default => 60
+    config_param :count_key, :string, :default => 'keys'
+
+    attr_accessor :hist
+    attr_accessor :tick, :last_checked
+
+    def initialize
+      super
+      require 'pathname'
+    end
+
+    def configure(conf)
+      super
+
+      @tick = @count_interval.to_i if @count_interval
+      @tag_prefix_string = @tag_prefix ? @tag_prefix + '.' : @tag + '.'
+      if @input_tag_remove_prefix
+        @remove_prefix_string = @input_tag_remove_prefix + '.' 
+        @remove_prefix_length = @remove_prefix_string.length
+      end
+
+      @hist = initialize_hist
+    end
+
+    ## Fluent::Output main methods
+    def start
+      super
+      start_watch
+    end
+
+    def shutdown
+      super
+      @watcher.terminate
+      @watcher.join
+    end
+
+    def flush
+      flushed, @hist = @hist, initialize_hist(@hist.keys.dup)
+      generate_output(flushed)
+    end
+
+    def flush_emit
+      flushed = flush
+      Fluent::Engine.emit(@tag,  Fluent::Engine.now,  flushed)
+    end
+
+    def generate_output(data)
+      output = {}
+      data.each do |tag, hist|
+        output[add_prefix(stripped_tag(tag))] = hist
+      end
+      output
+    end
+
+    def emit(tag, es, chain)
+
+      es.each do |time, record|
+        keys = record[@count_key]
+        countup(tag, keys)
+      end
+
+      chain.next
+    end
+
+
+    ## Combiner's main methods
+    def initialize_hist(tags=nil)
+      hist = {}
+      if tags
+        tags.each do |tag|
+          hist[tag] = {:hist => {}, :sum => 0, :len => 0}
+        end
+      end
+      hist
+    end
+
+
+    def increment(tag, key)
+      @hist[tag] ||= {:hist => {}, :sum => 0, :len => 0}
+      if @hist[tag][:hist].key? key
+        @hist[tag][:hist][key] += 1
+        @hist[tag][:sum] += 1
+      else
+        @hist[tag][:hist][key] = 1
+        @hist[tag][:sum] += 1
+        @hist[tag][:len] += 1
+      end
+      @hist
+    end
+
+    def countup(tag, keys)
+      if keys.is_a?(Array) 
+        keys.each {|k| increment(tag, k)}
+      elsif keys.is_a?(String)
+        increment(tag, keys)
+      end
+    end
+
+    def clear
+      @hist = initialize_hist(@hist.keys.dup)
+    end
+
+    ## Utils
+    def add_prefix(tag="")
+      return @tag_prefix if tag.empty?
+      return @tag_prefix_string + tag
+    end
+
+    def stripped_tag(tag)
+      return tag unless @input_tag_remove_prefix
+      return tag[@remove_prefix_length..-1] if tag.start_with?(@remove_prefix_string) && tag.length > @remove_prefix_length
+      return "" if tag == @input_tag_remove_prefix
+      return tag
+    end
+
+    private
+
+    ## watcher
+    def start_watch
+      @watcher = Thread.new(&method(:watch))
+    end
+
+    def watch
+      @last_checked = Fluent::Engine.now
+      while true
+        sleep 0.5
+        if Fluent::Engine.now - @last_checked >= @tick
+          now = Fluent::Engine.now
+          flush_emit
+          @last_checked = now
+        end
+      end
+    end
+
+  end 
+end

data/test/helper.rb

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

data/test/plugin/test_out_combiner.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class CombinerOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    count_key keys
+    count_interval 5s
+    tag_prefix combined
+    input_tag_remove_prefix test.input
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::CombinerOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 5, d.instance.tick
+    assert_equal 'combined', d.instance.tag
+    assert_equal 'keys', d.instance.count_key
+    assert_equal 'combined', d.instance.tag_prefix
+    assert_equal 'test.input', d.instance.input_tag_remove_prefix
+  end
+
+  def test_increment
+    f = create_driver
+    f.instance.increment("test.input", 'a')
+    expected = f.instance.flush
+    assert_equal({"combined" => {:hist => {"a" => 1}, :sum => 1, :len => 1}}, expected)
+    expected = f.instance.flush
+    assert_equal({"combined" => {:hist => {}, :sum => 0, :len => 0}}, expected)
+  end
+
+  def test_emit
+    f = create_driver
+    f.run do
+      60.times do
+        f.emit({"keys" => ["A", "B", "C"]})
+      end
+    end
+    out = f.instance.flush
+    assert_equal({"combined.test" => {:hist => {"A" => 60, "B" => 60, "C" => 60}, 
+                  :sum => 180, :len => 3}}, out)
+  end
+
+  def test_clear
+    f = create_driver
+    assert_equal({}, f.instance.hist)
+    f.instance.increment("test.input", 'A')
+    f.instance.clear
+    assert_equal({"combined" => {:hist => {}, :sum => 0, :len => 0}}, f.instance.flush)
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-combiner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- karahiyo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-16 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: Combine buffer output data to cut-down net-i/o load
+email:
+- a.ryuklnm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-combiner.gemspec
+- lib/fluent/plugin/out_combiner.rb
+- test/helper.rb
+- test/plugin/test_out_combiner.rb
+homepage: https://github.com/karahiyo/fluent-plugin-combiner
+licenses: []
+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: fluent-plugin-combiner
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Combine buffer output data to cut-down net-i/o load
+test_files:
+- test/helper.rb
+- test/plugin/test_out_combiner.rb