fluent-plugin-amplifier-filter 0.1.0

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+# For TextMate, emacs, vim
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-amplifier.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,55 @@
+# fluent-plugin-amplifier-filter
+
+## Component
+
+### AmplifierFilterOutput
+
+Modify numeric values of specified fields, and Re-emit with modified tags. Useful for counting values of sampled data (by fluent-plugin-sampling-filter or etc).
+
+## Configuration
+
+### AmplifierFilterOutput
+
+To do x10 for messages 1/10 sampled, and to do x100 for messages 1/100 sampled:
+
+    <match sampled_10.**>
+      type amplifier_filter
+      ratio 10
+      remove_prefix sampled_10
+      key_names counts,rates
+    </match>
+    
+    <match sampled_100.**>
+      type amplifier_filter
+      ratio 100
+      remove_prefix sampled_100
+      key_names counts,rates
+    </match>
+    
+    <match logs.**>
+      # output configurations where to send original/modified messages...
+    </match>
+
+`key_pattern`(regexp) useful insted of `key_names`, and `add_prefix` is also useful:
+
+    <match sampled_10.**>
+      type amplifier_filter
+      ratio 10
+      remove_prefix sampled_10
+      add_prefix summary
+      key_pattern .*_(count|rate)$
+    </match>
+    
+    <match summary.**>
+      # output configurations where to send original/modified 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,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-amplifier-filter.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-amplifier-filter"
+  gem.version       = "0.1.0"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.summary       = %q{plugin to re-emit messages with amplified values}
+  gem.description   = %q{plugin to increase/decrease values by specified ratio (0-1 or 1-)}
+  gem.homepage      = "http://github.com/tagomoris/fluent-plugin-amplifier"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "fluentd"
+  gem.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_amplifier_filter.rb

@@ -0,0 +1,91 @@
+class Fluent::AmplifierFilterOutput < Fluent::Output
+  Fluent::Plugin.register_output('amplifier_filter', self)
+
+  config_param :ratio, :float
+
+  config_param :key_names, :string, :default => nil
+  config_param :key_pattern, :string, :default => nil
+
+  config_param :floor, :bool, :default => false
+
+  config_param :remove_prefix, :string, :default => nil
+  config_param :add_prefix, :string, :default => nil
+
+  def configure(conf)
+    super
+
+    if @key_names.nil? and @key_pattern.nil?
+      raise Fluent::ConfigError, "missing both of key_names and key_pattern"
+    end
+    if not @key_names.nil? and not @key_pattern.nil?
+      raise Fluent::ConfigError, "cannot specify both of key_names and key_pattern"
+    end
+    if @key_names
+      @key_names = @key_names.split(',')
+    end
+    if @key_pattern
+      @key_pattern = Regexp.new(@key_pattern)
+    end
+
+    amp = if @floor
+            method(:amp_with_floor)
+          else
+            method(:amp_without_floor)
+          end
+    (class << self; self; end).module_eval do
+      define_method(:amp, amp)
+    end    
+
+    if not @remove_prefix and not @add_prefix
+      raise Fluent::ConfigError, "missing both of remove_prefix and add_prefix"
+    end
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    if @add_prefix
+      @added_prefix_string = @add_prefix + '.'
+    end
+  end
+
+  def amp_without_floor(value)
+    value.to_f * @ratio
+  end
+
+  def amp_with_floor(value)
+    (value.to_f * @ratio).floor
+  end
+
+  def emit(tag, es, chain)
+    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 
+    if @add_prefix
+      tag = if tag and tag.length > 0
+              @added_prefix_string + tag
+            else
+              @add_prefix
+            end
+    end
+
+    if @key_names
+      es.each {|time,record|
+        @key_names.each {|key|
+          record[key] = amp(record[key]) if record[key]
+        }
+        Fluent::Engine.emit(tag, time, record)
+      }
+    else @key_pattern
+      es.each {|time,record|
+        record.keys.each {|key|
+          next unless record[key] and @key_pattern.match(key)
+          record[key] = amp(record[key])
+        }
+        Fluent::Engine.emit(tag, time, record)
+      }
+    end
+
+    chain.next
+  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/out_amplifier_filter'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_amplifier_filter.rb

@@ -0,0 +1,141 @@
+require 'helper'
+
+class AmplifierFilterOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  # config_param :ratio, :float
+  # config_param :key_names, :string, :default => nil
+  # config_param :key_pattern, :string, :default => nil
+  # config_param :floor, :bool, :default => false
+  # config_param :remove_prefix, :string, :default => nil
+  # config_param :add_prefix, :string, :default => nil
+
+  CONFIG = %[
+    ratio 1.5
+    key_names foo,bar,baz
+    remove_prefix test
+    add_prefix    modified
+  ]
+  CONFIG2 = %[
+    ratio 0.75
+    floor yes
+    key_pattern field.*
+    remove_prefix test
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::AmplifierFilterOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(%[
+        ratio 1
+      ])
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(%[
+        ratio 1
+        key_names field1
+      ])
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver(%[
+        ratio 1
+        add_prefix modified
+      ])
+    }
+    assert_nothing_thrown {
+      d = create_driver(%[
+        ratio 1
+        key_names field1
+        add_prefix modified
+      ])
+    }
+    assert_nothing_raised {
+      d = create_driver(%[
+        ratio 1
+        key_pattern field\d+
+        remove_prefix sampled
+      ])
+    }
+
+    d = create_driver
+    assert_equal false, d.instance.floor
+    assert_equal ['foo', 'bar', 'baz'], d.instance.key_names
+  end
+
+  def test_emit
+    # CONFIG = %[
+    #   ratio 1.5
+    #   key_names foo,bar,baz
+    #   remove_prefix test
+    #   add_prefix    modified
+    # ]
+    d1 = create_driver(CONFIG, 'test.service')
+    d1.run do
+      d1.emit({'name' => 'first',  'foo' => 10, 'bar' => 1, 'baz' => 20, 'zap' => 50})
+      d1.emit({'name' => 'second', 'foo' => 10, 'bar' => 2, 'baz' => 40, 'zap' => 50})
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+    assert_equal 'modified.service', emits[0][0] # tag
+
+    first = emits[0][2]
+    assert_equal 'first', first['name']
+    assert_equal 15     , first['foo']
+    assert_equal 1.5    , first['bar']
+    assert_equal 30     , first['baz']
+    assert_equal 50     , first['zap']
+
+    second = emits[1][2]
+    assert_equal 'second', second['name']
+    assert_equal 15      , second['foo']
+    assert_equal 3       , second['bar']
+    assert_equal 60      , second['baz']
+    assert_equal 50      , second['zap']
+
+    d2 = create_driver(CONFIG, 'test')
+    d2.run do
+      d2.emit({'name' => 'first',  'foo' => 10, 'bar' => 1, 'baz' => 20, 'zap' => 50})
+      d2.emit({'name' => 'second', 'foo' => 10, 'bar' => 2, 'baz' => 40, 'zap' => 50})
+    end
+    emits = d2.emits
+    assert_equal 2, emits.length
+    assert_equal 'modified', emits[0][0] # tag
+
+    # CONFIG2 = %[
+    #   ratio 0.75
+    #   floor yes
+    #   key_pattern field.*
+    #   remove_prefix test
+    # ]
+    d3 = create_driver(CONFIG2, 'test.service')
+    d3.run do
+      d3.emit({'name' => 'first',  'fieldfoo' => 10, 'fieldbar' => 1, 'fieldbaz' => 20, 'zap' => 50})
+      d3.emit({'name' => 'second', 'fieldfoo' => '10', 'fieldbar' => '2', 'fieldbaz' => '40', 'zap' => '50'})
+    end
+    emits = d3.emits
+    assert_equal 2, emits.length
+    assert_equal 'service', emits[0][0] # tag
+
+    first = emits[0][2]
+    assert_equal 'first', first['name']
+    assert_equal 7      , first['fieldfoo']
+    assert_equal 0      , first['fieldbar']
+    assert_equal 15     , first['fieldbaz']
+    assert_equal 50     , first['zap']
+
+    second = emits[1][2]
+    assert_equal 'second', second['name']
+    assert_equal 7       , second['fieldfoo']
+    assert_equal 1       , second['fieldbar']
+    assert_equal 30      , second['fieldbaz']
+    assert_equal '50'    , second['zap']
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-amplifier-filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: plugin to increase/decrease values by specified ratio (0-1 or 1-)
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-amplifier-filter.gemspec
+- lib/fluent/plugin/out_amplifier_filter.rb
+- test/helper.rb
+- test/plugin/test_out_amplifier_filter.rb
+homepage: http://github.com/tagomoris/fluent-plugin-amplifier
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: plugin to re-emit messages with amplified values
+test_files:
+- test/helper.rb
+- test/plugin/test_out_amplifier_filter.rb