fluent-plugin-flatten 0.0.1 → 0.0.2

data/README.md

@@ -14,13 +14,14 @@ When you have a config as below:
 <match test.**>
   type flatten
   key  foo
+  add_tag_prefix flattened.
 </match>
 ```
 
 And you feed such a value into fluentd:
 
 ```
-{
+"test" => {
   "foo"  => '{"bar" : {"qux" : "quux", "hoe" : "poe" }, "baz" : "bazz" }',
   "hoge" => "fuga"
 }
@@ -29,7 +30,7 @@ And you feed such a value into fluentd:
 Then you'll get:
 
 ```
-{
+"flattened.test" => {
   "foo"  => '{"bar" : {"qux" : "quux", "hoe" : "poe" }, "baz" : "bazz" }',
   "hoge" => "fuga",
 
@@ -48,6 +49,12 @@ That is, JSON-formatted string in the value of the key `foo` is flattened and no
 The `key` is used to point a key whose value contains JSON-formatted
 string.
 
+### remove_tag_prefix, remove_tag_suffix, add_tag_prefix, add_tag_suffix
+
+These params are included from `Fluent::HandleTagNameMixin`. See that code for details.
+
+You must add at least one of these params.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/fluent-plugin-flatten.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'fluent-plugin-flatten'
-  gem.version       = '0.0.1'
+  gem.version       = '0.0.2'
   gem.authors       = ['Kentaro Kuribayashi']
   gem.email         = ['kentarok@gmail.com']
   gem.homepage      = 'http://github.com/kentaro/fluent-plugin-flatten'

data/lib/fluent/plugin/out_flatten.rb

@@ -2,14 +2,30 @@ require 'json'
 
 module Fluent
   class FlattenOutput < Output
+    include Fluent::HandleTagNameMixin
     class Error < StandardError; end
-
     Fluent::Plugin.register_output('flatten', self)
+
     config_param :key, :string
 
+    def configure(conf)
+      super
+
+      if !self.remove_tag_prefix && !self.remove_tag_suffix && !self.add_tag_prefix && !self.add_tag_suffix
+        raise ConfigError, "out_flatten: Set remove_tag_prefix, remove_tag_suffix, add_tag_prefix or add_tag_suffix."
+      end
+    end
+
     def emit(tag, es, chain)
       es.each do |time, record|
-        Engine.emit(tag, time, flatten(record))
+        _tag      = tag.clone
+        flattened = flatten(record)
+        filter_record(_tag, time, flattened)
+        if tag != _tag
+          Engine.emit(_tag, time, flattened)
+        else
+          $log.warn "Drop record #{record} tag '#{tag}' was not replaced. Can't emit record, cause infinity looping. Set remove_tag_prefix, remove_tag_suffix, add_tag_prefix or add_tag_suffix correctly."
+        end
       end
 
       chain.next

data/test/plugin/test_out_flatten.rb

@@ -5,22 +5,23 @@ class FlattenOutputTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  def create_driver(conf, tag = 'test')
+  CONFIG = %[
+    key foo
+    add_tag_prefix flattened.
+  ]
+
+  def create_driver(conf = CONFIG, tag = 'test')
     Fluent::Test::OutputTestDriver.new(Fluent::FlattenOutput, tag).configure(conf)
   end
 
   def test_configure
-    d = create_driver(%[
-      key foo
-    ])
-
+    d = create_driver
     assert_equal 'foo', d.instance.key
+    assert_equal 'flattened.', d.instance.add_tag_prefix
   end
 
   def test_emit
-    d = create_driver(%[
-      key foo
-    ])
+    d = create_driver
 
     d.run do
       d.emit( 'foo' => '{"bar" : "baz"}', 'hoge' => 'fuga' )
@@ -35,5 +36,8 @@ class FlattenOutputTest < Test::Unit::TestCase
     assert_equal 'quux', emits[1][2]['foo.bar.qux']
     assert_equal  'poe', emits[1][2]['foo.bar.hoe']
     assert_equal 'bazz', emits[1][2]['foo.baz']
+
+    assert_equal 'flattened.test', emits[0][0]
+    assert_equal 'flattened.test', emits[1][0]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-flatten
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake