fluent-plugin-array-splitter 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d04da9205757d519b782b4f8603c6cd5999a0ca1ed15d50044ab9600259d200
-  data.tar.gz: c97d3587db8921bf2b25ca8b930b6e0e96dcc6e47f41ad2169a48775073217cc
+  metadata.gz: 8cea5ad4ac184f61f7d06d8622302aa980515a9b446f1e0113981dcdb886c149
+  data.tar.gz: 2e677713dc26b1f3d3e37785c6dba12f2d15eff1f51aefe49731972c67f263b8
 SHA512:
-  metadata.gz: 720519d90f4c95983ec89fc616626cce0712be211673724d3f8db15e2bd0a4e562dd196344a13127f4c177c923ee5018c0ad98b19be27ee71f189868a43216c1
-  data.tar.gz: 40d369cb984e7b01125328e98df4c01b0c5a7f6725fae82d55a26e7cd8ab37001474a14913f4cd27c34260cf71ab4a115df69ddc9c8a9298da4339e7dc8b41cf
+  metadata.gz: c738b1b8182e357ea6d2d18cdf4165136c2a993fd0208780852d12b657866e1b372079513ccaaed0836f7cc8041117a7d86de803611b5d9528f02f04fc9ef82c
+  data.tar.gz: 6a77e6070bf38b21e087d1b42fcb3dc5b6808545d06c28802f27bab4b14d3d37e9abdffb176bcc084fe86bbfa452c32bf5f94d3ae87c2765c5c3ca7a0a63f8cf

data/README.md

@@ -1,8 +1,7 @@
 # fluent-plugin-array-splitter
 
-[Fluentd](https://fluentd.org/) filter plugin to do something.
-
-TODO: write description for you plugin.
+## Overview
+This [Fluentd](https://fluentd.org/) filter plugin allows you to split array values within json formatted log records.
 
 ## Installation
 
@@ -28,16 +27,48 @@ $ bundle
 
 ## Configuration
 
-You can generate configuration template:
+### Parameters
+
+|parameter|type|description|default|
+|---|---|---|---|
+|array_key|string (required)|The target field name to split array values||
+|key_name|string (optional)|The field name to rename the key of a single array element|nil|
+
+### Example Configuration
+
+```
+<filter pattern>
+  @type array_splitter
+  array_key message
+  key_name new_key
+</filter>
+```
+
+## Usage
 
+With the above configuration, an input like:
 ```
-$ fluent-plugin-config-format filter array_splitter
+{"message": ["value1", "value2"]}
 ```
 
-You can copy and paste generated documents here.
+will result in two records:
+```
+{"new_key": "value1"}
+{"new_key": "value2"}
+```
+
+If you have an input like:
+```
+{"message": [{"key1": "value1"}, {"key2": "value2"}]}
+```
+will result as follows:
+```
+{"key1": "value1"}
+{"key2": "value2"}
+```
 
 ## Copyright
 
 * Copyright(c) 2023- pcoffmanjr
 * License
-  * 
+  * MIT License

data/fluent-plugin-array-splitter.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-array-splitter"
-  spec.version = "0.1.1"
+  spec.version = "0.1.3"
   spec.authors = ["pcoffmanjr"]
   spec.email   = ["pcoffman@ctc-america.com"]
 
@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.1.2"
   spec.add_development_dependency "rake", "~> 13.0.6"
   spec.add_development_dependency "test-unit", "~> 3.3.9"
-  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+  spec.add_runtime_dependency "fluentd", [">= 1.11.1", "< 2"]
 end

data/lib/fluent/plugin/filter_array_splitter.rb

@@ -1,3 +1,24 @@
+# MIT License
+
+# Copyright (c) 2023 pcoffmanjr
+
+# 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.
 
 
 require "fluent/plugin/filter"
@@ -7,34 +28,42 @@ module Fluent
     class ArraySplitterFilter < Fluent::Plugin::Filter
       Fluent::Plugin.register_filter("array_splitter", self)
 
+      desc 'The field name to split and expand array values'
+      config_param :array_key, :string, default: 'message'
+
+      desc 'The field name to rename the key of a single array element'
+      config_param :key_name, :string, default: nil
+
       def configure(conf)
         super
+        raise Fluent::ConfigError, "'array_key' parameter is required" unless conf.has_key?('array_key')
         log.info "Configuring Array Splitter Filter"
       end
 
       def filter_stream(tag, es)
         new_es = Fluent::MultiEventStream.new
+
         es.each do |time, record|
-          if record['message'].is_a?(Array)
-            record['message'].each do |value|
+          if record[@array_key].is_a?(Array)
+            record[@array_key].each do |value|
               new_record = record.dup
-              new_record.delete('message')
+              new_record.delete(@array_key)
+
               if value.is_a?(Hash)
-                value.each do |k, v|
-                  new_record[k] = v 
-                end
+                value.each { |k, v| new_record[k] = v }
               else
-                new_record['message'] = value
+                new_record[@key_name.nil? ? @array_key : @key_name] = value
               end
+
               new_es.add(time, new_record)
             end
           else
             new_es.add(time, record)
           end
         end
+
         new_es
       end
     end
   end
 end
-

data/test/plugin/test_filter_array_splitter.rb

@@ -4,7 +4,9 @@ require "fluent/plugin/filter_array_splitter.rb"
 class ArraySplitterFilterTest < Test::Unit::TestCase
   setup do
     Fluent::Test.setup
-    @driver = create_driver
+    @driver = create_driver(%[
+      array_key message
+    ])
   end
 
   def create_driver(conf = "")
@@ -28,7 +30,7 @@ class ArraySplitterFilterTest < Test::Unit::TestCase
       assert_equal("v2", filtered_records[1]["message"])
       assert_equal("v3", filtered_records[2]["message"])
     end
-    
+
     test "expand array with hashes in message field" do
       record = {
         "key1" => "foo",
@@ -49,6 +51,25 @@ class ArraySplitterFilterTest < Test::Unit::TestCase
       assert_equal("foobar", filtered_records[1]["k2"])
       assert_nil(filtered_records[1]["message"])
     end
+
+    test "expand array with custom key" do
+      driver = create_driver(%[
+        array_key record
+      ])
+      record = {
+        "key1" => "foo",
+        "key2" => "bar",
+        "record" => ["v1", "v2", "v3"]
+      }
+      driver.run(default_tag: "test") do
+        driver.feed(record)
+      end
+      filtered_records = driver.filtered_records
+      assert_equal(3, filtered_records.size)
+      assert_equal("v1", filtered_records[0]["record"])
+      assert_equal("v2", filtered_records[1]["record"])
+      assert_equal("v3", filtered_records[2]["record"])
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-array-splitter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - pcoffmanjr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.10
+        version: 1.11.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -68,7 +68,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.10
+        version: 1.11.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'