fluent-plugin-elapsed-time 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6720e8ded7541bd64fcf697c652f26dc8698d06
+  data.tar.gz: b9fc406ba89a260a898d2f0eebbae70f0494f553
+SHA512:
+  metadata.gz: 6b0eb1286b7aa683a562f9b9fb61b78176453543dc1306fe40823cde5dcea4bcdff52239059782dd5e4ad3d9a375640660a0f81254bdd842a789a565c37fddb0
+  data.tar.gz: df7c63be74f4ea39658f73eb2cab8035ce3b26851b2dea9adf357fd0b7575d2a3a17ed3fc2bb33647af5b381bed749a19e780c14079ca2382cc8f8f9b226ed4e

data/.gitignore

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

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,10 @@
+## 0.0.2  (2014/01/23)
+
+Changes:
+
+* Trivial change to output record keys from symbols to strings
+
+## 0.0.1  (2014/01/23)
+
+First release
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'fluent-plugin-flowcounter' # for examples

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,76 @@
+# fluent-plugin-elapsed-time
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-elapsed-time.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-elapsed-time)
+
+Fluentd plugin to measure elapsed time to process messages
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-elapsed-time
+
+## Configuration
+
+Example:
+
+Following example measures the max and average time taken to process [fluent-plugin-grep](https://github.com/sonots/fluent-plugin-grep) => [fluent-plugin-parser](https://github.com/tagomoris/fluent-plugin-parser) => out_stdout chain in messages. Please notice that this plugin measures the total processing time until match chain finishes.
+
+```apache
+<match **>
+  type elapsed_time
+  tag elapsed
+  interval 60
+  <store>
+    type grep
+    exclude foobar
+    add_tag_prefix greped
+  </store>
+</match>
+
+<match greped.**>
+  type parse
+  format ltsv
+  key_name message
+  remove_prefix greped
+  add_prefix parsed
+</match>
+
+<match parsed.**>
+  type stdout
+</match>
+
+<match elapsed>
+  type stdout
+</match>
+```
+
+## Option Parameters
+
+* tag
+
+    The output tag name. Default is `elapsed`
+
+* interval
+
+    The time interval to emit measurement results
+
+* each
+
+    Measure time for each `message` or `es` (event stream). Please notice that the event stream (would be a msgpack) will be unpacked if `message` is specified, which would cause performance degradation. Default is `es`.
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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) 2014 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-elapsed-time.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-elapsed-time"
+  gem.version     = "0.0.2"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = "sonots@gmail.com"
+  gem.homepage    = "https://github.com/sonots/fluent-plugin-elapsed-time"
+  gem.description = "Fluentd plugin to measure elapsed time to process messages"
+  gem.summary     = gem.description
+  gem.licenses    = ["MIT"]
+  gem.has_rdoc    = false
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "fluentd", "~> 0.10.17"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/out_elapsed_time.rb

@@ -0,0 +1,105 @@
+module Fluent
+  class ElapsedTimeOutput < MultiOutput
+    Plugin.register_output('elapsed_time', self)
+
+    config_param :tag, :string, :default => 'elapsed'
+    config_param :interval, :time, :default => 60
+    config_param :each, :default => :es do |val|
+      case val.downcase
+      when 'es'
+        :es
+      when 'message'
+        :message
+      else
+        raise ConfigError, "out_elapsed_time: each should be 'es' or 'message'"
+      end
+    end 
+
+    def initialize
+      super
+      @outputs = []
+      @elapsed = []
+    end
+
+    attr_reader :outputs, :elapsed
+
+    def configure(conf)
+      super
+      conf.elements.select {|e|
+        e.name == 'store'
+      }.each {|e|
+        type = e['type']
+        unless type
+          raise ConfigError, "Missing 'type' parameter on <store> directive"
+        end
+        $log.debug "adding store type=#{type.dump}"
+
+        output = Plugin.new_output(type)
+        output.configure(e)
+        @outputs << output
+      }
+
+      @emit_proc =
+        if @each == :message
+          chain = NullOutputChain.instance
+          Proc.new {|tag, es|
+            start = Time.now
+            es.each do |time, record|
+              @outputs.each {|output| output.emit(tag, OneEventStream.new(time, record), chain) }
+              finish = Time.now
+              @elapsed << (finish - start).to_f
+              start = finish
+            end
+          }
+        else
+          chain = NullOutputChain.instance
+          Proc.new {|tag, es|
+            t = Time.now
+            @outputs.each {|output| output.emit(tag, es, chain) }
+            @elapsed << (Time.now - t).to_f
+          }
+        end
+    end
+
+    def start
+      @outputs.each {|o|
+        o.start
+      }
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      @outputs.each {|o|
+        o.shutdown
+      }
+      @thread.terminate
+      @thread.join
+    end
+
+    def run
+      @last_checked ||= Engine.now
+      while (sleep 0.1)
+        now = Engine.now
+        if now - @last_checked >= @interval
+          flush_emit
+          @last_checked = now
+        end
+      end
+    end
+
+    def flush_emit
+      elapsed, @elapsed = @elapsed, []
+      unless elapsed.empty?
+        max = elapsed.max
+        num = elapsed.size
+        avg = elapsed.map(&:to_f).inject(:+) / num.to_f
+        Engine.emit(@tag, Engine.now, {"max" => max, "avg" => avg, "num" => num})
+      end
+    end
+
+    def emit(tag, es, chain)
+      @emit_proc.call(tag, es)
+      chain.next
+    end
+  end
+end

data/spec/out_elapsed_time_spec.rb

@@ -0,0 +1,90 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+class Fluent::Test::OutputTestDriver
+  def emit_with_tag(record, time=Time.now, tag = nil)
+    @tag = tag if tag
+    emit(record, time)
+  end
+end
+
+class Hash
+  def delete!(key)
+    self.tap {|h| h.delete(key) }
+  end
+end
+
+describe Fluent::ElapsedTimeOutput do
+  before { Fluent::Test.setup }
+  CONFIG = %[
+    tag tag
+    interval 120
+    each message
+    <store>
+      type stdout
+    </store>
+  ]
+  let(:tag) { 'syslog.host1' }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::ElapsedTimeOutput, tag).configure(config) }
+
+  describe 'test configure' do
+    describe 'bad configuration' do
+      context 'invalid each' do
+        let(:config) { CONFIG + %[each foobar] }
+        it { expect { driver }.to raise_error(Fluent::ConfigError) }
+      end
+    end
+
+    describe 'good configuration' do
+      subject { driver.instance }
+
+      context "check default" do
+        let(:config) { %[] }
+        its(:tag) { should == 'elapsed' }
+        its(:interval) { should == 60 }
+        its(:each) { should == :es }
+      end
+
+      context "check config" do
+        let(:config) { CONFIG }
+        its(:tag) { should == 'tag' }
+        its(:interval) { should == 120 }
+        its(:each) { should == :message }
+      end
+    end
+  end
+
+  describe 'test emit' do
+    let(:time) { Time.now.to_i }
+    let(:messages) do
+      [
+        "2013/01/13T07:02:11.124202 INFO GET /ping",
+        "2013/01/13T07:02:13.232645 WARN POST /auth",
+        "2013/01/13T07:02:21.542145 WARN GET /favicon.ico",
+        "2013/01/13T07:02:43.632145 WARN POST /login",
+      ]
+    end
+
+    context 'each message' do
+      let(:config) { CONFIG + %[each message]}
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+      end
+      it {
+        driver.run { messages.each {|message| driver.emit({'message' => message}, time) } }
+        driver.instance.elapsed.size.should == 4
+      }
+    end
+
+    context 'each es' do
+      let(:config) { CONFIG + %[each es]}
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+      end
+      it {
+        driver.run { messages.each {|message| driver.emit({'message' => message}, time) } }
+        driver.instance.elapsed.size.should == 4
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-elapsed-time
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !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: pry-nav
+  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 measure elapsed time to process messages
+email: sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-elapsed-time.gemspec
+- lib/fluent/plugin/out_elapsed_time.rb
+- spec/out_elapsed_time_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-elapsed-time
+licenses:
+- MIT
+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: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to measure elapsed time to process messages
+test_files:
+- spec/out_elapsed_time_spec.rb
+- spec/spec_helper.rb