fluent-plugin-to-flat-json-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf6d1209e2e16cf71dc8c6f4b3a15527908488e7a81ee21a85e73749d29a56c2
+  data.tar.gz: 1f0389520bb0e686be1d4bd5b0d4f32c4fe4176772e725b2d83669cee73f630e
+SHA512:
+  metadata.gz: 6b15055aa2ba084d26b6ebbb7000a3a87d842e27b34d7b288e2e4d175806425593f09a6213feffe76298c172a05ab61c94195673f4a156cc33aeddb0f567cdf2
+  data.tar.gz: 9dbf90a465d111bf09aeddb7e8551ff60b49ec96c0a37460d7783c190db050be4007abb6f1c3b43b38d44dc7385aa6b0b37b54500293c33f293b904da97c4fd7

data/.gitignore

@@ -0,0 +1,30 @@
+/*.gem
+~*
+#*
+*~
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/
+.ruby-version
+*.gem
+*.rbc
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+
+before_install:
+  - gem update bundler
+
+script:
+  - bundle exec rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 studio3104
+
+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,44 @@
+# fluent-plugin-to-flat-json-parser
+
+fluentd parser plugin to create flattened JSON from nested JSON objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-to-flat-json-parser'
+
+And then execute:
+
+    $ bundle
+
+Readying for a package build:
+
+   $ bundle install
+   $ bundle exec rake build
+
+## Configuration
+
+- configuration
+
+  ```
+  <source>
+    type tail
+    path /tmp/fluentd.json
+    pos_file /tmp/fluentd.log.pos
+    tag logs
+    format to_json_flat
+    time_key timestamp
+    separator .
+  </source>
+  ```
+
+#### Parameter
+
+###### time_key
+- Default is `time`
+- Field to use for time resolution
+
+###### separator
+- Default is '.'
+- Used as the value to split the keys

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+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-to-flat-json-parser.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'fluent-plugin-to-flat-json-parser'
+  gem.version     = '0.0.1'
+  gem.authors     = ['Al-waleed Shihadeh']
+  gem.email       = 'wshihadh@gmail.com'
+  gem.homepage    = 'https://github.com/shihadeh/fluent-plugin-to-flat-json-parser'
+  gem.description = 'fluentd parser plugin to flatten nested json objects'
+  gem.summary     = gem.description
+  gem.licenses    = ['MIT']
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'fluentd', '~> 1.2.2'
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'rake'
+end

data/lib/fluent/plugin/parser_to_flat_json.rb

@@ -0,0 +1,40 @@
+require 'fluent/plugin/parser'
+
+module Fluent::Plugin
+  class ToFlatJsonParser < JSONParser
+    Fluent::Plugin.register_parser("to_flat_json", self)
+
+    config_param :separator, :string, default: '.'
+
+    def parse(text)
+        r = @load_proc.call(text)
+        time, record = convert_values(parse_time(r), r)
+        record = record_flatten(record)
+        yield time, record
+      rescue @error_class, EncodingError
+        yield nil, nil
+    end
+
+    def record_flatten(record, parent = nil)
+        flattend_record = {}
+        record.each_with_index do |obj, i|
+          if obj.is_a?(Array)
+            k, v = obj
+          else
+            k, v = i, obj
+          end
+
+          key = parent ? "#{parent}#{@separator}#{k}" : k
+          key = key.gsub('.', @separator)
+
+          if v.is_a? Enumerable
+            flattend_record.merge!(record_flatten(v, key))
+          else
+            flattend_record[key] = v
+          end
+        end
+
+        flattend_record
+      end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end

data/test/plugin/test_parser-to-flat-json.rb

@@ -0,0 +1,78 @@
+require 'helper'
+require 'fluent/test/driver/parser'
+require 'fluent/plugin/parser_to_flat_json'
+
+class ParserToFlatJson < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    @parser = Fluent::Test::Driver::Parser.new(Fluent::Plugin::ToFlatJsonParser)
+  end
+
+  data('oj' => 'oj', 'yajl' => 'yajl')
+  def test_parse(data)
+    @parser.configure('json_parser' => data)
+    @parser.instance.parse('{"time":1362020400,"host":"192.168.0.1","size":777,"method":"PUT"}') { |time, record|
+      assert_equal(Fluent::EventTime.parse('2013-02-28 12:00:00 +0900').to_i, time)
+      assert_equal({
+                     'host'   => '192.168.0.1',
+                     'size'   => 777,
+                     'method' => 'PUT',
+                   }, record)
+    }
+  end
+
+  data('oj' => 'oj', 'yajl' => 'yajl')
+  def test_parse_timestamp(data)
+    @parser.configure('json_parser' => data, 'time_key' => 'timestamp')
+    @parser.instance.parse('{"timestamp":1362020400,"host":"192.168.0.1","size":777,"method":"PUT"}') { |time, record|
+      assert_equal(Fluent::EventTime.parse('2013-02-28 12:00:00 +0900').to_i, time)
+      assert_equal({
+                     'host'   => '192.168.0.1',
+                     'size'   => 777,
+                     'method' => 'PUT',
+                   }, record)
+    }
+  end
+
+
+  data('oj' => 'oj', 'yajl' => 'yajl')
+  def test_nasted_parse(data)
+    @parser.configure('json_parser' => data)
+    @parser.instance.parse('{"time":1362020400,"host":"192.168.0.1","obj":{"size":777,"method":"PUT"}') { |time, record|
+      assert_equal(Fluent::EventTime.parse('2013-02-28 12:00:00 +0900').to_i, time)
+      assert_equal({
+                     'host'   => '192.168.0.1',
+                     'obj.size'   => 777,
+                     'obj.method' => 'PUT',
+                   }, record)
+    }
+  end
+
+  data('oj' => 'oj', 'yajl' => 'yajl')
+  def test_nasted_separator_parse(data)
+    @parser.configure('json_parser' => data, 'separator' => '_')
+    @parser.instance.parse('{"time":1362020400,"host":"192.168.0.1","obj":{"size":777,"method":"PUT"}') { |time, record|
+      assert_equal(Fluent::EventTime.parse('2013-02-28 12:00:00 +0900').to_i, time)
+      assert_equal({
+                     'host'   => '192.168.0.1',
+                     'obj_size'   => 777,
+                     'obj_method' => 'PUT',
+                   }, record)
+    }
+  end
+
+  data('oj' => 'oj', 'yajl' => 'yajl')
+  def test_nasted_array_with_separator_parse(data)
+    @parser.configure('json_parser' => data, 'separator' => '_')
+    @parser.instance.parse('{"time":1362020400,"host":"192.168.0.1","mlist":["x","y"],"obj":{"size":777,"method":"PUT"}') { |time, record|
+      assert_equal(Fluent::EventTime.parse('2013-02-28 12:00:00 +0900').to_i, time)
+      assert_equal({
+                     'host'   => '192.168.0.1',
+                     'obj_size'   => 777,
+                     'obj_method' => 'PUT',
+                     'mlist_0' => 'x',
+                     'mlist_1' => 'y',
+                   }, record)
+    }
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-to-flat-json-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Al-waleed Shihadeh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !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'
+- !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'
+description: fluentd parser plugin to flatten nested json objects
+email: wshihadh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-to-flat-json-parser.gemspec
+- lib/fluent/plugin/parser_to_flat_json.rb
+- test/helper.rb
+- test/plugin/test_parser-to-flat-json.rb
+homepage: https://github.com/shihadeh/fluent-plugin-to-flat-json-parser
+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.7.8
+signing_key: 
+specification_version: 4
+summary: fluentd parser plugin to flatten nested json objects
+test_files:
+- test/helper.rb
+- test/plugin/test_parser-to-flat-json.rb