fluent-plugin-typetalk 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzY5YjQ5MTdhMmYxYzliZDRlMmQzYzUzZTEyNmM4ZDE5NTQwYTNmMw==
+    NTMzMzhkY2NkYzFlMjQ4MTI3YzhjNTE2ODY0Y2UzY2MzMjlkMTlhNA==
   data.tar.gz: !binary |-
-    ZWQ1NjVkOGMwZWIwNDQzZjZmYTQxNzMzNzZmOTFiMjhhNzk0NmIwZA==
+    OTNmYjJiNzEwODFlYjM0N2U5YmZkMDVmZmVmYTI5MDA4MzJkY2I2MQ==
 SHA512:
   metadata.gz: !binary |-
-    NWU4MGIxZTM2NjUyZWI5YTIzMDY3OGIwYzM5NTcwZTcyNGE1M2RjZGJkODZk
-    MDE2ZDFkMjNhODE2MjQwMDdjZDdhMGQ0NWUxYWE3YTg0OWNmM2Y0NTdhYmVh
-    ODJjZGI1YmMwNDQ4ZjU5OWRjMjg1ODVhN2VjMTA5MTQzNzk0NTg=
+    MzIxNjFiZThhZDRkYTI5ODIxMzQ1Nzc2NDlhZGZhNjFmOWNmMjM5MGVlNzM5
+    NTRjY2FlMDI3MTg4NmMyNjRiYzcwYWViZjExYmZkYmExMDhkYmE5YjgzZTc3
+    OWYzY2UzMzAzZWM3MTYxMTJkOWQ0YmIwYTlkMWZhZjE4MmVhZmI=
   data.tar.gz: !binary |-
-    NWMxY2M4NGIyZmFhZmI0ZDQ5M2I2NTA0N2E3NDA3MTc2MjQ4N2M0M2E0NGM0
-    YTBhYjZlNDY1NTMxNjk3NWJmY2EzZWUwZDQzNzJjOTc1OWQxZWNjM2MxMzhi
-    ODU5MGRkNjk2ZDNmM2Q5ZDRiYWFjOTFkOWI1MGY3Y2RhNmIzM2E=
+    ZDEwNDdjOTkwOGJjYjNkM2M1YzgzZDg5YjcxZjkzNGJjYTY1N2VjNzkxN2Fl
+    ZWUxMDJlYWZmZWMxNzNjMjk4M2QwZTExZjE3ODRjMDhiZTlhYzI3MzQ3YzY3
+    NmFkZDA1MjYwYWNkNjIyM2EzMmQwNGE3ZWI2MjY4NzI4NTEzMzk=

data/README.md

@@ -52,6 +52,18 @@ This plugin allows you to use special value namely $hostname in out_keys. By usi
 </match>
 ```
 
+By default, the number of notification you can send within a minute is limited to 10. Log lines that exceed this limit will be discarded. You can change it with `interval` and `limit` parameters.
+```
+<match ...>
+  type typetalk
+  :
+  interval 300
+  limit 10
+</match>
+```
+
+In the example above, you can allow 10 notifications to be sent within 300 seconds. To remove the notification throttle, set both parameters to 0.
+
 ## TODO
 
 Pull requests are very welcome!!

data/fluent-plugin-typetalk.gemspec

@@ -4,8 +4,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-typetalk"
-  spec.version       = "0.0.3"
-  spec.authors       = ["tksmd"]
+  spec.version       = "0.0.4"
+  spec.authors       = ["tksmd","umakoz"]
   spec.email         = ["someda@isenshi.com"]
   spec.description   = %q{fluent plugin to send message to typetalk}
   spec.summary       = spec.description

data/lib/fluent/plugin/out_typetalk.rb

@@ -1,11 +1,10 @@
 module Fluent
-  class TypetalkOutput < Fluent::BufferedOutput
+  class TypetalkOutput < Fluent::Output
     Fluent::Plugin.register_output('typetalk', self)
 
     config_param :client_id, :string
     config_param :client_secret, :string
     config_param :topic_id, :integer
-    config_param :flush_interval, :time, :default => 1
 
     config_param :message, :string
     config_param :out_keys, :string, :default => ""
@@ -13,6 +12,9 @@ module Fluent
     config_param :time_format, :string, :default => nil
     config_param :tag_key, :string, :default => 'tag'
 
+    config_param :interval, :time, :default => 60
+    config_param :limit, :integer, :default => 10
+
     attr_reader :typetalk
 
     # Define `log` method for v0.10.42 or earlier
@@ -56,6 +58,9 @@ module Fluent
         @time_parse_proc = Proc.new {|str| str.to_i }
       end
 
+      @need_throttle = @limit > 0 && @interval > 0
+      @slot = []
+
     end
 
     def start
@@ -66,18 +71,35 @@ module Fluent
       super
     end
 
-    def format(tag, time, record)
-      [tag, time, record].to_msgpack
-    end
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        if @need_throttle && throttle(time)
+          log.error("out_typetalk:", :error => "number of posting message within #{@interval}(sec) reaches to the limit #{@limit}")
+          next
+        end
 
-    def write(chunk)
-      chunk.msgpack_each do |(tag,time,record)|
         begin
           send_message(tag, time, record)
         rescue => e
           log.error("out_typetalk:", :error_class => e.class, :error => e.message)
         end
       end
+
+      chain.next
+    end
+
+    def throttle(time)
+      expired = time.to_f - @interval
+      while @slot.first && (@slot.first <= expired)
+        @slot.shift
+      end
+
+      exceed = @slot.length >= @limit
+      unless exceed
+        @slot.push(time.to_f)
+      end
+
+      exceed
     end
 
     def send_message(tag, time, record)

data/test/plugin/test_out_typetalk.rb

@@ -17,14 +17,44 @@ class TypetalkOutputTest < Test::Unit::TestCase
     out_keys message
   ]
 
+  CONFIG_THROTTLE = %[
+    type typetalk
+    client_id 123456
+    client_secret secret
+    topic_id 1
+    message notice : %s
+    out_keys message
+    interval 5
+    limit 1
+  ]
+
+  CONFIG_NO_THROTTLE = %[
+    type typetalk
+    client_id 123456
+    client_secret secret
+    topic_id 1
+    message notice : %s
+    out_keys message
+    interval 0
+    limit 0
+  ]
+
   def create_driver(conf = CONFIG, tag = 'test')
-    Fluent::Test::BufferedOutputTestDriver.new(Fluent::TypetalkOutput, tag).configure(conf)
+    Fluent::Test::OutputTestDriver.new(Fluent::TypetalkOutput, tag).configure(conf)
   end
 
   def test_configure
     d = create_driver()
     assert_equal '123456', Typetalk.config.client_id
     assert_equal 'secret', Typetalk.config.client_secret
+    assert_equal 60, d.instance.instance_variable_get(:@interval)
+    assert_equal 10, d.instance.instance_variable_get(:@limit)
+    assert_equal true, d.instance.instance_variable_get(:@need_throttle)
+  end
+
+  def test_configure_no_throttle
+    d = create_driver(CONFIG_NO_THROTTLE)
+    assert_equal false, d.instance.instance_variable_get(:@need_throttle)
   end
 
   def test_write
@@ -88,4 +118,19 @@ class TypetalkOutputTest < Test::Unit::TestCase
     d.run()
   end
 
+  def test_throttle
+    d = create_driver(CONFIG_THROTTLE)
+    stub(d.instance.typetalk).post_message(1, 'notice : test1')
+    stub(d.instance.typetalk).post_message(1, 'notice : test3')
+    stub(d.instance.log).error {|name, params|
+      assert_equal "out_typetalk:", name
+      assert_equal "number of posting message within 5.0(sec) reaches to the limit 1", params[:error]
+    }
+    d.emit({'message' => 'test1'})
+    d.emit({'message' => 'test2'})
+    sleep 5
+    d.emit({'message' => 'test3'})
+    d.run()
+  end
+
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-typetalk
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - tksmd
+- umakoz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler