fluent-plugin-elapsed-time 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d14cf6319e26776194fbb0919e67088cd7ea95b4
-  data.tar.gz: 3ddedf3e28e320fafcff40ceab676373afcbaa57
+  metadata.gz: 6c0f9adda6567da79749a6fc034bcb0487c9e141
+  data.tar.gz: ecb930003b14f489d71ef6855cf2156e28c9a53f
 SHA512:
-  metadata.gz: a2cdc21c833167dfdbcb966eb94985dc368f55887bda1b19a28711b400fdfe3a840b06bf654688f1337b8baa9f74fb8bff5c960797c7365232a5e30a3afead4d
-  data.tar.gz: 851810c1aa907d6be79c9f54fb7cd1b41747006553979f363659b51cbf8b17162b039e700cc0f2af574a186ec71c1a49b202a2e4f4a99772e3e409d76dcc5d3c
+  metadata.gz: e7b6c7c34fce1d88eaafed9d96e8b14b81752e36946dffe081043313a25781b88b642addca6f1ea71e9183bf02b67ac02e4cf65e438372d4b242e35dce66d743
+  data.tar.gz: d697f84cf3dc25e83eb35851bea61186ddb458909f3d466e9bef96938cab494cb30293d21ce4e2f594dfb62012a5670d249211c2d2f16ea7929bff8b7ec5c888

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.4  (2014/01/30)
+
+Enhancement:
+
+* Add `zero_emit` option
+
 ## 0.0.3  (2014/01/30)
 
 Enhancement:

data/README.md

@@ -93,6 +93,14 @@ where `max` and `avg` are the maximum and average elapsed times, and `num` is th
     `all` measures `max` and `avg` for all input messages.
     `tag` measures `max` and `avg` for each tag *modified* by `add_tag_prefix`, `remove_tag_prefix`, or `remove_tag_slice`. 
 
+* zero_emit *bool*
+
+    Emit 0 on the next interval. This is useful for some software which requires resetting data such as [GrowthForecast](http://kazeburo.github.io/GrowthForecast).
+
+        elapsed: {"max":1.013,"avg":0.123,"num"=>0}
+        # after @interval later
+        elapsed: {"max":0,"avg":0,"num"=>0}
+
 ## ChangeLog
 
 See [CHANGELOG.md](CHANGELOG.md) for details.

data/fluent-plugin-elapsed-time.gemspec

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

data/lib/fluent/plugin/out_elapsed_time.rb

@@ -18,6 +18,7 @@ module Fluent
         raise ConfigError, "out_elapsed_time: each should be 'es' or 'message'"
       end
     end 
+    config_param :zero_emit, :bool, :default => false
 
     def initialize
       super
@@ -28,7 +29,7 @@ module Fluent
     # for test
     attr_reader :outputs
 
-    def elapsed(tag = :all)
+    def elapsed(tag = "elapsed") # default: @tag
       @elapsed[tag] ||= []
     end
 
@@ -84,14 +85,6 @@ module Fluent
           Proc.new {|tag| @tag_slice_proc.call(tag) }
         end
 
-      @push_elapsed_proc =
-        case @aggregate
-        when 'all'
-          Proc.new {|tag, elapsed_time| elapsed(:all) << elapsed_time }
-        when 'tag'
-          Proc.new {|tag, elapsed_time| elapsed(tag) << elapsed_time }
-        end
-
       @emit_proc =
         if @each == :message
           chain = NullOutputChain.instance
@@ -100,8 +93,8 @@ module Fluent
             es.each do |time, record|
               @outputs.each {|output| output.emit(tag, OneEventStream.new(time, record), chain) }
               finish = Time.now
-              elapsed = (finish - start).to_f
-              @push_elapsed_proc.call(@tag_proc.call(tag), elapsed)
+              emit_tag = @tag_proc.call(tag)
+              elapsed(emit_tag) << (finish - start).to_f
               start = finish
             end
           }
@@ -110,12 +103,22 @@ module Fluent
           Proc.new {|tag, es|
             t = Time.now
             @outputs.each {|output| output.emit(tag, es, chain) }
-            elapsed = (Time.now - t).to_f
-            @push_elapsed_proc.call(@tag_proc.call(tag), elapsed)
+            emit_tag = @tag_proc.call(tag)
+            elapsed(emit_tag) << (Time.now - t).to_f
           }
         end
     end
 
+    def initial_elapsed(prev_elapsed = nil)
+      return {} if !@zero_emit or prev_elapsed.nil?
+      elapsed = {}
+      prev_elapsed.keys.each do |tag|
+        next if prev_elapsed[tag].empty? # Prohibit to emit anymore
+        elapsed[tag] = []
+      end
+      elapsed
+    end
+
     def start
       @outputs.each {|o|
         o.start
@@ -143,15 +146,15 @@ module Fluent
     end
 
     def flush_emit
-      elapseds, @elapsed = @elapsed, {}
-      elapseds.each do |tag, 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
+      flushed_elapsed, @elapsed = @elapsed, initial_elapsed(@elapsed)
+      messages = {}
+      flushed_elapsed.each do |tag, elapsed|
+        num = elapsed.size
+        max = num == 0 ? 0 : elapsed.max
+        avg = num == 0 ? 0 : elapsed.map(&:to_f).inject(:+) / num.to_f
+        messages[tag] = {"max" => max, "avg" => avg, "num" => num}
       end
+      messages.each {|tag, message| Engine.emit(tag, Engine.now, message) }
     end
 
     def emit(tag, es, chain)

data/spec/out_elapsed_time_spec.rb

@@ -17,9 +17,6 @@ end
 describe Fluent::ElapsedTimeOutput do
   before { Fluent::Test.setup }
   CONFIG = %[
-    tag tag
-    interval 120
-    each message
     <store>
       type stdout
     </store>
@@ -46,7 +43,7 @@ describe Fluent::ElapsedTimeOutput do
       end
 
       context "check config" do
-        let(:config) { CONFIG }
+        let(:config) { CONFIG + %[tag tag\ninterval 120\neach message]}
         its(:tag) { should == 'tag' }
         its(:interval) { should == 120 }
         its(:each) { should == :message }
@@ -121,5 +118,29 @@ describe Fluent::ElapsedTimeOutput do
         driver.instance.elapsed("elapsed.#{expected_tag}").size.should == 4
       }
     end
+
+    context 'zero_emit true' do
+      let(:config) { CONFIG + %[zero_emit true]}
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+      end
+      it {
+        driver.run { messages.each {|message| driver.emit({'message' => message}, time) } }
+        driver.instance.flush_emit["elapsed"]["num"].should == 4
+        driver.instance.flush_emit["elapsed"].should == {"max" => 0, "avg" => 0, "num" => 0}
+      }
+    end
+
+    context 'zero_emit false' do
+      let(:config) { CONFIG }
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+      end
+      it {
+        driver.run { messages.each {|message| driver.emit({'message' => message}, time) } }
+        driver.instance.flush_emit["elapsed"]["num"].should == 4
+        driver.instance.flush_emit.should == {}
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-elapsed-time
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd