fluent-plugin-calc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ef459d57b1a570eb06400f3eb8e6a4b54ed0323
+  data.tar.gz: 3f075999d044512d5504897e237dd7e8a07f57e6
+SHA512:
+  metadata.gz: 94465d66d28c3ec8596b94c19e9da14c6ecd2624262dc9ce27038b19ca8ee50c529242bba14be09aba95ba7545627da935dd5e4fd6d07f7af44af3f8fefac1c1
+  data.tar.gz: 76c2f2d778128c2287111b086290c14f7cf05df08eac3f7d7aa39717061b0c9408749ddcf6103a58df9b6c3a641898135cb57d87c757a8ce4f568d2114364d5d

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: i4DJCtdksuIwhBck1tukIjzKoMCxWIIvQ

data/.gitignore

@@ -0,0 +1,13 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/*

data/.rdebugrc

@@ -0,0 +1,4 @@
+set autolist
+set autoeval
+set autoreload
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (2013/05/05)
+
+First version

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'simplecov', git: 'https://github.com/colszowka/simplecov.git'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Naotoshi SEO
+
+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,69 @@
+# fluent-plugin-calc [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-calc.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-calc) [![Dependency Status](https://gemnasium.com/sonots/fluent-plugin-calc.png)](https://gemnasium.com/sonots/fluent-plugin-calc) [![Coverage Status](https://coveralls.io/repos/sonots/fluent-plugin-calc/badge.png?branch=master)](https://coveralls.io/r/sonots/fluent-plugin-calc)
+
+Fluentd plugin to calc messages.
+
+## Configuration
+
+    <match foo.**>
+      type calc
+      interval 5s
+      aggragate tag
+      add_tag_prefix calc
+
+      sum .*_count$
+      max .*_max$
+      min .*_min$
+      avg .*_avg$
+    </match>
+
+Assuming following inputs are coming:
+
+    foo.bar: {"4xx_count":1,"5xx_count":2","reqtime_max":12083,"reqtime_min":10,reqtime_avg":240.46}
+    foo.bar: {"4xx_count":4,"5xx_count":2","reqtime_max":24831,"reqtime_min":82,reqtime_avg":300.46}
+
+then output bocomes as belows:
+
+    foo.bar: {"4xx_count":5,"5xx_count":4","reqtime_max":24831,"reqtime_min":82,reqtime_avg":270.46}
+
+## Parameters
+
+- aggragate
+    
+    Calculate by each `tag` or `all`. The default value is `tag`.
+
+- interval
+
+    The interval to calculate in seconds. Default is 5s. 
+
+- tag
+
+    The output tag name
+
+- add_tag_prefix
+
+    Add tag prefix for output message
+
+- sum, min, max, avg
+
+    Calculation. Specify input keys by a regular expression
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## ToDo
+
+Get the number of denominator to calculate `avg` from input json field. 
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Naotoshi SEO. See [LICENSE](LICENSE) for details.
+

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-calc.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-calc"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi SEO"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-calc"
+  s.summary     = "fluentd plugin to calc messages"
+  s.description = s.summary
+
+  s.rubyforge_project = "fluent-plugin-calc"
+
+  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"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency 'coveralls'
+end

data/lib/fluent/plugin/out_calc.rb

@@ -0,0 +1,131 @@
+# encoding: UTF-8
+class Fluent::CalcOutput < Fluent::Output
+  Fluent::Plugin.register_output('calc', self)
+
+  config_param :sum, :string, :default => nil
+  config_param :max, :string, :default => nil
+  config_param :min, :string, :default => nil
+  config_param :avg, :string, :default => nil
+  config_param :interval, :time, :default => 5
+  config_param :tag, :string, :default => nil
+  config_param :add_tag_prefix, :string, :default => 'calc'
+  config_param :aggregate, :string, :default => 'tag'
+
+  attr_accessor :matches
+  attr_accessor :last_checked
+
+  def configure(conf)
+    super
+
+    @interval = @interval.to_i
+    @sum = Regexp.new(@sum) if @sum
+    @max = Regexp.new(@max) if @max
+    @min = Regexp.new(@min) if @min
+    @avg = Regexp.new(@avg) if @avg
+
+    unless ['tag', 'all'].include?(@aggregate)
+      raise Fluent::ConfigError, "aggregate allows tag/all"
+    end
+
+    case @aggregate
+    when 'all'
+      raise Fluent::ConfigError, "tag must be specified for aggregate all" if @tag.nil?
+    end
+
+    @counts = {}
+    @matches = {}
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    @watcher = Thread.new(&method(:watcher))
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  # Called when new line comes. This method actually does not emit
+  def emit(tag, es, chain)
+    tag = 'all' if @aggregate == 'all'
+      
+    # calc
+    count = 0; matches = {}
+    es.each do |time,record|
+      record.keys.each do |key|
+        if @sum and @sum.match(key)
+          matches[key] = (matches[key] ? matches[key] + record[key] : record[key])
+        elsif @max and @max.match(key)
+          matches[key] = (matches[key] ? [matches[key], record[key]].max : record[key])
+        elsif @min and @min.match(key)
+          matches[key] = (matches[key] ? [matches[key], record[key]].min : record[key])
+        elsif @avg and @avg.match(key)
+          matches[key] = (matches[key] ? matches[key] + record[key] : record[key]) # sum yet
+        end
+      end
+      count += 1
+    end
+
+    # thread safe merge
+    @counts[tag] ||= 0
+    @matches[tag] ||= {}
+    @mutex.synchronize do
+      matches.keys.each do |key|
+        if @sum and @sum.match(key)
+          @matches[tag][key] = (@matches[tag][key] ? @matches[tag][key] + matches[key] : matches[key])
+        elsif @max and @max.match(key)
+          @matches[tag][key] = (@matches[tag][key] ? [@matches[tag][key], matches[key]].max : matches[key])
+        elsif @min and @min.match(key)
+          @matches[tag][key] = (@matches[tag][key] ? [@matches[tag][key], matches[key]].min : matches[key])
+        elsif @avg and @avg.match(key)
+          @matches[tag][key] = (@matches[tag][key] ? @matches[tag][key] + matches[key] : matches[key]) # sum yet
+        end
+      end
+      @counts[tag] += count
+    end
+
+    chain.next
+  end
+
+  # thread callback
+  def watcher
+    # instance variable, and public accessable, for test
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.5
+      if Fluent::Engine.now - @last_checked >= @interval
+        now = Fluent::Engine.now
+        flush_emit(now - @last_checked)
+        @last_checked = now
+      end
+    end
+  end
+
+  # This method is the real one to emit
+  def flush_emit(step)
+    time = Fluent::Engine.now
+    flushed_counts, flushed_matches, @counts, @matches = @counts, @matches, {}, {}
+
+    flushed_counts.keys.each do |tag|
+      count = flushed_counts[tag]
+      matches = flushed_matches[tag]
+      output = generate_output(count, matches)
+      tag = @tag ? @tag : "#{@add_tag_prefix}.#{tag}"
+      Fluent::Engine.emit(tag, time, output) if output
+    end
+  end
+
+  def generate_output(count, matches)
+    output = matches.dup
+    output.keys.each do |key|
+      if @avg.match(key)
+        output[key] = matches[key] / count.to_f # compute avg
+      end
+    end
+    output
+  end
+
+end

data/spec/out_calc_spec.rb

@@ -0,0 +1,145 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe Fluent::CalcOutput do
+  before { Fluent::Test.setup }
+  CONFIG = %[
+    input_key message
+  ]
+  let(:tag) { 'foo.bar' }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::CalcOutput, tag).configure(config) }
+
+  describe 'test configure' do
+    describe 'bad configuration' do
+      context 'invalid aggregate' do
+        let(:config) do
+          CONFIG + %[
+          aggregate foo
+          ]
+        end
+        it { expect { driver }.to raise_error(Fluent::ConfigError) }
+      end
+
+      context 'no tag for aggregate all' do
+        let(:config) do
+          CONFIG + %[
+          aggregate all
+          ]
+        end
+        it { expect { driver }.to raise_error(Fluent::ConfigError) }
+      end
+    end
+
+    describe 'good configuration' do
+      context "nothing" do
+        let(:config) { '' }
+        it { expect { driver }.to_not raise_error(Fluent::ConfigError) }
+      end
+
+      context 'sum/max/min/avg' do
+        let(:config) do
+          CONFIG + %[
+            sum _count$
+            max _max$
+            min _min$
+            avg _avg$
+          ]
+        end
+        it { expect { driver }.to_not raise_error(Fluent::ConfigError) }
+      end
+
+      context "check default" do
+        subject { driver.instance }
+        let(:config) { CONFIG }
+        its(:interval) { should == 5 }
+        its(:tag) { should be_nil }
+        its(:add_tag_prefix) { should == 'calc' }
+        its(:aggregate) { should == 'tag' }
+      end
+    end
+  end
+
+  describe 'test emit' do
+    let(:time) { Time.now.to_i }
+    let(:messages) do
+      [
+        {"4xx_count"=>1,"5xx_count"=>2,"reqtime_max"=>6,"reqtime_min"=>1,"reqtime_avg"=>3},
+        {"4xx_count"=>2,"5xx_count"=>2,"reqtime_max"=>5,"reqtime_min"=>2,"reqtime_avg"=>2},
+        {"4xx_count"=>3,"5xx_count"=>2,"reqtime_max"=>1,"reqtime_min"=>3,"reqtime_avg"=>4},
+      ]
+    end
+    let(:emit) do
+      driver.run { messages.each {|message| driver.emit(message, time) } }
+      driver.instance.flush_emit(0)
+    end
+
+    context 'interval' do
+      pending
+    end
+
+    context 'sum/max/min/avg' do
+      let(:config) do
+        CONFIG + %[
+          sum _count$
+          max _max$
+          min _min$
+          avg _avg$
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("calc.#{tag}", time, {
+          "4xx_count"=>6,"5xx_count"=>6,"reqtime_max"=>6,"reqtime_min"=>1,"reqtime_avg"=>3.0
+        })
+      end
+      it { emit }
+    end
+
+    context 'tag' do
+      let(:config) do
+        CONFIG + %[
+          tag foo
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo", time, {})
+      end
+      it { emit }
+    end
+
+    context 'add_tag_prefix' do
+      let(:config) do
+        CONFIG + %[
+          add_tag_prefix foo
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo.#{tag}", time, {})
+      end
+      it { emit }
+    end
+
+    context 'aggregate all' do
+      let(:config) do
+        CONFIG + %[
+          aggregate all
+          tag foo
+          sum _count$
+          max _max$
+          min _min$
+          avg _avg$
+        ]
+      end
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo", time, { 
+          "4xx_count"=>6,"5xx_count"=>6,"reqtime_max"=>6,"reqtime_min"=>1,"reqtime_avg"=>3.0
+        })
+      end
+      it { emit }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_calc'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-calc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi SEO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-05 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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: rspec
+  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: pry
+  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: coveralls
+  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'
+description: fluentd plugin to calc messages
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rdebugrc
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-calc.gemspec
+- lib/fluent/plugin/out_calc.rb
+- spec/out_calc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-calc
+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-calc
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: fluentd plugin to calc messages
+test_files:
+- spec/out_calc_spec.rb
+- spec/spec_helper.rb