fluent-plugin-flatten-hash2 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1488508ac8d7f4c339c9af41072f190bf0ad2879
+  data.tar.gz: d2b1edcb65458dd8c58f6e8472ab5fd39a1ea3bd
+SHA512:
+  metadata.gz: 82c105739c320e068389f5a33098bd30d27c647238cb9159a08efea4c971e7531d6a4ce752443fac60d051b39ce4da81dbfca010d1243c1d69bfb6a3b4fbf07b
+  data.tar.gz: 3dfd7833e9941a9fab39c4ecc37f997498e7ba5495798b8d04b5aab0e2db6a03b26fa83a765ebfe82fb2e23e232e23377d2399319b6d031bdda43e265ae97bc3

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/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2
+
+script:
+  - bundle exec rake test
+
+sudo: false

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,130 @@
+# fluent-plugin-flatten-hash, a plugin for [Fluentd](http://fluentd.org)
+
+[![Build Status](https://travis-ci.org/kazegusuri/fluent-plugin-flatten-hash.svg?branch=master)](https://travis-ci.org/kazegusuri/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
+
+fluent-plugin-flatten-hash supports both Output and Filter plugin.
+
+### Output
+
+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"
+}
+```
+
+In order to prevent arrays from being indexed, you can use a configuration like below:
+
+```
+<match message>
+  type flatten_hash
+  add_tag_prefix flattened.
+  separator _
+  flatten_array false
+</match>
+```
+
+Using the same input, you'll instead end up with a message flattened like below:
+
+```js
+{
+  "message_today":"good day",
+  "message_tommorow_is_a_bad":"day",
+  "days":["2013/08/24","2013/08/25"]
+}
+```
+
+
+### Filter
+
+You can set a configuration like below:
+
+```
+<filter message>
+  type flatten_hash
+  separator _
+</filter>
+
+<match message>
+  type stdout
+</match>
+```
+
+## 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,23 @@
+# 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-hash2"
+  spec.version       = "0.4.2"
+  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/take-the-interview/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", ["~> 0.12.0"]
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/filter_flatten_hash.rb

@@ -0,0 +1,20 @@
+module Fluent
+  class FlattenHashFilter < Filter
+    Plugin.register_filter('flatten_hash', self)
+
+    require_relative 'flatten_hash_util'
+    include FlattenHashUtil
+
+    config_param :separator, :string, :default => '.'
+    config_param :flatten_array, :bool, :default => true
+    config_param :remove_tag_prefix, :string, :default => ''
+
+    def configure(conf)
+      super
+    end
+
+    def filter(tag, time, record)
+      flatten_record(record, [])
+    end
+  end if defined?(Filter)
+end

data/lib/fluent/plugin/flatten_hash_util.rb

@@ -0,0 +1,19 @@
+module Fluent
+  module FlattenHashUtil
+    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 and @flatten_array
+        record.each_with_index { |elem, index|
+          ret.merge! flatten_record(elem, prefix + [index.to_s])
+        }
+      else
+        return {prefix.join(@separator).gsub(@remove_tag_prefix, "") => record}
+      end
+      ret
+    end
+  end
+end

data/lib/fluent/plugin/out_flatten_hash.rb

@@ -0,0 +1,39 @@
+module Fluent
+  class FlattenHashOutput < Output
+    include Fluent::HandleTagNameMixin
+    Fluent::Plugin.register_output('flatten_hash', self)
+
+    require_relative 'flatten_hash_util'
+    include FlattenHashUtil
+
+    config_param :tag, :string, :default => nil
+    config_param :separator, :string, :default => '.'
+    config_param :flatten_array, :bool, :default => true
+
+    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 || tag
+      es.each do |time, record|
+        record = flatten_record(record, [])
+        t = tag.dup
+        filter_record(t, time, record)
+        router.emit(t, time, record)
+      end
+      chain.next
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+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'

data/test/plugin/test_filter_flatten_array.rb

@@ -0,0 +1,47 @@
+require 'helper'
+require 'fluent/plugin/filter_flatten_hash'
+
+class FlattenHashFlattenArrayFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  BASE_CONFIG = %[
+    type flatten_hash
+  ]
+  CONFIG = BASE_CONFIG + %[
+    add_tag_prefix flattened
+    flatten_array false
+  ]
+
+  def setup
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(FlattenHashFilter).configure(conf, true)
+  end
+
+  def test_flatten_record_flatten_array_false
+    d = create_driver CONFIG
+    es = Fluent::MultiEventStream.new
+    now = Fluent::Engine.now
+
+    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"=>["foo", "bar"]},
+      {"message.array"=>[{"foo"=>"bar"}, {"hoge"=>"fuga"}]},
+    ], d.filtered_as_array.map{|x| x[2]}
+  end
+end

data/test/plugin/test_filter_flatten_hash.rb

@@ -0,0 +1,57 @@
+require 'helper'
+require 'fluent/plugin/filter_flatten_hash'
+
+class FlattenHashFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  BASE_CONFIG = %[
+    type flatten_hash
+  ]
+  CONFIG = BASE_CONFIG + %[
+    add_tag_prefix flattened
+  ]
+
+  def setup
+    Fluent::Test.setup
+    @time = Fluent::Engine.now
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(FlattenHashFilter).configure(conf, true)
+  end
+
+  def test_flatten_record
+    d = create_driver
+    es = Fluent::MultiEventStream.new
+    now = Fluent::Engine.now
+
+    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.filtered_as_array.map{|x| x[2]}
+  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.filtered_as_array.map{|x| x[2]}
+  end
+end

data/test/plugin/test_out_flatten_hash.rb

@@ -0,0 +1,119 @@
+require 'helper'
+require 'fluent/plugin/out_flatten_hash'
+
+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
+
+  def test_emit_with_add_tag_prefix
+    d = create_driver BASE_CONFIG + %[
+      add_tag_prefix flattened.
+    ]
+    d.run do
+      d.emit({'message' => {'foo' => 'bar'}})
+      d.emit({'message' => {'foo' => 'bar'}})
+      d.emit({'message' => {'foo' => 'bar'}})
+    end
+    emits = d.emits
+    emits.each do |e|
+      assert_equal 'flattened.test', e[0]
+      assert_equal 'bar', e[2]["message.foo"]
+    end
+    assert_equal 3, emits.count
+  end
+
+  def test_emit_with_remove_tag_prefix
+    tag = 'prefix.prefix.test'
+    d = create_driver BASE_CONFIG + %[
+      remove_tag_prefix prefix.
+    ], tag
+    d.run do
+      d.emit({'message' => {'foo' => 'bar'}})
+      d.emit({'message' => {'foo' => 'bar'}})
+      d.emit({'message' => {'foo' => 'bar'}})
+    end
+    emits = d.emits
+    emits.each do |e|
+      assert_equal 'prefix.test', e[0]
+      assert_equal 'bar', e[2]["message.foo"]
+    end
+    assert_equal 3, emits.count
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-flatten-hash2
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Masahiro Sano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-flatten-hash.gemspec
+- lib/fluent/plugin/filter_flatten_hash.rb
+- lib/fluent/plugin/flatten_hash_util.rb
+- lib/fluent/plugin/out_flatten_hash.rb
+- test/helper.rb
+- test/plugin/test_filter_flatten_array.rb
+- test/plugin/test_filter_flatten_hash.rb
+- test/plugin/test_out_flatten_hash.rb
+homepage: https://github.com/take-the-interview/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.5.2
+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_filter_flatten_array.rb
+- test/plugin/test_filter_flatten_hash.rb
+- test/plugin/test_out_flatten_hash.rb