fluent-plugin-record_indexing 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 033425b882af2c7a8cfc88fcf822fe582214eeab990b07fd1dbe31c12df8f5ac
-  data.tar.gz: 2368227e5bf02a0c86c9b21a5f6ed4b6f8f9ebec9b2722b9fc03903263c4cce7
+  metadata.gz: cda0290a81edfabb93f0dc7739dc1889c2e7f599b3ee674c0baaffebfb7d2a7d
+  data.tar.gz: 0b9a9a50bc274c4e1c2aef91482bbbb7c7ea3e0c047dc5fe192735cc03623765
 SHA512:
-  metadata.gz: 0e046669d2eb9fbfbd0c69e1354a3cb93331e1cb4a267aa5769b26ae5a28c3d2988db9bc49a860a9ea5f00fe24c571a3d02052c0fc13b9c2245b7fb99ac01c1b
-  data.tar.gz: 17a7d7c7d9ede5aa87db54a83fbed0116d5a1eced3a2cada1be24fadf643ff64841ccc10de5550260641180960060c00a211e69053b55d7b189e936bb80fc9f9
+  metadata.gz: 196d17bfa5b24665b6e1a4d2bda1d0b100032dc30fa6da1e91ed9567444ec8d99a4224daf1df4135e1a5e97dc90d1b2d7494df96639bc82372f44f7eb6fdbc75
+  data.tar.gz: 5831f0607dfb888932a4d7476a7e8bb1fd247a2c3e82a1e0a34b0a0cae77276715b579579d3723cb42d2f0f6bad5d5602cd296ba66e585ad4e4056374c341fd8

data/README.md

@@ -1,13 +1,13 @@
 # fluent-plugin-record_indexing
 
-[Fluentd](https://fluentd.org/) Filter plugin to spin entry with an array field into multiple entries.
+[Fluentd](https://www.fluentd.org) Filter plugin to spin entry with an array field into multiple entries.
 
 ## Examples
 ```
 <filter test**>
     @type                 record_indexing
     check_all_key         false
-    key_name              baz
+    key_names              baz
     key_prefix            baz_0
 </filter>
 
@@ -20,7 +20,7 @@ Out:
 <filter test**>
     @type                 record_indexing
     check_all_key         false
-    key_name              baz
+    key_names              baz
 </filter>
 
 In:
@@ -39,13 +39,36 @@ In:
 Out:
 {"foo"=>"bar", "baz"=>{"0"=>{"a"=>1} , "1"=>{"a"=>2}, "2"=>{"b"=>3}}, "daz"=>{"0"=>{"a"=>1} , "1"=>{"a"=>2}, "2"=>{"b"=>3}}}
 ```
+```
+<filter test**>
+    @type                 record_indexing
+    check_all_key         false
+    key_names              baz,daz
+</filter>
+
+In:
+{"foo" => "bar", "baz"=>[{"a"=>1}, {"a"=>2}, {"b"=>3}] , "daz" => [{"a"=>1}, {"a"=>2}, {"b"=>3}]}
+Out:
+{"foo"=>"bar", "baz"=>{"0"=>{"a"=>1} , "1"=>{"a"=>2}, "2"=>{"b"=>3}}, "daz"=>{"0"=>{"a"=>1} , "1"=>{"a"=>2}, "2"=>{"b"=>3}}}
+```
+```
+<filter test**>
+    @type                record_indexing
+    exclude_keys         baz
+</filter>
+
+In:
+{"foo" => "bar", "baz"=>[{"a"=>1}, {"a"=>2}, {"b"=>3}] , "daz" => [{"a"=>1}, {"a"=>2}, {"b"=>3}]}
+Out:
+{"foo"=>"bar", "baz"=>[{"a"=>1}, {"a"=>2}, {"b"=>3}], "2"=>{"b"=>3}}, "daz"=>{"0"=>{"a"=>1} , "1"=>{"a"=>2}, "2"=>{"b"=>3}}}
+```
 
 ## Installation
 
 ### RubyGems
 
 ```
-$ gem install fluent-plugin-array-spin
+$ gem install fluent-plugin-record_indexing
 ```
 
 ### Bundler
@@ -64,8 +87,9 @@ $ bundle
 
 ## Configuration
 
-* **key_name** (string)
-* **key_prefix** (string)
+* **key_names** (array) default: []
+* **key_prefix** (string) default: nil
+* **exclude_keys** (array) default: [] Use this parameter if you need to keep the value as is without indexing
 * **check_all_key**  (bool) default: true
 
 
@@ -73,4 +97,4 @@ $ bundle
 
 * Copyright(c) 2017, Tema Novikov
 * License
-  * Apache License, Version 2.0
+  * Apache License, Version 2.0

data/fluent-plugin-record_indexing.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-record_indexing"
-  spec.version       = "0.2.0"
+  spec.version       = "0.2.2"
   spec.authors       = ["imcotop"]
   spec.email         = ["imcotop@icloud.com"]
 

data/lib/fluent/plugin/filter_record_indexing.rb

@@ -3,16 +3,17 @@ require "fluent/filter"
 module Fluent
   class RecordIndexingFilter < Filter
     Fluent::Plugin.register_filter("record_indexing", self)
-    
-    desc "Key name to spin"
-    config_param :key_name, :string, default: nil
+
+    desc "Key names to spin"
+    config_param :key_names, :array, default: []
     config_param :key_prefix, :string, default: nil
     config_param :check_all_key, :bool, default: true
-    
+    config_param :exclude_keys, :array, default: []
+
     def filter(tag, time, record)
       if check_all_key == false
-        unless key_name
-          raise ArgumentError, "key_name parameter is required if check_all_key set false"
+        unless key_names.any?
+          raise ArgumentError, "key_names parameter is required if check_all_key set false"
         end
       end
       new_record = {}
@@ -21,30 +22,34 @@ module Fluent
       new_record
     end
 
-    def is_nested_field?(field_value)
-      field_value.is_a?(Hash)
-    end
-  
     def each_with_index(record, new_record)
       record.each do |key, value|
-        if check_all_key || key == key_name
-          if value.nil?
-            next  # Skip if the value is nil
+        if check_all_key || key_names.include?(key)
+          if exclude_keys.include?(key)
+            new_record[key] = value  # Keep the value as is without indexing
           elsif value.is_a?(Array)
-            new_record[key] = {}
-            value.each_with_index do |item, index|
-              new_record[key]["#{key_prefix}#{index}"] = item unless item.nil?
+            if value.length == 1
+              new_record[key] = value.first
+            else
+              new_record[key] = {}
+              value.each_with_index do |item, index|
+                new_record[key]["#{key_prefix}#{index}"] = item
+              end
             end
-          elsif is_nested_field?(value)
+          elsif value.is_a?(Hash)
             new_record[key] = {}
             each_with_index(value, new_record[key])
           else
             new_record[key] = value
           end
+        elsif value.is_a?(Hash)  # Check if the value is a nested Hash
+          new_record[key] = {}
+          each_with_index(value, new_record[key])  # Recursively index nested fields
         else
           new_record[key] = value
         end
       end
+      new_record
     end
 
     def remove_empty_fields(record)
@@ -57,3 +62,4 @@ module Fluent
     end
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-record_indexing
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - imcotop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A fluentd filter plugin that will be used to Iterate over the object with