fluent-plugin-flatten-hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06106e3a3fba0cc454f3d2b638f79f2efe1194ec
+  data.tar.gz: 6ff631bc5f9b14ebc48d72477992701458328e04
+SHA512:
+  metadata.gz: 96bf0b454249f603ea4aaf6e78376685c77691d2a9a7158cca8d7b08a86e64f6deed59c4f8f9e8783ffa1ea14aafb5f12d2724a49e82b5c044a52397e6bebcaa
+  data.tar.gz: 4f3cbcabab41450deadb2683e926b27336cb0e942b2180163c2c01cedae197bbcbeb84101dd7328dab66ec32dc5805f5b930306cb25bbf2ee73be5b961815633

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/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-flatten-hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Masahiro Sano
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# fluent-plugin-flatten-hash
+
+A fluentd plugin to flatten nested hash structure as a flat record with unique keys generated by its path for each values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-flatten-hash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-flatten-hash
+
+## Configuration
+
+You can set a configuration like below:
+
+```
+<match message>
+  type flatten_hash
+  add_tag_prefix flattened.
+  separator _
+</match>
+```
+
+In this configuration, if you get a following nested/complex message:
+
+```js
+{
+  "message":{
+    "today":"good day",
+    "tommorow":{
+      "is":{
+        "a":{
+          "bad":"day"
+        }
+      }
+    }
+  }
+  "days":[
+    "2013/08/24",
+    "2013/08/25"
+  ]
+}
+```
+
+The message is flattened like below:
+
+```js
+{
+  "message_today":"good day",
+  "message_tommorow_is_a_bad":"day"
+  "days_0" => "2013/08/24",
+  "days_1" => "2013/08/25"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Mixins
+
+* HandleTagNameMixin
+
+## Copyright
+
+<table>
+  <tr>
+    <td>Author</td><td>Masahiro Sano <sabottenda@gmail.com></td>
+  </tr>
+  <tr>
+    <td>Copyright</td><td>Copyright (c) 2013- Masahiro Sano</td>
+  </tr>
+  <tr>
+    <td>License</td><td>MIT License</td>
+  </tr>
+</table>

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+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
+
+task :default => [:test]
+

data/fluent-plugin-flatten-hash.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-flatten-hash"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Masahiro Sano"]
+  spec.email         = ["sabottenda@gmail.com"]
+  spec.description   = %q{A fluentd plugin to flatten nested hash structure as a flat record}
+  spec.summary       = %q{A fluentd plugin to flatten nested hash structure as a flat record}
+  spec.homepage      = "https://github.com/sabottenda/fluent-plugin-flatten-hash"
+  spec.license       = "MIT"
+  spec.has_rdoc      = false
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluentd"
+end

data/lib/fluent/plugin/out_flatten_hash.rb

@@ -0,0 +1,51 @@
+module Fluent
+  class FlattenHashOutput < Output
+    include Fluent::HandleTagNameMixin
+    Fluent::Plugin.register_output('flatten_hash', self)
+
+    config_param :tag, :string, :default => nil
+    config_param :separator, :string, :default => '.'
+
+    def initialize
+      super
+    end
+
+    def configure(conf)
+      super
+      if (!@tag &&
+          !remove_tag_prefix &&
+          !remove_tag_suffix &&
+          !add_tag_prefix &&
+          !add_tag_suffix )
+        raise ConfigError, "out_flatten_hash: No tag parameters are set"
+      end
+    end
+
+    def emit(tag, es, chain)
+      @tag ||= tag
+      es.each do |time, record|
+        record = flatten_record(record, [])
+        filter_record(@tag, time, record)
+        Engine.emit(@tag, time, record)
+      end
+      chain.next
+    end
+
+    private
+    def flatten_record(record, prefix)
+      ret = {}
+      if record.is_a? Hash
+        record.each { |key, value|
+          ret.merge! flatten_record(value, prefix + [key.to_s])
+        }
+      elsif record.is_a? Array
+        record.each_with_index { |elem, index|
+          ret.merge! flatten_record(elem, prefix + [index.to_s])
+        }
+      else
+        return {prefix.join(@separator) => record}
+      end
+      ret
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+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_hash'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_flatten_hash.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+class FlattenHashOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  BASE_CONFIG = %[
+    type flatten_hash
+  ]
+  CONFIG = BASE_CONFIG + %[
+    add_tag_prefix flattened
+  ]
+
+  def create_driver(conf = CONFIG, tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::FlattenHashOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG)
+    }
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG + %[
+        tag hoge
+      ])
+    }
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG + %[
+        add_tag_prefix hoge
+      ])
+    }
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG + %[
+        add_tag_suffix hoge
+      ])
+    }
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG + %[
+        remove_tag_prefix hoge
+      ])
+    }
+    assert_nothing_raised(Fluent::ConfigError) {
+      create_driver(BASE_CONFIG + %[
+        remove_tag_suffix hoge
+      ])
+    }
+  end
+
+  def test_flatten_record
+    d = create_driver
+
+    d.run do
+      d.emit({'message' => {'foo' => 'bar'}})
+      d.emit({"message" => {'foo' => 'bar', 'hoge' => 'fuga'}})
+      d.emit({"message" => {'nest' => {'foo' => 'bar'}}})
+      d.emit({"message" => {'nest' => {'nest' => {'foo' => 'bar'}}}})
+      d.emit({"message" => {'array' => ['foo', 'bar']}})
+      d.emit({"message" => {'array' => [{'foo' => 'bar'}, {'hoge' => 'fuga'}]}})
+    end
+
+    assert_equal [
+      {"message.foo" => "bar"},
+      {"message.foo" => "bar", "message.hoge" => "fuga"},
+      {"message.nest.foo" => "bar"},
+      {"message.nest.nest.foo" => "bar"},
+      {"message.array.0" => "foo", "message.array.1" => "bar"},
+      {"message.array.0.foo" => "bar", "message.array.1.hoge" => "fuga"},
+    ], d.records
+  end
+
+  def test_separator
+    d = create_driver CONFIG + %[separator /]
+
+    d.run do
+      d.emit({"message" => {'nest' => {'foo' => 'bar'}}})
+    end
+
+    assert_equal [
+      {"message/nest/foo" => "bar"},
+    ], d.records
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-flatten-hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masahiro Sano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A fluentd plugin to flatten nested hash structure as a flat record
+email:
+- sabottenda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-flatten-hash.gemspec
+- lib/fluent/plugin/out_flatten_hash.rb
+- test/helper.rb
+- test/plugin/test_out_flatten_hash.rb
+homepage: https://github.com/sabottenda/fluent-plugin-flatten-hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: A fluentd plugin to flatten nested hash structure as a flat record
+test_files:
+- test/helper.rb
+- test/plugin/test_out_flatten_hash.rb