fluent-plugin-flatten 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,2 @@
+Copyright (c) 2012 Kentaro Kuribayashi
+Apache License, Version 2.0

data/README.md

@@ -0,0 +1,81 @@
+# fluent-plugin-flatten
+
+## Component
+
+### FlattenOutput
+
+Fluentd output plugin to flatten JSON-formatted string values in records to top level key/value-s.
+
+## Synopsis
+
+When you have a config as below:
+
+```
+<match test.**>
+  type flatten
+  key  foo
+</match>
+```
+
+And you feed such a value into fluentd:
+
+```
+{
+  "foo"  => '{"bar" : {"qux" : "quux", "hoe" : "poe" }, "baz" : "bazz" }',
+  "hoge" => "fuga"
+}
+```
+
+Then you'll get:
+
+```
+{
+  "foo"  => '{"bar" : {"qux" : "quux", "hoe" : "poe" }, "baz" : "bazz" }',
+  "hoge" => "fuga",
+
+  "foo.bar.qux" => "quux",
+  "foo.bar.hoe" => "poe",
+  "foo.baz"     => "bazz"
+}
+```
+
+That is, JSON-formatted string in the value of the key `foo` is flattened and now put into the top level of the hash.
+
+## Configuration
+
+### key
+
+The `key` is used to point a key whose value contains JSON-formatted
+string.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-flatten'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-flatten
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+### Copyright
+
+Copyright (c) 2012- Kentaro Kuribayashi (@kentaro)
+
+### License
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/fluent-plugin-flatten.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'fluent-plugin-flatten'
+  gem.version       = '0.0.1'
+  gem.authors       = ['Kentaro Kuribayashi']
+  gem.email         = ['kentarok@gmail.com']
+  gem.homepage      = 'http://github.com/kentaro/fluent-plugin-flatten'
+  gem.description   = %q{Fluentd plugin to flatten JSON-formatted string values to top level key/value-s.}
+  gem.summary       = %q{Fluentd plugin to flatten JSON-formatted string values to top level key/value-s.}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'fluentd'
+  gem.add_runtime_dependency     'fluentd'
+end

data/lib/fluent/plugin/out_flatten.rb

@@ -0,0 +1,46 @@
+require 'json'
+
+module Fluent
+  class FlattenOutput < Output
+    class Error < StandardError; end
+
+    Fluent::Plugin.register_output('flatten', self)
+    config_param :key, :string
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        Engine.emit(tag, time, flatten(record))
+      end
+
+      chain.next
+    end
+
+    def flatten(record)
+      if record.has_key?(@key)
+        hash   = JSON.parse(record[@key])
+        record = record.merge(_flatten(@key, hash))
+      end
+
+      record
+    end
+
+    def _flatten(root, hash)
+      unless hash.is_a?(Hash)
+        raise Error.new('The value to be flattened must be a Hash: #{hash}')
+      end
+
+      flattened = {}
+      hash.each do |path, value|
+        key = [root, path].join('.')
+
+        if value.is_a?(String)
+          flattened[key] = value
+        else
+          flattened = flattened.merge(_flatten(key, value))
+        end
+      end
+
+      flattened
+    end
+  end
+end

data/test/plugin/test_out_flatten.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class FlattenOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::FlattenOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver(%[
+      key foo
+    ])
+
+    assert_equal 'foo', d.instance.key
+  end
+
+  def test_emit
+    d = create_driver(%[
+      key foo
+    ])
+
+    d.run do
+      d.emit( 'foo' => '{"bar" : "baz"}', 'hoge' => 'fuga' )
+      d.emit( 'foo' => '{"bar" : {"qux" : "quux", "hoe" : "poe" }, "baz" : "bazz" }', 'hoge' => 'fuga' )
+    end
+    emits = d.emits
+
+    assert_equal      3, emits[0][2].count
+    assert_equal  'baz', emits[0][2]['foo.bar']
+
+    assert_equal      5, emits[1][2].count
+    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']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_flatten'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-flatten
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Kuribayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to flatten JSON-formatted string values to top level key/value-s.
+email:
+- kentarok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-flatten.gemspec
+- lib/fluent/plugin/out_flatten.rb
+- test/plugin/test_out_flatten.rb
+- test/test_helper.rb
+homepage: http://github.com/kentaro/fluent-plugin-flatten
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fluentd plugin to flatten JSON-formatted string values to top level key/value-s.
+test_files:
+- test/plugin/test_out_flatten.rb
+- test/test_helper.rb