fluent-plugin-json-transform_ex 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 700d72367418f0f7cf2630152aff119cb796e17fcf6aedd25462b73d76893853
-  data.tar.gz: 4f95f6f62c7a7de3d7004f3b1c2a86c556edf2bf2210c5a9c9e67fd7986eceb6
+  metadata.gz: 0b34e98f0fd1c9b05630f8b19f2a2acc2fca65ca6fd383da99ec3498aebd0217
+  data.tar.gz: a47b0d218b4066692f2633761c5c676901ffe00653c2ad448381cdb8f3905672
 SHA512:
-  metadata.gz: 943274519c5c26f54c57419e2be56b61d9483eae83c821e66dea683a32f9edda3d40b61cdbc068442ec1a5349e17855ea04b62322ad528f6de83970857769903
-  data.tar.gz: 5fcc73c15e2cd92a964639e876d91c9e9e479e74b657d527b5f424695cf8fda40f05a0a9c2ae856cbd062d6cad9eafe28ec2ac2bd2fe8a95992cebf48702089e
+  metadata.gz: 3a7de248500408965e503f462f6ac829a460238d947aaca9a7441f9fc2214a870c21cc5a4229b378e82cf7719327a52b18e49b62620faf988bf90a7c3280bb96
+  data.tar.gz: ab2f10af69c219d255cfd1ba40eb6659941d182e79dc5d1c5e9890c6b0ea2309efdd99be7bef8dcc5e002a2cb1cbf4932b6d87c60846e434a07edcbebd6effb5

data/README.md

@@ -3,13 +3,18 @@
 ## Overview
 This is a [parser plugin](http://docs.fluentd.org/articles/parser-plugin-overview) for fluentd. It is **INCOMPATIBLE WITH FLUENTD v0.10.45 AND BELOW.**
 
+It was forker from [fluent-plugin-json-transform](https://github.com/mjourard/fluent-plugin-json-transform) plugin and has the following fixes:
+- Fixing issue when you can't use the same filter plugin multiple times with different scripts.
 
-It was created for the purpose of modifying [**good.js**](https://github.com/hapijs/good) logs
-before storing them in Elasticsearch. It may not be useful for any other purpose, but be creative.
+**Explanation:** there was a sctrict rule that script class should be named as `JSONTransformer`. And when you defined a more than 1 script with different logic, anyway those classes should be named as `JSONTransformer`. As a result you have several scripts with different logic but with the same name.
+
+**Fix:** define new parameter called `class_name` where you can define a custom class name and this is allow you to have a lot of scripts with different class names.
+
+- Adding `params` section with key-value pairs which can be passed to user script for usage.
 
 ## Installation
 ```bash
-gem install fluent-plugin-json-transform_ex --version 0.0.1
+gem install fluent-plugin-json-transform_ex --version 0.1.0
 ```
 
 ## Configuration
@@ -20,6 +25,10 @@ gem install fluent-plugin-json-transform_ex --version 0.0.1
   transform_script [nothing|flatten|custom]
   script_path "/home/grayson/transform_script.rb" # ignored if transform_script != custom
   class_name "CustomJSONTransformer" # [optional] default value is "JSONTransformer", ignored if transform_script != custom
+  <params> # any parameters which will be passed to "transform" method of class_name class
+    key1 value1
+    key2 value2
+  </params>
 </source>
 ```
 
@@ -64,6 +73,10 @@ If you want to flatten your json after doing other parsing from the original sou
   transform_script [nothing|flatten|custom]
   script_path "/home/grayson/transform_script.rb" # ignored if transform_script != custom
   class_name "CustomJSONTransformer" # [optional] default value is "JSONTransformer", ignored if transform_script != custom
+  <params> # any parameters which will be passed to "transform" method of class_name class
+    key1 value1
+    key2 value2
+  </params>
 </filter>
 ```
 
@@ -75,7 +88,7 @@ The transformer class should have an instance method `transform` which takes a R
 ```ruby
 # lib/transform/flatten.rb
 class JSONTransformer # or any class name defined in class_name parameter
-  def transform(json)
+  def transform(json, params = {}) # params - [optional] passed parameters from config
     return flatten(json, "")
   end
 
@@ -100,4 +113,4 @@ class JSONTransformer # or any class name defined in class_name parameter
     return json
   end
 end
-```
+```

data/fluent-plugin-json-transform_ex.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-json-transform_ex"
-  spec.version       = "0.1.0"
+  spec.version       = "0.1.3"
   spec.authors       = ["Grayson Chao", "Yevhen Fabizhevskyi"]
   spec.email         = ["grayson.chao@gmail.com", "fabasoad@gmail.com"]
   spec.description   = %q{Input parser plugin which allows arbitrary transformation of input JSON}

data/lib/fluent/plugin/filter_json_transform_ex.rb

@@ -13,6 +13,18 @@ module Fluent
     def configure(conf)
       @transform_script = conf['transform_script']
 
+      @params = {}
+      $log.info("Searching for 'params'...")
+      conf.elements.each do |element|
+        if element.name == 'params'
+          element.to_hash.each do |key, value|
+            @params[key] = value
+          end
+          $log.info("'params' section found: #{@params}") if @params.length > 0
+        end
+      end
+      $log.info("'params' is not found or passed nothing") if @params.empty?
+
       if DEFAULTS.include?(@transform_script)
         @transform_script = "#{__dir__}/../../transform/#{@transform_script}.rb"
         className = DEFAULT_CLASS_NAME
@@ -24,13 +36,15 @@ module Fluent
       require @transform_script
       begin
         @transformer = Object.const_get(className).new
+        $log.debug("#{className} class is loaded.")
       rescue NameError
         @transformer = Object.const_get(DEFAULT_CLASS_NAME).new
+        $log.debug("#{DEFAULT_CLASS_NAME} class is loaded.")
       end
     end
 
     def filter(tag, time, record)
-      return @transformer.transform(record)
+      return @transformer.transform(record, @params)
     end
   end
 end

data/lib/fluent/plugin/parser_json_transform_ex.rb

@@ -12,6 +12,18 @@ module Fluent
       def configure(conf)
         @transform_script = conf['transform_script']
 
+        @params = {}
+        $log.info("Searching for 'params'...")
+        conf.elements.each do |element|
+          if element.name == 'params'
+            element.to_hash.each do |key, value|
+              @params[key] = value
+            end
+            $log.info("'params' section found: #{@params}") if @params.length > 0
+          end
+        end
+        $log.info("'params' is not found or passed nothing") if @params.empty?
+
         if DEFAULTS.include?(@transform_script)
           @transform_script = "#{__dir__}/../../transform/#{@transform_script}.rb"
           className = DEFAULT_CLASS_NAME
@@ -30,12 +42,12 @@ module Fluent
 
       def call(text)
         raw_json = JSON.parse(text)
-        return nil, @transformer.transform(raw_json)
+        return nil, @transformer.transform(raw_json, @params)
       end
 
       def parse(text)
         raw_json = JSON.parse(text)
-        return nil, @transformer.transform(raw_json)
+        return nil, @transformer.transform(raw_json, @params)
       end
     end
   register_template("json_transform_ex", Proc.new { JSONTransformParser.new })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-json-transform_ex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Grayson Chao
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler