fluent-plugin-datacalculator 0.0.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+# For TextMate, emacs, vim
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fluent-plugin-datacounter.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.rdoc

@@ -0,0 +1,52 @@
+= fluent-plugin-datacalculator
+
+== Component
+
+=== DataCalculateOutput
+
+Simple Calculate messages and summarize the calculated results.
+
+- Summarize calculated results per min/hour/day 
+- Summarize calculated results per second (average every min/hour/day)
+- Use finalizer of summarized results (e.g. average)
+
+'input_tag_remove_prefix' option available if you want to remove tag prefix from output field names.
+
+== Configuration
+
+=== DataCalculateOutput
+
+    <match accesslog.**>
+      type datacalculate
+      unit minute
+      aggregate all
+      fomulas sum = amount * price, amounts = amount
+    </match>
+
+If you use finalizer, like this
+
+    <match accesslog.**>
+      type datacalculate
+      unit minute
+      aggregate all
+      fomulas sum = amount * price, amounts = amount
+      finalizer average = amounts > 0 ? 1.0 * sum / amounts : 0
+    </match>
+
+Finalizer uses the summarized output, so argv in finalizer must exist in left-hand side in fomulas.
+
+
+
+== TODO
+
+- multiple finalizer
+- patches welcome!
+
+== Thanks
+
+tagomoris's fluent-plugin-datacounter is AWESOME plugin! That's nice!
+
+== Copyright
+
+Copyright:: Copyright (c) 2012- Muddy Dixon
+License::   Apache License, Version 2.0

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 => :test
+

data/example.conf

@@ -0,0 +1,21 @@
+<source>
+  type forward
+</source>
+<match payment.**>
+  type copy
+	<store>
+		type stdout
+	</store>
+	<store>
+	  type datacalculate
+  	tag result
+  	count_interval 5s
+	  aggregate all
+    formulas sum = amount * price, cnt = 1, total = amount
+		finalizer ave = cnt > 0 ? 1.00 * sum / cnt : 0
+	</store>
+</match>
+
+<match result>
+  type stdout
+</match>

data/fluent-plugin-datacalculator.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-datacalculator"
+  s.version     = "0.0.0"
+  s.authors     = ["Muddy Dixon"]
+  s.email       = ["muddydixon@gmail.com"]
+  s.homepage    = "https://github.com/muddydixon/fluent-plugin-datacalculator"
+  s.summary     = %q{Output filter plugin to calculate messages that matches specified conditions}
+  s.description = %q{Output filter plugin to calculate messages that matches specified conditions}
+
+  s.rubyforge_project = "fluent-plugin-datacalculator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "fluentd"
+  s.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_datacalculator.rb

@@ -0,0 +1,244 @@
+class Fluent::DataCalculatorOutput < Fluent::Output
+  Fluent::Plugin.register_output('datacalculate', self)
+
+  config_param :count_interval, :time, :default => nil
+  config_param :unit, :string, :default => 'minute'
+  config_param :aggregate, :string, :default => 'tag'
+  config_param :tag, :string, :default => 'datacalculate'
+  config_param :input_tag_remove_prefix, :string, :default => nil
+  config_param :formulas, :string
+  config_param :finalizer, :string, :default => nil
+  config_param :outcast_unmatched, :bool, :default => false
+
+  attr_accessor :tick
+  attr_accessor :counts
+  attr_accessor :last_checked
+  attr_accessor :_formulas
+  attr_accessor :_finalizer
+
+  def configure(conf)
+    super
+
+    if @count_interval
+      @tick = @count_interval.to_i
+    else
+      @tick = case @unit
+              when 'minute' then 60
+              when 'hour' then 3600
+              when 'day' then 86400
+              else 
+                raise RuntimeError, "@unit must be one of minute/hour/day"
+              end
+    end
+
+    @aggregate = case @aggregate
+                 when 'tag' then :tag
+                 when 'all' then :all
+                 else
+                   raise Fluent::ConfigError, "flowcounter aggregate allows tag/all"
+                 end
+
+    def createFunc (cnt, str)
+      str.strip!
+      left, right = str.split(/\s*=\s*/, 2)
+      rights = right.scan(/[a-zA-Z][\w\d_\.\$]*/).uniq
+      
+      begin
+        f = eval('lambda {|'+rights.join(',')+'|  '+right + '}')
+      rescue SyntaxError
+        raise Fluent::ConfigError, "'" + str + "' is not valid"
+      end
+
+      [cnt, left, rights, f]
+    end
+
+    def execFunc (tag, obj, argv, formula)
+      if tag != nil
+        tag = stripped_tag (tag)
+      end
+      _argv = []
+      
+      argv.each {|arg|
+        if tag != nil and tag != 'all'
+          arg = tag + '_' + arg
+        end
+        _argv.push obj[arg]
+      }
+      formula.call(*_argv)
+    end
+
+    @_formulas = [[0, 'unmatched', nil, nil]]
+    if conf.has_key?('formulas')
+      fs = conf['formulas'].split(/\s*,\s*/)
+      fs.each_with_index { |str,i |
+        @_formulas.push( createFunc(i + 1, str) )
+      }
+    end
+
+    if conf.has_key?('finalizer')
+      @_finalizer = createFunc(0, conf['finalizer'])
+
+      # check finalizer field
+      cnt = @_finalizer[2].length
+      @_finalizer[2].each { |key|
+        @_formulas.each { |formula|
+          next if formula[2] == nil
+          cnt -= 1 if formula[1] == key
+        }
+      }
+      if cnt != 0
+        raise Fluent::ConfigError, 'keys in finalizer is not satisfied'
+      end
+    end
+
+    if @input_tag_remove_prefix
+      @removed_prefix_string = @input_tag_remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+
+    @counts = count_initialized
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    start_watch
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  def count_initialized(keys=nil)
+    # counts['tag'][num] = count
+    if @aggregate == :all
+      {'all' => ([0] * @_formulas.length)}
+    elsif keys
+      values = Array.new(keys.length) {|i|
+        Array.new(@_formulas.length){|j| 0 }
+      }
+      Hash[[keys, values].transpose]
+    else
+      {}
+    end
+  end
+
+  def countups(tag, counts)
+    if @aggregate == :all
+      tag = 'all'
+    end
+    
+    @mutex.synchronize {
+      @counts[tag] ||= [0] * @_formulas.length
+      counts.each_with_index do |count, i|
+        @counts[tag][i] += count
+      end
+    }
+  end
+
+  def stripped_tag(tag)
+    return tag unless @input_tag_remove_prefix
+    return tag[@removed_length..-1] if tag.start_with?(@removed_prefix_string) and tag.length > @removed_length
+    return tag[@removed_length..-1] if tag == @input_tag_remove_prefix
+    tag
+  end
+
+  def generate_output(counts, step)
+    output = {}
+    if @aggregate == :all
+      # index 0 is unmatched
+      sum = if @outcast_unmatched
+              counts['all'][1..-1].inject(:+)
+            else
+              counts['all'].inject(:+)
+            end
+      counts['all'].each_with_index do |count,i|
+        name = @_formulas[i][1]
+        output[name] = count
+      end
+
+      if @_finalizer
+        output[@_finalizer[1]] = execFunc('all', output, @_finalizer[2], @_finalizer[3])
+      end
+
+      return output
+    end
+
+    counts.keys.each do |tag|
+      t = stripped_tag(tag)
+      sum = if @outcast_unmatched
+              counts[tag][1..-1].inject(:+)
+            else
+              counts[tag].inject(:+)
+            end
+      counts[tag].each_with_index do |count,i|
+        name = @_formulas[i][1]
+        output[t + '_' + name] = count
+      end
+      if @_finalizer
+        output[t + '_' + @_finalizer[1]] = execFunc(tag, output, @_finalizer[2], @_finalizer[3])
+      end
+    end
+    output
+  end
+
+  def flush(step)
+    flushed,@counts = @counts,count_initialized(@counts.keys.dup)
+    generate_output(flushed, step)
+  end
+
+  def flush_emit(step)
+    Fluent::Engine.emit(@tag, Fluent::Engine.now, flush(step))
+  end
+
+  def start_watch
+    # for internal, or tests only
+    @watcher = Thread.new(&method(:watch))
+  end
+  
+  def watch
+    # instance variable, and public accessable, for test
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.5
+      if Fluent::Engine.now - @last_checked >= @tick
+        now = Fluent::Engine.now
+        flush_emit(now - @last_checked)
+        @last_checked = now
+      end
+    end
+  end
+
+  def checkArgs (obj, inkeys)
+    inkeys.each{ |key|
+      if not obj.has_key?(key)
+        return false
+      end
+    }
+    return true
+  end
+
+  def emit(tag, es, chain)
+    c = [0] * @_formulas.length
+
+    es.each do |time,record|
+      matched = false
+      if @_formulas.length > 0
+        @_formulas.each do |index, outkey, inkeys, formula|
+          next unless formula and checkArgs(record, inkeys)
+
+          c[index] += execFunc(nil, record, inkeys, formula)
+         matched = true
+        end
+      else
+        $log.warn index
+      end
+      c[0] += 1 unless matched
+    end
+    countups(tag, c)
+
+    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_datacalculator'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_datacalculator.rb

@@ -0,0 +1,172 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class DataCalculatorOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    unit minute
+    aggregate tag
+    input_tag_remove_prefix test
+    formulas sum = amount * price, amounts = amount, record = 1
+    finalizer ave = amounts > 0 ? 1.0 * sum / amounts : 0
+  ]
+
+  def create_driver(conf = CONFIG, tag='test.input')
+    Fluent::Test::OutputTestDriver.new(Fluent::DataCalculatorOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    # 式がSyntax Error
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        formulas sum = 10 ab
+      ]
+    }
+    # finalizerに必要な要素がない
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        finalizer ave = cnt > 0 ? sum / cnt : 0
+      ]
+    }
+    # finalizerに必要な要素がない
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver %[
+        formulas sum = 10
+        finalizer ave = cnt > 0 ? sum / cnt : 0
+      ]
+    }
+    d = create_driver %[
+      formulas sum = amount * price, cnt = amount
+      finalizer ave = cnt > 0 ? sum / cnt : 0
+    ]
+    assert_equal 60, d.instance.tick
+    assert_equal :tag, d.instance.aggregate
+    assert_equal 'datacalculate', d.instance.tag
+    assert_nil d.instance.input_tag_remove_prefix
+    assert_equal 'sum = amount * price, cnt = amount', d.instance.formulas
+    assert_equal 'ave = cnt > 0 ? sum / cnt : 0', d.instance.finalizer
+    assert_equal false, d.instance.outcast_unmatched
+
+  end
+
+  def test_count_initialized
+    d = create_driver %[
+      aggregate all
+      formulas sum = amount * price, cnt = amount
+    ]
+    assert_equal [0,0,0], d.instance.counts['all']
+  end
+
+  def test_create_formula
+    d = create_driver %[
+      aggregate all
+      formulas sum = amount * price, cnt = amount
+    ]
+    assert_equal 0, d.instance._formulas[0][0]
+    assert_equal 'unmatched', d.instance._formulas[0][1]
+    assert_equal nil, d.instance._formulas[0][2]
+    assert_equal 1, d.instance._formulas[1][0]
+    assert_equal 'sum', d.instance._formulas[1][1]
+    assert_equal ['amount', 'price'], d.instance._formulas[1][2]
+    assert_equal 2, d.instance._formulas[2][0]
+    assert_equal 'cnt', d.instance._formulas[2][1]
+    assert_equal ['amount'], d.instance._formulas[2][2]
+  end
+
+  def test_countups
+    d = create_driver
+    assert_nil d.instance.counts['test.input']
+    d.instance.countups('test.input', [0, 0, 0, 0])
+    assert_equal [0,0,0,0], d.instance.counts['test.input']
+    d.instance.countups('test.input', [1, 1, 1, 0])
+    assert_equal [1,1,1,0], d.instance.counts['test.input']
+    d.instance.countups('test.input', [0, 5, 1, 0])
+    assert_equal [1,6,2,0], d.instance.counts['test.input']
+  end
+
+  def test_stripped_tag
+    d = create_driver
+    assert_equal 'input', d.instance.stripped_tag('test.input')
+    assert_equal 'test.input', d.instance.stripped_tag('test.test.input')
+    assert_equal 'input', d.instance.stripped_tag('input')
+  end
+
+  def test_generate_output
+    d = create_driver
+    r1 = d.instance.generate_output({'test.input' => [60,240,120,180], 'test.input2' => [0,600,0,0]}, 60)
+
+    assert_equal   60, r1['input_unmatched']
+    assert_equal   240, r1['input_sum']
+    assert_equal   120, r1['input_amounts']
+    assert_equal   180, r1['input_record']
+    assert_equal   2, r1['input_ave']
+
+    assert_equal   0, r1['input2_unmatched']
+    assert_equal   600, r1['input2_sum']
+    assert_equal   0, r1['input2_amounts']
+    assert_equal   0, r1['input2_record']
+    assert_equal   0, r1['input2_ave']
+
+
+    d = create_driver %[
+      aggregate all
+      input_tag_remove_prefix test
+      formulas sum = amount * price, amounts = amount, record = 1
+      finalizer ave = amounts > 0 ? sum / amounts : 0
+    ]
+
+    r2 = d.instance.generate_output({'all' => [60,240,120,180]}, 60)
+    assert_equal   60, r2['unmatched']
+    assert_equal   240, r2['sum']
+    assert_equal   120, r2['amounts']
+    assert_equal   180, r2['record']
+    assert_equal   2, r2['ave']
+  end
+
+  def test_emit
+    d1 = create_driver(CONFIG, 'test.input')
+    d1.run do
+      60.times do
+        d1.emit({'amount' => 3, 'price' => 100})
+        d1.emit({'amount' => 3, 'price' => 200})
+        d1.emit({'amount' => 6, 'price' => 50})
+        d1.emit({'amount' => 10, 'price' => 100})
+      end
+    end
+    r1 = d1.instance.flush(60)
+    assert_equal 0, r1['input_unmatched']
+    assert_equal 132000, r1['input_sum']
+    assert_equal 1320, r1['input_amounts']
+    assert_equal 240, r1['input_record']
+    assert_equal 100.0, r1['input_ave']
+
+    d2 = create_driver(%[
+      unit minute
+      aggregate all
+      input_tag_remove_prefix test
+      formulas sum = amount * price, amounts = amount, record = 1
+      finalizer ave = amounts > 0 ? 1.0 * sum / amounts : 0
+    ], 'test.input2')
+
+    d2.run do
+      60.times do
+        d2.emit({'amount' => 3, 'price' => 100})
+        d2.emit({'amount' => 3, 'price' => 200})
+        d2.emit({'amount' => 6, 'price' => 50})
+        d2.emit({'amount' => 10, 'price' => 100})
+      end
+    end
+    r2 = d2.instance.flush(60)
+    assert_equal 0, r2['unmatched']
+    assert_equal 132000, r2['sum']
+    assert_equal 1320, r2['amounts']
+    assert_equal 240, r2['record']
+    assert_equal 100.0, r2['ave']
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-datacalculator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Muddy Dixon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-17 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: Output filter plugin to calculate messages that matches specified conditions
+email:
+- muddydixon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- example.conf
+- fluent-plugin-datacalculator.gemspec
+- lib/fluent/plugin/out_datacalculator.rb
+- test/helper.rb
+- test/plugin/test_out_datacalculator.rb
+homepage: https://github.com/muddydixon/fluent-plugin-datacalculator
+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: fluent-plugin-datacalculator
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Output filter plugin to calculate messages that matches specified conditions
+test_files:
+- test/helper.rb
+- test/plugin/test_out_datacalculator.rb