fluent-plugin-numeric-monitor 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-numeric-aggregator.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,39 @@
+# fluent-plugin-numeric-monitor
+
+## Component
+
+### NumericMonitorOutput
+
+Plugin to calculate min/max/avg and specified percentile values, which used in notifications (such as fluent-plugin-notifier)
+
+## Configuration
+
+### NumericMonitorOutput
+
+To calculate about HTTP requests duration (microseconds) in 'duraion', with 90 and 95 percentile values:
+
+    <match apache.log.**>
+      type numeric_monitor
+      unit minute
+      tag monitor.duration
+      aggregate all
+      input_tag_remove_prefix apache.log
+      monitor_key duration
+      percentiles 90,95
+    </match>
+
+Output messages like:
+
+    {"min":3012,"max":913243,"avg":100123.51,"percentile_90":154390,"percentile_95":223110}
+
+## TODO
+
+* more tests
+* more documents
+
+## Copyright
+
+* Copyright
+  * Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+* 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/fluent-plugin-numeric-monitor.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-numeric-monitor"
+  gem.version       = "0.0.1"
+  gem.authors       = ["TAGOMORI Satoshi"]
+  gem.email         = ["tagomoris@gmail.com"]
+  gem.description   = %q{Fluentd plugin to calculate min/max/avg/Xpercentile values, and emit these data as message}
+  gem.summary       = %q{Fluentd plugin to calculate min/max/avg/Xpercentile values}
+  gem.homepage      = "https://github.com/tagomoris/fluent-plugin-numeric-monitor"
+
+  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_numeric_monitor.rb

@@ -0,0 +1,218 @@
+class Fluent::NumericMonitorOutput < Fluent::Output
+  Fluent::Plugin.register_output('numeric_monitor', self)
+
+  EMIT_STREAM_RECORDS = 100
+
+  config_param :count_interval, :time, :default => 60
+  config_param :unit, :string, :default => nil
+  config_param :tag, :string, :default => 'monitor'
+
+  config_param :aggregate, :default => 'tag' do |val|
+    case val
+    when 'tag' then :tag
+    when 'all' then :all
+    else
+      raise Fluent::ConfigError, "aggregate MUST be one of 'tag' or 'all'"
+    end
+  end
+  config_param :input_tag_remove_prefix, :string, :default => nil
+  config_param :monitor_key, :string
+  config_param :percentiles, :default => nil do |val|
+    values = val.split(",").map(&:to_i)
+    if values.select{|i| i < 1 or i > 99 }.size > 0
+      raise Fluent::ConfigError, "percentiles MUST be specified between 1 and 99 by integer"
+    end
+    values
+  end
+
+  config_param :samples_limit, :integer, :default => 1000000
+
+  attr_accessor :count, :last_checked
+
+  def configure(conf)
+    super
+
+    if @unit
+      @count_interval = case @unit
+                        when 'minute' then 60
+                        when 'hour' then 3600
+                        when 'day' then 86400
+                        else
+                          raise Fluent::ConfigError, "unit must be one of minute/hour/day"
+                        end
+    end
+
+    if @input_tag_remove_prefix
+      @removed_prefix_string = @input_tag_remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    
+    @count = count_initialized
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    start_watch
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  def start_watch
+    # for internal, or tests
+    @watcher = Thread.new(&method(:watch))
+  end
+
+  def watch
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.5
+      if Fluent::Engine.now - @last_checked
+        now = Fluent::Engine.now
+        flush_emit
+        @last_checked = now
+      end
+    end
+  end
+
+  def count_initialized(keys=nil)
+    # counts['tag'] = {:min => num, :max => num, :sum => num, :num => num [, :sample => [....]]}
+    if @aggregate == :all
+      if @percentiles
+        {'all' => {:min => nil, :max => nil, :sum => nil, :num => 0, :sample => []}}
+      else
+        {'all' => {:min => nil, :max => nil, :sum => nil, :num => 0}}
+      end
+    elsif keys
+      values = if @percentiles
+                 Array.new(keys.length) {|i| {:min => nil, :max => nil, :sum => nil, :num => 0, :sample => []}}
+               else
+                 Array.new(keys.length) {|i| {:min => nil, :max => nil, :sum => nil, :num => 0}}
+               end
+      Hash[[keys, values].transpose]
+    else
+      {}
+    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(count)
+    output = {}
+    if @aggregate == :all
+      c = count['all']
+      if c[:min] then output['min'] = c[:min] end
+      if c[:max] then output['max'] = c[:max] end
+      if c[:num] > 0 then output['avg'] = (c[:sum] * 100.0 / (c[:num] * 1.0)).round / 100 end
+      if @percentiles
+        sorted = c[:sample].sort
+        @percentiles.each do |p|
+          i = (c[:num] * p / 100).floor
+          output["percentile_#{p}"] = c[:sample][i]
+        end
+      end
+      return output
+    end
+
+    count.keys.each do |tag|
+      t = stripped_tag(tag)
+      c = count[tag]
+      if c[:min] then output[t + '_min'] = c[:min] end
+      if c[:max] then output[t + '_max'] = c[:max] end
+      if c[:num] > 0 then output[t + '_avg'] = (c[:sum] * 100.0 / (c[:num] * 1.0)).round / 100.0 end
+      if @percentiles
+        sorted = c[:sample].sort
+        @percentiles.each do |p|
+          i = (c[:num] * p / 100).floor
+          if i > 0
+            i -= 1
+          end
+          output[t + "_percentile_#{p}"] = sorted[i]
+        end
+      end
+    end
+    output
+  end
+
+  def flush
+    flushed,@count = @count,count_initialized(@count.keys.dup)
+    generate_output(flushed)
+  end
+
+  def flush_emit
+    Fluent::Engine.emit(@tag, Fluent::Engine.now, flush)
+  end
+
+  def countups(tag, min, max, sum, num, sample)
+    if @aggregate == :all
+      tag = 'all'
+    end
+
+    @mutex.synchronize do
+      c = (@count[tag] ||= {:min => nil, :max => nil, :sum => nil, :num => 0})
+      
+      if c[:min].nil? or c[:min] > min
+        c[:min] = min
+      end
+      if c[:max].nil? or c[:max] < max
+        c[:max] = max
+      end
+      c[:sum] = (c[:sum] || 0) + sum
+      c[:num] += num
+
+      if @percentiles
+        c[:sample] ||= []
+        if c[:sample].size + sample.size > @samples_limit
+          (c[:sample].size + sample.size - @samples_limit).times do
+            c[:sample].delete_at(rand(c[:sample].size)) 
+          end
+        end
+        c[:sample] += sample
+      end
+    end
+  end
+
+  def emit(tag, es, chain)
+    min = nil
+    max = nil
+    sum = 0
+    num = 0
+    sample = if @percentiles then [] else nil end
+
+    es.each do |time,record|
+      value = record[@monitor_key]
+      next if value.nil?
+
+      value = value.to_f
+      if min.nil? or min > value
+        min = value
+      end
+      if max.nil? or max < value
+        max = value
+      end
+      sum += value
+      num += 1
+
+      if @percentiles
+        sample.push(value)
+      end
+    end
+    if sample.size > @samples_limit
+      (sample.size - @samples_limit / 2).to_i.times do
+        sample.delete_at(rand(sample.size))
+      end
+    end
+    countups(tag, min, max, sum, num, sample)
+
+    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_numeric_monitor'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_numeric_monitor.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+class NumericMonitorOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    unit minute
+    tag monitor.test
+    input_tag_remove_prefix test
+    monitor_key field1
+    percentiles 80,90
+  ]
+
+  def create_driver(conf = CONFIG, tag='test.input')
+    Fluent::Test::OutputTestDriver.new(Fluent::NumericMonitorOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    #TODO
+  end
+
+  def test_count_initialized
+    #TODO
+  end
+
+  def test_countups
+    #TODO
+  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
+    #TODO
+  end
+
+  def test_emit
+    d1 = create_driver(CONFIG, 'test.tag1')
+    d1.run do
+      10.times do
+        d1.emit({'field1' => 0})
+        d1.emit({'field1' => '1'})
+        d1.emit({'field1' => 2})
+        d1.emit({'field1' => '3'})
+        d1.emit({'field1' => 4})
+        d1.emit({'field1' => 5})
+        d1.emit({'field1' => 6})
+        d1.emit({'field1' => 7})
+        d1.emit({'field1' => 8})
+        d1.emit({'field1' => 9})
+      end
+    end
+    r1 = d1.instance.flush
+    assert_equal 0, r1['tag1_min']
+    assert_equal 9, r1['tag1_max']
+    assert_equal 4.5, r1['tag1_avg']
+    assert_equal 7, r1['tag1_percentile_80']
+    assert_equal 8, r1['tag1_percentile_90']
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-numeric-monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-18 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: Fluentd plugin to calculate min/max/avg/Xpercentile values, and emit
+  these data as message
+email:
+- tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-numeric-monitor.gemspec
+- lib/fluent/plugin/out_numeric_monitor.rb
+- test/helper.rb
+- test/plugin/test_out_numeric_monitor.rb
+homepage: https://github.com/tagomoris/fluent-plugin-numeric-monitor
+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: Fluentd plugin to calculate min/max/avg/Xpercentile values
+test_files:
+- test/helper.rb
+- test/plugin/test_out_numeric_monitor.rb