fluent-plugin-measure_time 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e19251ed1f95f372fe500788206264184ceaf759
-  data.tar.gz: d7c8c6cf65cd9799d1f35ddfd1598669d1b4254e
+  metadata.gz: 5a8d172be4d254d2c2d37283bb71b50ec5f6a804
+  data.tar.gz: 40825b213be411cae4ea76b21665cf28876f07f9
 SHA512:
-  metadata.gz: f5fdb0a564b5129be907d4a17ed6f0764c88fdd51224f62664d729e5ea6ac2065b72f1b2207a34d51abf4e757b6150e9b795a97c5263e627ce6eb7b52f88c415
-  data.tar.gz: 2fce2f754b0023f3fbe81c9368392166eac41233d0a2e6e895dbfceb884b1f2aaa6d73e45a33a0b4e6f78ae4e9a88a277c289d5dfd5a39ccc73eb47f9f18aa6f
+  metadata.gz: 8b0acf5b99ca783344045e15f1b3bfbaca61321b3221b5196021b27c8cf3fc69043bcedcec6ad2d1234b9492c8c0f1ed7d456f896ee2bef9e941f85be0a92961
+  data.tar.gz: 9154958570ea846abcc7a8e116139cdfe6e6f6b484d78ead00677d467a270be02d4ddf7fffb6fbd167d236a637f2dcf43862f384a9bef242810e62db98927d07

data/.gitignore

@@ -13,3 +13,4 @@ coverage
 pkg/
 .ruby-version
 *.log
+Gemfile.fluentd.v10.lock

data/.travis.yml

@@ -1,6 +1,11 @@
 rvm:
-  - 1.9.2
   - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+before_install:
+  - gem update bundler
 gemfile:
+  - Gemfile.fluentd.v10
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0  (2016/04/09)
+
+Enhancements:
+
+* Make it work with Fluentd v0.12
+
 ## 0.1.2  (2014/09/22)
 
 Changes:

data/Gemfile

@@ -1,3 +1,6 @@
 source "http://rubygems.org"
 
 gemspec
+gem 'test-unit'
+gem 'fluent-plugin-grep'
+gem 'pry-nav'

data/Gemfile.fluentd.v10

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'fluentd', '~> 0.10.0'
+gem 'test-unit'
+gem 'fluent-plugin-grep'

data/README.md

@@ -31,10 +31,12 @@ Use RubyGems:
 As an example, let's profile how long the [emit](https://github.com/sonots/fluent-plugin-grep/blob/master/lib/fluent/plugin/out_grep.rb#L56) method of [fluent-plugin-grep](https://github.com/sonots/fluent-plugin-grep) is taking.
 Configure fluentd.conf as below:
 
+For Fluentd v0.10:
+
 ```apache
 <source>
   type measure_time
-  # This makes available the `masure_time` directive for all plugins
+  # This makes available the `measure_time` directive for all plugins
 </source>
 
 <source>
@@ -59,7 +61,43 @@ Configure fluentd.conf as below:
     tag measure_time
     hook emit
   </measure_time>
+</match>
+```
+
+For Fluentd v0.12:
+
+```apache
+<label @measure_time>
+  <match>
+    @type measure_time
+    # This makes available the `measure_time` directive for all plugins
+  </match>
+</label>
+
+<source>
+  @type dummy
+  tag raw.dummy
+  dummy {"message":"foo"}
 </source>
+
+# measure_time plugin output comes here
+<match measure_time>
+  @type stdout
+</match>
+
+# Whatever you want to do
+<match greped.**>
+  @type stdout
+</match>
+
+<match **>
+  @type grep
+  add_tag_prefix greped
+  <measure_time>
+    tag measure_time
+    hook emit
+  </measure_time>
+</match>
 ```
 
 The output of fluent-plugin-measure_time will be as below:
@@ -114,10 +152,12 @@ This profiling is very useful to investigate when you have a suspicion that thro
 
 The configuration will be as follows:
 
+For Fluentd v0.10:
+
 ```apache
 <source>
   type measure_time
-  # This makes available the `masure_time` directive for all plugins
+  # This makes available the `measure_time` directive for all plugins
 </source>
 
 <source>
@@ -139,6 +179,35 @@ The configuration will be as follows:
 </match>
 ```
 
+For Fluentd v0.12:
+
+```apache
+<label @measure_time>
+  <match>
+    @type measure_time
+    # This makes available the `measure_time` directive for all plugins
+  </match>
+</match>
+
+<source>
+  @type forward
+  port 24224
+  <measure_time>
+    tag measure_time
+    hook on_message
+  </measure_time>
+</source>
+
+<match measure_time>
+  @type stdout
+</match>
+
+# whatever you want
+<match **>
+  @type stdout
+</match>
+```
+
 Output becomes as below:
 
 ```

data/example/v0.10.conf

@@ -0,0 +1,29 @@
+<source>
+  type measure_time
+  # This makes available the `measure_time` directive for all plugins
+</source>
+
+<source>
+  type dummy
+  tag raw.dummy
+  dummy {"message":"test"}
+</source>
+
+# measure_time plugin output comes here
+<match measure_time>
+  type stdout
+</match>
+
+# Whatever you want to do
+<match greped.**>
+  type stdout
+</match>
+
+<match **>
+  type grep
+  add_tag_prefix greped
+  <measure_time>
+    tag measure_time
+    hook emit
+  </measure_time>
+</match>

data/example/v0.12.conf

@@ -0,0 +1,31 @@
+<label @measure_time>
+  <match>
+    @type measure_time
+    # This makes available the `measure_time` directive for all plugins
+  </match>
+</label>
+
+<source>
+  @type dummy
+  tag raw.dummy
+  dummy {"message":"foo"}
+</source>
+
+# measure_time plugin output comes here
+<match measure_time>
+  @type stdout
+</match>
+
+# Whatever you want to do
+<match greped.**>
+  @type stdout
+</match>
+
+<match **>
+  @type grep
+  add_tag_prefix greped
+  <measure_time>
+    tag measure_time
+    hook emit
+  </measure_time>
+</match>

data/fluent-plugin-measure_time.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = "fluent-plugin-measure_time"
-  gem.version     = "0.1.2"
+  gem.version     = "0.2.0"
   gem.authors     = ["Naotoshi Seo"]
   gem.email       = "sonots@gmail.com"
   gem.homepage    = "https://github.com/sonots/fluent-plugin-measure_time"

data/lib/fluent/plugin/in_measure_time.rb

@@ -1,135 +1,16 @@
-require 'fluent/input'
+require 'fluent/plugin/measure_timable'
 
 module Fluent
   class MeasureTimeInput < Input
     Plugin.register_input('measure_time', self)
 
-    def configure(conf)
-      ::Fluent::Input.__send__(:include, MeasureTimable)
-      ::Fluent::Output.__send__(:include, MeasureTimable)
-    end
-  end
-
-  module MeasureTimable
-    def self.included(klass)
-      unless klass.method_defined?(:configure_without_measure_time)
-        klass.__send__(:alias_method, :configure_without_measure_time, :configure)
-        klass.__send__(:alias_method, :configure, :configure_with_measure_time)
-      end
-    end
-
-    attr_reader :measure_time
-
-    def configure_with_measure_time(conf)
-      configure_without_measure_time(conf)
-      if element = conf.elements.select { |element| element.name == 'measure_time' }.first
-        @measure_time = MeasureTime.new(self, log)
-        @measure_time.configure(element)
-      end
-    end
-  end
-
-  class MeasureTime
-    attr_reader :plugin, :log, :times, :mutex, :thread, :tag, :interval, :hook
-    def initialize(plugin, log)
-      @plugin = plugin
-      @klass = @plugin.class
-      @log = log
-      @times = []
-      @mutex = Mutex.new
+    unless method_defined?(:router)
+      define_method(:router) { ::Fluent::Engine }
     end
 
     def configure(conf)
-      @tag = conf['tag'] || 'measure_time'
-      unless @hook = conf['hook']
-        raise Fluent::ConfigError, '`hook` option must be specified in <measure_time></measure_time> directive'
-      end
-      @hook_msg = {:class => @klass.to_s, :hook => @hook.to_s, :object_id => @plugin.object_id.to_s}
-      @interval = conf['interval'].to_i if conf['interval']
-      @add_or_emit_proc =
-        if @interval
-          # add to calculate statistics in each interval
-          Proc.new {|elapsed|
-            @mutex.synchronize { @times << elapsed }
-          }
-        else
-          # emit information immediately
-          Proc.new {|elapsed|
-            msg = {:time => elapsed}.merge(@hook_msg)
-            ::Fluent::Engine.emit(@tag, ::Fluent::Engine.now, msg)
-          }
-        end
-      apply_hook
-    end
-
-    def apply_hook
-      @plugin.instance_eval <<EOF
-        def #{@hook}(*args)
-          measure_time.measure_time do
-            super
-          end
-        end
-        def start
-          super
-          measure_time.start
-        end
-        def stop
-          super
-          measure_time.stop
-        end
-EOF
-    end
-
-    def measure_time
-      started = Time.now
-      output = yield
-      elapsed = (Time.now - started).to_f
-      log.debug "elapsed time at #{@klass}##{@hook} is #{elapsed} sec"
-      @add_or_emit_proc.call(elapsed)
-      output
-    end
-
-    def start
-      return unless @interval
-      @thread = Thread.new(&method(:run))
-    end
-
-    def stop
-      return unless @interval
-      @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_measure_time: hook #{@klass}##{@hook} #{e.class} #{e.message} #{e.backtrace.first}"
-        end
-      end
-    end
-
-    def flush(now)
-      times = []
-      @mutex.synchronize do
-        times = @times.dup
-        @times.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, {:max => max, :avg => avg, :num => num}.merge(@hook_msg)]
-        Engine.emit(*triple)
-      end
-      triple
+      ::Fluent::Input.__send__(:include, MeasureTimable)
+      ::Fluent::Output.__send__(:include, MeasureTimable)
     end
   end
 end

data/lib/fluent/plugin/measure_timable.rb

@@ -0,0 +1,129 @@
+module Fluent
+  module MeasureTimable
+    def self.included(klass)
+      unless klass.method_defined?(:configure_without_measure_time)
+        klass.__send__(:alias_method, :configure_without_measure_time, :configure)
+        klass.__send__(:alias_method, :configure, :configure_with_measure_time)
+      end
+
+      unless klass.method_defined?(:router)
+        define_method(:router) { ::Fluent::Engine }
+      end
+    end
+
+    attr_reader :measure_time
+
+    def configure_with_measure_time(conf)
+      configure_without_measure_time(conf)
+      if element = conf.elements.select { |element| element.name == 'measure_time' }.first
+        @measure_time = MeasureTime.new(self, log, router)
+        @measure_time.configure(element)
+      end
+    end
+  end
+
+  class MeasureTime
+    attr_reader :plugin, :log, :router, :times, :mutex, :thread, :tag, :interval, :hook
+    def initialize(plugin, log, router)
+      @plugin = plugin
+      @klass = @plugin.class
+      @log = log
+      @router = router
+      @times = []
+      @mutex = Mutex.new
+    end
+
+    def configure(conf)
+      @tag = conf['tag'] || 'measure_time'
+      unless @hook = conf['hook']
+        raise Fluent::ConfigError, '`hook` option must be specified in <measure_time></measure_time> directive'
+      end
+      @hook_msg = {:class => @klass.to_s, :hook => @hook.to_s, :object_id => @plugin.object_id.to_s}
+      @interval = conf['interval'].to_i if conf['interval']
+      @add_or_emit_proc =
+        if @interval
+          # add to calculate statistics in each interval
+          Proc.new {|elapsed|
+            @mutex.synchronize { @times << elapsed }
+          }
+        else
+          # emit information immediately
+          Proc.new {|elapsed|
+            msg = {:time => elapsed}.merge(@hook_msg)
+            router.emit(@tag, ::Fluent::Engine.now, msg)
+          }
+        end
+      apply_hook
+    end
+
+    def apply_hook
+      @plugin.instance_eval <<EOF
+        def #{@hook}(*args)
+          measure_time.measure_time do
+            super
+          end
+        end
+        def start
+          super
+          measure_time.start
+        end
+        def stop
+          super
+          measure_time.stop
+        end
+EOF
+    end
+
+    def measure_time
+      started = Time.now
+      output = yield
+      elapsed = (Time.now - started).to_f
+      log.debug "elapsed time at #{@klass}##{@hook} is #{elapsed} sec"
+      @add_or_emit_proc.call(elapsed)
+      output
+    end
+
+    def start
+      return unless @interval
+      @thread = Thread.new(&method(:run))
+    end
+
+    def stop
+      return unless @interval
+      @thread.terminate
+      @thread.join
+    end
+
+    def run
+      @last_checked ||= ::Fluent::Engine.now
+      while (sleep 0.5)
+        begin
+          now = ::Fluent::Engine.now
+          if now - @last_checked >= @interval
+            flush(now)
+            @last_checked = now
+          end
+        rescue => e
+          log.warn "in_measure_time: hook #{@klass}##{@hook} #{e.class} #{e.message} #{e.backtrace.first}"
+        end
+      end
+    end
+
+    def flush(now)
+      times = []
+      @mutex.synchronize do
+        times = @times.dup
+        @times.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, {:max => max, :avg => avg, :num => num}.merge(@hook_msg)]
+        router.emit(*triple)
+      end
+      triple
+    end
+  end
+end

data/lib/fluent/plugin/out_measure_time.rb

@@ -0,0 +1,19 @@
+require 'fluent/plugin/measure_timable'
+
+module Fluent
+  class MeasureTimeOutput < Output
+    Plugin.register_output('measure_time', self)
+
+    unless method_defined?(:router)
+      define_method(:router) { ::Fluent::Engine }
+    end
+
+    def configure(conf)
+      ::Fluent::Input.__send__(:include, MeasureTimable)
+      ::Fluent::Output.__send__(:include, MeasureTimable)
+    end
+
+    def emit(tag, time, msg)
+    end
+  end
+end

data/spec/in_measure_time_spec.rb

@@ -7,7 +7,10 @@ describe Fluent::MeasureTimeInput do
   before { Fluent::Test.setup }
 
   def create_driver(conf=%[])
-    Fluent::Test::InputTestDriver.new(Fluent::MeasureTimeInput).configure(conf)
+    d = Fluent::Test::InputTestDriver.new(Fluent::MeasureTimeInput).configure(conf)
+    unless d.respond_to?(:router)
+      d.singleton_class.send(:define_method, :router) { ::Fluent::Engine }
+    end
   end
 
   describe 'test configure' do
@@ -78,8 +81,8 @@ describe "extends Fluent::ForwardInput" do
       data = ['tag1', 0, {'a'=>1}].to_msgpack
       d.__send__(:on_message, data, data.bytesize, "hi, yay!")
       triple = d.measure_time.flush(0)
-      triple[0].should == 'measure_time'
-      triple[2].keys.should =~ [:num, :max, :avg, :class, :hook, :object_id]
+      expect(triple[0]).to eql('measure_time')
+      expect(triple[2].keys).to eql([:max, :avg, :num, :class, :hook, :object_id])
     end
   end
 end
@@ -119,9 +122,9 @@ describe "extends Fluent::StdoutOutput" do
     ]}
     it 'should flush' do
       time = Fluent::Engine.now
-      Fluent::Engine.stub(:now).and_return(time)
-      Fluent::Engine.should_receive(:emit) # .with("measure_time", time, {})
+      allow(Fluent::Engine).to receive(:now) { time }
       d = driver.instance
+      expect(d.router).to receive(:emit) # .with("measure_time", time, {})
       d.emit('tag1', Fluent::OneEventStream.new(0, {'a'=>1}), Fluent::NullOutputChain.instance)
     end
   end
@@ -138,8 +141,8 @@ describe "extends Fluent::StdoutOutput" do
       d = driver.instance
       d.emit('tag1', Fluent::OneEventStream.new(0, {'a'=>1}), Fluent::NullOutputChain.instance)
       triple = d.measure_time.flush(0)
-      triple[0].should == 'measure_time'
-      triple[2].keys.should =~ [:num, :max, :avg, :class, :hook, :object_id]
+      expect(triple[0]).to eql('measure_time')
+      expect(triple[2].keys).to eql([:max, :avg, :num, :class, :hook, :object_id])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-measure_time
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-21 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -105,6 +105,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.fluentd.v10
 - LICENSE
 - README.md
 - Rakefile
@@ -116,8 +117,12 @@ files:
 - benchmark/in_forward.conf
 - benchmark/patched_in_forward.conf
 - benchmark/plugin/in_forward.rb
+- example/v0.10.conf
+- example/v0.12.conf
 - fluent-plugin-measure_time.gemspec
 - lib/fluent/plugin/in_measure_time.rb
+- lib/fluent/plugin/measure_timable.rb
+- lib/fluent/plugin/out_measure_time.rb
 - spec/in_measure_time_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sonots/fluent-plugin-measure_time
@@ -140,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin to measure elapsed time to process messages