fluent-mixin-elapsed_time 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 533cc98faf8bd7e5db959f74dcdb29a1f9142f37
+  data.tar.gz: 9b86326b5eeaf48fcca0a058cbcc48098655d668
+SHA512:
+  metadata.gz: 4a5f59e3baee45cbf8a6dc02933a37eb3d88508c8f1fb567ab825b2fdce8013a8a0c45dadb8fa98634a3a31f15f175a271d859fb83b573495088f7615d4915eb
+  data.tar.gz: cda37c465ec1986a4aae194cb0e7e46a2c4983f0d6baa3be8408091b9c79f0baf5921b14b3b8b47594b201ef0945f9356747070b9a6491fbe9768da9b4dc43d5

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,17 @@
+## 0.0.4  (2014/04/10)
+
+Fixes:
+
+* Fix to apply only plugins having <elapsed></elapsed> directive
+
+## 0.0.3  (2014/04/08)
+
+Enhancements:
+
+* Support to hook Output plugins
+
+## 0.0.2  (2014/04/06)
+
+First release
+
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+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,79 @@
+# fluent-mixin-elapsed_time
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-mixin-elapsed_time.png?branch=master)](http://travis-ci.org/sonots/fluent-mixin-elapsed_time)
+[![Code Climate](https://codeclimate.com/github/sonots/fluent-mixin-elapsed_time.png)](https://codeclimate.com/github/sonots/fluent-mixin-elapsed_time)
+
+Fluentd mixin to measure elapsed time to process messages
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-mixin-elapsed_time
+
+Run Fluentd with -r option to require this gem. This will automatically extends all input and output plugins (actually, `Input` and `Output` base class). 
+
+    fluentd -c fluent.conf -r 'fluent/mixin/elapsed_time'
+
+## Configuration
+
+This mixin module extends arbitrary plugins so that it can use `<elapsed></elapsed>` directive to measure elapsed times. 
+
+Example:
+
+```apache
+<source>
+  type forward
+  port 24224
+  <elapsed>
+    tag elapsed
+    interval 60
+    hook on_message
+  </elapsed>
+</source>
+
+<match elapsed>
+  type stdout
+</match>
+```
+
+This example hooks the [on_message](https://github.com/fluent/fluentd/blob/e5a9a4ca03d18b45fdb89061d8251592a044e9fc/lib/fluent/plugin/in_forward.rb#L112) method of in_forward plugin, and measures how long it takes for processing.
+
+And, this plugin emits the statistics of measured elapsed times in each specified interval like below:
+
+```
+elapsed: {"max":1.011,"avg":0.002","num":10}
+```
+
+where `max` and `avg` are the maximum and average elapsed times, and `num` is the number of being called in each interval.
+
+## Parameters
+
+* interval
+
+    The time interval to emit measurement results. Default is `60`. 
+
+* tag
+
+    The output tag name. Default is `elapsed`
+
+* hook (required)
+
+    Specify the method to hook. You can also explicitly specify the class name like `Fluent::ForwardOutput.on_message`.
+    (EXCUSE: Fluentd treats strings after # as a comment, so the form like `Fluent::ForwardInput#on_message` could not be used)
+    
+## 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/examples/fluent.conf

@@ -0,0 +1,12 @@
+<source>
+  type forward
+  log_level info
+  <elapsed>
+    tag elapsed
+    interval 1s
+    hook Fluent::ForwardInput::Handler.on_read
+  </elapsed>
+</source>
+<match **>
+  type stdout
+</match>

data/fluent-mixin-elapsed-time.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-mixin-elapsed_time"
+  gem.version     = "0.0.4"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = "sonots@gmail.com"
+  gem.homepage    = "https://github.com/sonots/fluent-mixin-elapsed_time"
+  gem.description = "Fluentd mixin 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/mixin/elapsed_time.rb

@@ -0,0 +1,168 @@
+require 'fluent/input'
+
+module Fluent
+  module ElapsedTimable
+    def self.included(klass)
+      klass.__send__(:alias_method, :configure_without_elapsed, :configure)
+      klass.__send__(:alias_method, :configure, :configure_with_elapsed)
+    end
+
+    def configure_with_elapsed(conf)
+      configure_without_elapsed(conf)
+      if element = conf.elements.select { |element| element.name == 'elapsed' }.first
+        @elapsed = ElapsedTime.new(self, log)
+        @elapsed.configure(element)
+        # #start and #stop methods must be extended in concrete input plugins
+        # because most of built-in input plugins do not call `super`
+        klass = self.class
+        unless klass.method_defined?(:start_without_elapsed)
+          klass.__send__(:alias_method, :start_without_elapsed, :start)
+          klass.__send__(:alias_method, :start, :start_with_elapsed)
+          klass.__send__(:alias_method, :shutdown_without_elapsed, :shutdown)
+          klass.__send__(:alias_method, :shutdown, :shutdown_with_elapsed)
+        end
+      end
+    end
+
+    def elapsed
+      @elapsed
+    end
+
+    def start_with_elapsed
+      start_without_elapsed
+      @elapsed.start if @elapsed
+    end
+
+    def shutdown_with_elapsed
+      shutdown_without_elapsed
+      @elapsed.stop if @elapsed
+    end
+  end
+
+  Input.__send__(:include, ElapsedTimable)
+  Output.__send__(:include, ElapsedTimable)
+
+  class ElapsedTime
+    attr_reader :input, :log, :times, :mutex, :thread, :tag, :interval, :hook
+    def initialize(input, log)
+      @input = input
+      @log = log
+      @times = []
+      @mutex = Mutex.new
+    end
+
+    def configure(conf)
+      @tag = conf['tag'] || 'elapsed'
+      @interval = conf['interval'].to_i || 60
+      unless @hook = conf['hook']
+        raise Fluent::ConfigError, '`hook` option must be specified in <elapsed></elpased> directive'
+      end
+      apply_hook(@hook)
+    end
+
+    def add(time)
+      @times << time
+    end
+
+    def clear
+      @times.clear
+    end
+
+    def apply_hook(hook)
+      if hook.include?('.')
+        klass_name, method_name = hook.split('.', 2)
+        klass = constantize(klass_name)
+      else
+        klass = @input.class
+        method_name = hook
+      end
+      old_method_name = "#{method_name}_without_elapsed".to_sym 
+      unless klass.method_defined?(old_method_name)
+        klass.__send__(:alias_method, old_method_name, method_name)
+        klass.__send__(:define_method, method_name) do |*args|
+          elapsed.measure_time(klass, method_name) do
+            self.__send__(old_method_name, *args)
+          end
+        end
+      end
+    end
+
+    def measure_time(klass, method_name)
+      started = Time.now
+      output = yield
+      elapsed = (Time.now - started).to_f
+      log.info "elapsed time at #{klass}##{method_name} is #{elapsed} sec"
+      @mutex.synchronize { self.add(elapsed) }
+      output
+    end
+
+    def start
+      @thread = Thread.new(&method(:run))
+    end
+
+    def stop
+      @thread.terminate
+      @thread.join
+    end
+
+    def run
+      @last_checked ||= Engine.now
+      while (sleep 0.5)
+        begin
+          now = Engine.now
+          if now - @last_checked >= @interval
+            flush(now)
+            @last_checked = now
+          end
+        rescue => e
+          log.warn "in_forward: #{e.class} #{e.message} #{e.backtrace.first}"
+        end
+      end
+    end
+
+    def flush(now)
+      times = []
+      @mutex.synchronize do
+        times = @times.dup
+        self.clear
+      end
+      triple = nil
+      unless times.empty?
+        num = times.size
+        max = num == 0 ? 0 : times.max
+        avg = num == 0 ? 0 : times.map(&:to_f).inject(:+) / num.to_f
+        triple = [@tag, now, {:num => num, :max => max, :avg => avg}]
+        Engine.emit(*triple)
+      end
+      triple
+    end
+
+    private
+    # File activesupport/lib/active_support/inflector/methods.rb, line 219
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check it it's owned
+          # directly before we reach Object or the end of ancestors.
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+            const
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    end
+  end
+end

data/spec/elapsed_time_spec.rb

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+require 'fluent/plugin/in_forward'
+require 'fluent/plugin/out_stdout'
+
+describe Fluent::ForwardInput do
+  before { Fluent::Test.setup }
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::InputTestDriver.new(Fluent::ForwardInput).configure(conf)
+  end
+
+  def connect
+    TCPSocket.new('127.0.0.1', PORT)
+  end
+
+  def send_data(data)
+    io = connect
+    begin
+      io.write data
+    ensure
+      io.close
+    end
+  end
+
+  def self.unused_port
+    s = TCPServer.open(0)
+    port = s.addr[1]
+    s.close
+    port
+  end
+
+  PORT = unused_port
+  CONFIG = %[
+    port #{PORT}
+    bind 127.0.0.1
+  ]
+
+  let(:driver) { create_driver(config) }
+
+  describe 'test configure' do
+    let(:config) {CONFIG + %[
+      <elapsed>
+        tag test
+        interval 10
+        hook on_message
+      </elapsed>
+    ]}
+    let(:subject) { driver.instance.elapsed }
+    its(:tag) { should == 'test' }
+    its(:interval) { should == 10 }
+    its(:hook) { should == 'on_message' }
+  end
+
+  describe 'test emit' do
+    let(:config) {CONFIG + %[
+      <elapsed>
+        tag elapsed
+        interval 1
+        # hook Fluent::ForwardInput::Handler.on_read # not support inner class yet
+        hook Fluent::ForwardInput.on_message
+      </elapsed>
+    ]}
+    it 'should flush' do
+      d = driver.instance
+      d.__send__(:on_message, ['tag1', 0, {'a'=>1}].to_msgpack)
+      triple = d.elapsed.flush(0)
+      triple[0].should == 'elapsed'
+      triple[2].keys.should =~ [:num, :max, :avg]
+    end
+  end
+end
+
+describe Fluent::StdoutOutput do
+  before { Fluent::Test.setup }
+
+  def create_driver(conf=CONFIG, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::StdoutOutput, tag).configure(conf)
+  end
+
+  CONFIG = %[
+  ]
+
+  let(:driver) { create_driver(config) }
+
+  describe 'test configure' do
+    let(:config) {CONFIG + %[
+      <elapsed>
+        tag test
+        interval 10
+        hook emit
+      </elapsed>
+    ]}
+    let(:subject) { driver.instance.instance_variable_get(:@elapsed) }
+    its(:tag) { should == 'test' }
+    its(:interval) { should == 10 }
+    its(:hook) { should == 'emit' }
+  end
+
+  describe 'test emit' do
+    let(:config) {CONFIG + %[
+      <elapsed>
+        tag elapsed
+        interval 1
+        hook emit
+      </elapsed>
+    ]}
+    it 'should flush' do
+      d = driver.instance
+      d.emit('tag1', Fluent::OneEventStream.new(0, {'a'=>1}), Fluent::NullOutputChain.instance)
+      triple = d.elapsed.flush(0)
+      triple[0].should == 'elapsed'
+      triple[2].keys.should =~ [:num, :max, :avg]
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+require 'fluent/load'
+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/mixin/elapsed_time'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fluent-mixin-elapsed_time
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 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 mixin 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
+- examples/fluent.conf
+- fluent-mixin-elapsed-time.gemspec
+- lib/fluent/mixin/elapsed_time.rb
+- spec/elapsed_time_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-mixin-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 mixin to measure elapsed time to process messages
+test_files:
+- spec/elapsed_time_spec.rb
+- spec/spec_helper.rb