fluent-plugin-sampling-filter 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/AUTHORS

@@ -0,0 +1 @@
+TAGOMORI Satoshi <tagomoris _at_ gmail.com>

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "simplecov", ">= 0"
+  gem "rdoc"
+end
+
+gem "fluentd"

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.rdoc

@@ -0,0 +1,50 @@
+= fluent-plugin-sampling-filter
+
+== Component
+
+=== SamplingFilterOutput
+
+Do sampling from matching messages to analyse and report messages behavior, and emit sampled messages with modified tag.
+
+- sampling rate per tags, or for all
+- remove_prefix of tags for input messages, and add_prefix of tags for output(sampled) messages
+
+== Configuration
+
+=== SamplingFilterOutput
+
+Pickup 1/10 messages about each tags(default: 'sample_unit tag'), and add tag prefix 'sampled'.
+
+    <match **>
+      type sampling_filter
+      interval 10
+      add_prefix sampled
+    </match>
+    
+    <match sampled.**>
+      # output configurations where to send sampled messages
+    </match>
+
+Pickup 1/100 messages of all matched messages, and modify tags from input.** to output.**
+
+    <match input.**>
+      type sampling_filter
+      interval 100
+      sample_unit all
+      remove_prefix input
+      add_prefix output
+    </match>
+    
+    <match sampled.**>
+      # output configurations where to send sampled messages
+    </match>
+
+== TODO
+
+- consider what to do next
+- patches welcome!
+
+== Copyright
+
+Copyright:: Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+License::   Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fluent-plugin-sampling-filter"
+  gem.homepage = "http://github.com/tagomoris/fluent-plugin-sampling-filter"
+  # gem.license = "MIT"
+  gem.summary = %Q{fluentd plugin to pickup sample data from matched massages}
+  gem.description = %Q{fluentd plugin to pickup sample data from matched massages}
+  gem.email = "tagomoris@gmail.com"
+  gem.authors = ["TAGOMORI Satoshi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fluent-plugin-sampling-filter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/fluent/plugin/out_sampling_filter.rb

@@ -0,0 +1,64 @@
+class Fluent::SamplingFilterOutput < Fluent::Output
+  Fluent::Plugin.register_output('sampling_filter', self)
+
+  config_param :interval, :integer
+  config_param :sample_unit, :string, :default => 'tag'
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix, :string, :default => 'sampled'
+
+  def configure(conf)
+    super
+
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    @added_prefix_string = @add_prefix + '.'
+
+    @sample_unit = case @sample_unit
+                   when 'tag'
+                     :tag
+                   when 'all'
+                     :all
+                   else
+                     raise Fluent::ConfigError, "sample_unit allows only 'tag' or 'all'"
+                   end
+    @counts = {}
+  end
+
+  def emit_sampled(tag, time_record_pairs)
+    if @remove_prefix and
+        ( (tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
+      tag = tag[@removed_length..-1]
+    end
+    tag = if tag.length > 0
+            @added_prefix_string + tag
+          else
+            @add_prefix
+          end
+
+    time_record_pairs.each {|t,r|
+      Fluent::Engine.emit(tag, t, r)
+    }
+  end
+
+  def emit(tag, es, chain)
+    t = if @sample_unit == :all
+          'all'
+        else
+          tag
+        end
+    @counts[t] ||= 0
+    pairs = []
+    es.each {|time,record|
+      @counts[t] += 1
+      if @counts[t] == @interval
+        pairs.push [time, record]
+        @counts[t] = 0
+      end
+    }
+    emit_sampled(tag, pairs)
+
+    chain.next
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+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'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'fluent/plugin/out_sampling_filter'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_sampling_filter.rb

@@ -0,0 +1,100 @@
+require 'helper'
+
+class SamplingFilterOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+  
+  CONFIG = %[
+    interval 10
+    sample_unit tag
+    remove_prefix input
+    add_prefix sampled
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::SamplingFilterOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    d = create_driver %[
+      interval 5
+    ]
+
+    assert_equal 5, d.instance.interval
+    assert_equal :tag, d.instance.sample_unit
+    assert_nil d.instance.remove_prefix
+    assert_equal 'sampled', d.instance.add_prefix
+
+    d = create_driver %[
+      interval 1000
+      sample_unit all
+      remove_prefix test
+      add_prefix output      
+    ]
+    assert_equal 1000, d.instance.interval
+    assert_equal :all, d.instance.sample_unit
+    assert_equal 'test', d.instance.remove_prefix
+    assert_equal 'output', d.instance.add_prefix
+  end
+
+  # CONFIG = %[
+  #   interval 10
+  #   sample_unit tag
+  #   remove_prefix input
+  #   add_prefix sampled
+  # ]
+  def test_emit
+    d1 = create_driver(CONFIG, 'input.hoge1')
+    time = Time.parse("2012-01-02 13:14:15").to_i
+    d1.run do
+      d1.emit({'field1' => 'record1', 'field2' => 1})
+      d1.emit({'field1' => 'record2', 'field2' => 2})
+      d1.emit({'field1' => 'record3', 'field2' => 3})
+      d1.emit({'field1' => 'record4', 'field2' => 4})
+      d1.emit({'field1' => 'record5', 'field2' => 5})
+      d1.emit({'field1' => 'record6', 'field2' => 6})
+      d1.emit({'field1' => 'record7', 'field2' => 7})
+      d1.emit({'field1' => 'record8', 'field2' => 8})
+      d1.emit({'field1' => 'record9', 'field2' => 9})
+      d1.emit({'field1' => 'record10', 'field2' => 10})
+      d1.emit({'field1' => 'record11', 'field2' => 11})
+      d1.emit({'field1' => 'record12', 'field2' => 12})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'sampled.hoge1', emits[0][0] # tag
+    assert_equal 'record10', emits[0][2]['field1']
+    assert_equal 10, emits[0][2]['field2']
+
+    d2 = create_driver(%[
+      interval 3
+    ], 'input.hoge2')
+    time = Time.parse("2012-01-02 13:14:15").to_i
+    d2.run do
+      d2.emit({'field1' => 'record1', 'field2' => 1})
+      d2.emit({'field1' => 'record2', 'field2' => 2})
+      d2.emit({'field1' => 'record3', 'field2' => 3})
+      d2.emit({'field1' => 'record4', 'field2' => 4})
+      d2.emit({'field1' => 'record5', 'field2' => 5})
+      d2.emit({'field1' => 'record6', 'field2' => 6})
+      d2.emit({'field1' => 'record7', 'field2' => 7})
+      d2.emit({'field1' => 'record8', 'field2' => 8})
+      d2.emit({'field1' => 'record9', 'field2' => 9})
+      d2.emit({'field1' => 'record10', 'field2' => 10})
+      d2.emit({'field1' => 'record11', 'field2' => 11})
+      d2.emit({'field1' => 'record12', 'field2' => 12})
+    end
+    emits = d2.emits
+    assert_equal 4, emits.length
+    assert_equal 'sampled.input.hoge2', emits[0][0] # tag
+
+    assert_equal 'record3', emits[0][2]['field1']
+    assert_equal 'record6', emits[1][2]['field1']
+    assert_equal 'record9', emits[2][2]['field1']
+    assert_equal 'record12', emits[3][2]['field1']
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-sampling-filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &2154789280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154789280
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2154788800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154788800
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2154788320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2154788320
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2154787840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2154787840
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2154787360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154787360
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2154786880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154786880
+description: fluentd plugin to pickup sample data from matched massages
+email: tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- AUTHORS
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fluent/plugin/out_sampling_filter.rb
+- test/helper.rb
+- test/plugin/test_out_sampling_filter.rb
+homepage: http://github.com/tagomoris/fluent-plugin-sampling-filter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3531476844839040291
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: fluentd plugin to pickup sample data from matched massages
+test_files: []