fluent-plugin-filter-split 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c1983a76ed0085ced99d9fb627e44d17a457d60b1e1eb238fe9959efe3365282
4
+ data.tar.gz: 48f7d2404b86c7d8c1c6105daec974da29132f0ce5987bfdd419f0714e2ca138
5
+ SHA512:
6
+ metadata.gz: d4f93b990053dd5e6d6f63ec893d9955019848de0d71aa087a8376fff2b4c55f379bb0ef1c6c786eb8c97c9fbfa2e6fd9b84ef052517417835d05be9e26ec2de
7
+ data.tar.gz: 10edaada9cbdffa3bddc8eac2f0be95b861b671487cdc72ab5026f8513b1281e30d238c178cb58a482754b48aefdb98a52ca3c6df1526a1059d177e252ff99e8
@@ -0,0 +1,30 @@
1
+ name: Testing on Ubuntu
2
+ on:
3
+ - push
4
+ - pull_request
5
+ jobs:
6
+ build:
7
+ runs-on: ${{ matrix.os }}
8
+ strategy:
9
+ fail-fast: false
10
+ matrix:
11
+ ruby:
12
+ - 2.7
13
+ - 3.0
14
+ - 3.1
15
+ - 3.2
16
+ os:
17
+ - ubuntu-latest
18
+ name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+ - uses: ruby/setup-ruby@v1
22
+ with:
23
+ ruby-version: ${{ matrix.ruby }}
24
+ - name: unit testing
25
+ env:
26
+ CI: true
27
+ run: |
28
+ gem install bundler rake
29
+ bundle install --jobs 4 --retry 3
30
+ bundle exec rake test
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,94 @@
1
+ # fluent-plugin-filter-split
2
+
3
+ [Fluentd](https://fluentd.org/) filter plugin to split specified field.
4
+
5
+ Compared to existing plugins:
6
+
7
+ * https://github.com/wshihadeh/fluent-plugin-record-splitter
8
+ * This is filter plugin. It splits the specified field into multiple records. The target field must be lines.
9
+ * https://github.com/unquietwiki/fluent-plugin-split_record
10
+ * This is filter plugin. It splits the specified field into key/value pairs. The target field must contain "key=value" pairs.
11
+ * https://github.com/SNakano/fluent-plugin-split-array
12
+ * This is filter plugin. It splits the specified field into multiple records. The target field must be always array.
13
+ * https://github.com/toyama0919/fluent-plugin-split
14
+ * This is output plugin. It splits the specified field into multiple records. The target field must contains specific separator.
15
+ * https://github.com/activeshadow/fluent-plugin-split-event
16
+ * This is filter plugin. It splits the specified field into multiple records. The target field must contains specific separator.
17
+ * https://github.com/bitpatty/fluent-plugin-filter-split-message
18
+ * 404. The only gem exists. https://rubygems.org/gems/fluent-plugin-filter-split-message
19
+ * This is filter plugin. It splits the specified field into multiple records. The target field must contains specific separator.
20
+
21
+ Thus, about above plugins, there are limitation of type of field or missing feature to control keep/remove other fields.
22
+
23
+ ## Installation
24
+
25
+ ### RubyGems
26
+
27
+ ```
28
+ $ gem install fluent-plugin-filter-split
29
+ ```
30
+
31
+ ### Bundler
32
+
33
+ Add following line to your Gemfile:
34
+
35
+ ```ruby
36
+ gem "fluent-plugin-filter-split"
37
+ ```
38
+
39
+ And then execute:
40
+
41
+ ```
42
+ $ bundle
43
+ ```
44
+
45
+ ## Configuration
46
+
47
+ |parameter|type|description|default|
48
+ |---|---|---|---|
49
+ |split_key|string (required)|Specify a target key to split||
50
+ |keep_other_key|bool (optional)|Specify a flag whether other key must be kept or not|`false`|
51
+ |keep_keys|array (optional)|Specify keys to be kept in filtered record|`[]`|
52
+ |remove_keys|array (optional)|Specify keys to be removed in filtered record|`[]`|
53
+
54
+ ## Example
55
+
56
+ ```
57
+ <filter test>
58
+ @type filter_split
59
+ split_key target_field
60
+ keep_other_key true
61
+ </filter>
62
+ ```
63
+
64
+ If following record is passed:
65
+
66
+ ```
67
+ {'foo:'bar', 'target_field':[ {'k1':'v1'}, {'k2':'v2'} ] }
68
+ ```
69
+
70
+ Then, you got:
71
+
72
+ ```
73
+ {'foo:'bar', 'k1':'v1'}
74
+ {'foo:'bar', 'k2':'v2'}
75
+ ```
76
+
77
+ If following record is passed:
78
+
79
+ ```
80
+ {'foo:'bar', 'target_field':[ 'v1', 'v2' ] }
81
+ ```
82
+
83
+ Then, you got:
84
+
85
+ ```
86
+ {'foo:'bar', 'target_field':'v1'}
87
+ {'foo:'bar', 'target_field':'v2'}
88
+ ```
89
+
90
+ ## Copyright
91
+
92
+ * Copyright(c) 2023- Kentaro Hayashi
93
+ * License
94
+ * Apache License, Version 2.0
data/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ require "bundler"
2
+ Bundler::GemHelper.install_tasks
3
+
4
+ require "rake/testtask"
5
+
6
+ Rake::TestTask.new(:test) do |t|
7
+ t.libs.push("lib", "test")
8
+ t.test_files = FileList["test/**/test_*.rb"]
9
+ t.verbose = true
10
+ t.warning = true
11
+ end
12
+
13
+ task default: [:test]
@@ -0,0 +1,27 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+
4
+ Gem::Specification.new do |spec|
5
+ spec.name = "fluent-plugin-filter-split"
6
+ spec.version = "0.1.0"
7
+ spec.authors = ["Kentaro Hayashi"]
8
+ spec.email = ["hayashi@clear-code.com"]
9
+
10
+ spec.summary = %q{Flexible filter plugin to split record for Fluentd}
11
+ spec.description = %q{It works as record splitter in filter stage.}
12
+ spec.homepage = "https://github.com/fluent-plugins-nursery/fluent-plugin-filter-split"
13
+ spec.license = "Apache-2.0"
14
+
15
+ test_files, files = `git ls-files -z`.split("\x0").partition do |f|
16
+ f.match(%r{^(test|spec|features)/})
17
+ end
18
+ spec.files = files
19
+ spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
20
+ spec.test_files = test_files
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 2.4.19"
24
+ spec.add_development_dependency "rake", "~> 13.0.6"
25
+ spec.add_development_dependency "test-unit", "~> 3.6.1"
26
+ spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
27
+ end
@@ -0,0 +1,106 @@
1
+ #
2
+ # Copyright 2023- Kentaro Hayashi
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ require 'fluent/plugin/filter'
17
+ require 'fluent/config/error'
18
+ require 'fluent/event'
19
+ require 'fluent/time'
20
+
21
+ module Fluent
22
+ module Plugin
23
+ class FilterSplitFilter < Fluent::Plugin::Filter
24
+ Fluent::Plugin.register_filter("filter_split", self)
25
+
26
+ helpers :record_accessor
27
+
28
+ desc 'Specify a target key to split'
29
+ config_param :split_key, :string
30
+ desc 'Specify a flag whether other key must be kept or not'
31
+ config_param :keep_other_key, :bool, default: false
32
+ desc 'Specify keys to be kept in filtered record'
33
+ config_param :keep_keys, :array, default: []
34
+ desc 'Specify keys to be removed in filtered record'
35
+ config_param :remove_keys, :array, default: []
36
+
37
+ def configure(conf)
38
+ super
39
+ if !@keep_keys.empty? && !@remove_keys.empty?
40
+ raise Fluent::ConfigError, 'Cannot set both keep_keys and remove_keys.'
41
+ end
42
+ if @keep_other_key && !@keep_keys.empty?
43
+ raise Fluent::ConfigError, 'Cannot set keep_keys when keep_other_key is true.'
44
+ end
45
+ if !@keep_other_key && !@remove_keys.empty?
46
+ raise Fluent::ConfigError, 'Cannot set remove_keys when keep_other_key is false.'
47
+ end
48
+ end
49
+
50
+ def filter_stream(tag, es)
51
+ new_es = Fluent::MultiEventStream.new
52
+ es.each do |time, record|
53
+ begin
54
+ unless record.key?(@split_key)
55
+ new_es.add(time, record)
56
+ next
57
+ end
58
+
59
+ keyvalues = if @keep_other_key
60
+ other_keyvalues(record)
61
+ else
62
+ remained_keyvalues(record)
63
+ end
64
+
65
+ unless record[@split_key].is_a?(Array)
66
+ new_es.add(time, record)
67
+ log.warn "failed to split with <#{@split_key}> key because the target field is not Array: <#{record[@split_key]}>."
68
+ next
69
+ end
70
+
71
+ record[@split_key].each do |v|
72
+ unless keyvalues.empty?
73
+ if v.is_a?(Hash)
74
+ v.merge!(keyvalues)
75
+ else
76
+ v = {"#{@split_key}": v}.merge(keyvalues)
77
+ end
78
+ else
79
+ unless v.is_a?(Hash)
80
+ v = {"#{@split_key}" => v}
81
+ end
82
+ end
83
+ new_es.add(time, v)
84
+ end
85
+ rescue => e
86
+ router.emit_error_event(tag, time, record, e)
87
+ log.warn "failed to split with <#{@split_key} key." , error: e
88
+ end
89
+ end
90
+ new_es
91
+ end
92
+
93
+ private
94
+
95
+ def remained_keyvalues(record)
96
+ record.select { |key, _value| @keep_keys.include?(key) }
97
+ end
98
+
99
+ def other_keyvalues(record)
100
+ record.reject do |key, _value|
101
+ key == @split_key || @remove_keys.include?(key)
102
+ end
103
+ end
104
+ end
105
+ end
106
+ end
data/test/helper.rb ADDED
@@ -0,0 +1,7 @@
1
+ require "test-unit"
2
+ require "fluent/test"
3
+ require "fluent/test/driver/filter"
4
+ require "fluent/test/helpers"
5
+
6
+ Test::Unit::TestCase.include(Fluent::Test::Helpers)
7
+ Test::Unit::TestCase.extend(Fluent::Test::Helpers)
@@ -0,0 +1,235 @@
1
+ require "helper"
2
+ require "fluent/plugin/filter_filter_split.rb"
3
+
4
+ class FilterSplitFilterTest < Test::Unit::TestCase
5
+ setup do
6
+ Fluent::Test.setup
7
+ end
8
+
9
+ sub_test_case 'configure' do
10
+ test '@type only failure' do
11
+ assert_raise Fluent::ConfigError.new("'split_key' parameter is required") do
12
+ create_driver %(
13
+ @type filter_split
14
+ )
15
+ end
16
+ end
17
+
18
+ test 'check required split_key' do
19
+ assert_nothing_raised do
20
+ create_driver %(
21
+ @type filter_split
22
+ split_key target_field
23
+ )
24
+ end
25
+ end
26
+
27
+ test 'both of keep_keys and remove_keys should not be specified' do
28
+ assert_raise Fluent::ConfigError.new('Cannot set both keep_keys and remove_keys.') do
29
+ create_driver %(
30
+ @type filter_split
31
+ split_key target_field
32
+ keep_keys keep_field
33
+ remove_keys remove_field
34
+ )
35
+ end
36
+ end
37
+
38
+ test 'keep_keys and keep_other_key are conflicted' do
39
+ assert_raise Fluent::ConfigError.new('Cannot set keep_keys when keep_other_key is true.') do
40
+ create_driver %(
41
+ @type filter_split
42
+ split_key target_field
43
+ keep_keys keep_field
44
+ keep_other_key true
45
+ )
46
+ end
47
+ end
48
+
49
+ test 'remove_keys and keep_other_key are conflicted' do
50
+ assert_raise Fluent::ConfigError.new('Cannot set remove_keys when keep_other_key is false.') do
51
+ create_driver %(
52
+ @type filter_split
53
+ split_key target_field
54
+ remove_keys remove_field
55
+ )
56
+ end
57
+ end
58
+ end
59
+
60
+ TARGET_FIELD_VALUES = [{ 'k1' => 'v1' }, { 'k2' => 'v2' }]
61
+
62
+ sub_test_case 'split_key' do
63
+ test 'nonexistent split_key does not affect' do
64
+ d = create_driver %(
65
+ @type filter_split
66
+ tag foo
67
+ split_key nonexistent
68
+ )
69
+ d.run(default_tag: 'test') do
70
+ d.feed(event_time,
71
+ 'other' => 'foo',
72
+ 'target_field' => TARGET_FIELD_VALUES)
73
+ end
74
+ assert_equal [
75
+ [event_time, {'other' => 'foo', 'target_field' => TARGET_FIELD_VALUES}]
76
+ ], d.filtered
77
+ end
78
+
79
+ test 'split target_field' do
80
+ d = create_driver %(
81
+ @type filter_split
82
+ split_key target_field
83
+ )
84
+ d.run(default_tag: 'test') do
85
+ d.feed(event_time,
86
+ 'other' => 'foo',
87
+ # can't pass TARGET_FIELD_VALUES here. it break test
88
+ 'target_field' => [{'k1'=>'v1'},{'k2'=>'v2'}])
89
+ end
90
+ assert_equal [
91
+ [event_time, { 'k1' => 'v1' }],
92
+ [event_time, { 'k2' => 'v2' }]
93
+ ], d.filtered
94
+ end
95
+
96
+ test 'split target_field is not array' do
97
+ d = create_driver %(
98
+ @type filter_split
99
+ split_key target_field
100
+ )
101
+ d.run(default_tag: 'test') do
102
+ d.feed(event_time,
103
+ 'other' => 'foo',
104
+ 'target_field' => nil)
105
+ end
106
+ assert_equal [
107
+ [event_time, { 'other' => 'foo', 'target_field' => nil }],
108
+ ], d.filtered
109
+ matched = d.logs.grep(/\[warn\]: failed to split with <target_field> key because the target field is not Array:/)
110
+ assert_equal(1, matched.size)
111
+ end
112
+
113
+ test 'split target_field with array of scalar' do
114
+ d = create_driver %(
115
+ @type filter_split
116
+ split_key target_field
117
+ )
118
+ d.run(default_tag: 'test') do
119
+ d.feed(event_time,
120
+ 'other' => 'foo',
121
+ 'target_field' => [ 'v1', 'v2', 'v3'])
122
+ end
123
+ assert_equal [
124
+ [event_time, { 'target_field' => 'v1' }],
125
+ [event_time, { 'target_field' => 'v2' }],
126
+ [event_time, { 'target_field' => 'v3' }]
127
+ ], d.filtered
128
+ end
129
+ end
130
+
131
+ sub_test_case 'keep_keys' do
132
+ test 'keep other field' do
133
+ d = create_driver %(
134
+ @type filter_split
135
+ split_key target_field
136
+ keep_keys other
137
+ )
138
+ d.run(default_tag: 'test') do
139
+ d.feed(event_time,
140
+ 'other' => 'foo',
141
+ 'target_field' => TARGET_FIELD_VALUES)
142
+ end
143
+ assert_equal [
144
+ [event_time, { 'other' => 'foo', 'k1' => 'v1' }],
145
+ [event_time, { 'other' => 'foo', 'k2' => 'v2' }]
146
+ ], d.filtered
147
+ end
148
+
149
+ test 'keep nonexistent field' do
150
+ d = create_driver %(
151
+ @type filter_split
152
+ split_key target_field
153
+ keep_keys nonexistent
154
+ )
155
+ d.run(default_tag: 'test') do
156
+ d.feed(event_time,
157
+ 'other' => 'foo',
158
+ 'target_field' => TARGET_FIELD_VALUES)
159
+ end
160
+ assert_equal [
161
+ [event_time, { 'k1' => 'v1' }],
162
+ [event_time, { 'k2' => 'v2' }]
163
+ ], d.filtered
164
+ end
165
+ end
166
+
167
+ sub_test_case 'remove_keys' do
168
+ test 'remove other field' do
169
+ d = create_driver %(
170
+ @type filter_split
171
+ split_key target_field
172
+ remove_keys other
173
+ keep_other_key true
174
+ )
175
+ d.run(default_tag: 'test') do
176
+ d.feed(event_time,
177
+ 'general' => 'foo',
178
+ 'other' => 'bar',
179
+ # can't pass TARGET_FIELD_VALUES here. it break test
180
+ 'target_field' => [{'k1'=>'v1'},{'k2'=>'v2'}])
181
+ end
182
+ assert_equal [
183
+ [event_time, { 'general' => 'foo', 'k1' => 'v1' }],
184
+ [event_time, { 'general' => 'foo', 'k2' => 'v2' }]
185
+ ], d.filtered
186
+ end
187
+
188
+ test 'remove nonexistent field' do
189
+ d = create_driver %(
190
+ @type filter_split
191
+ split_key target_field
192
+ remove_keys nonexistent
193
+ keep_other_key true
194
+ )
195
+ d.run(default_tag: 'test') do
196
+ d.feed(event_time,
197
+ 'other' => 'foo',
198
+ 'target_field' => TARGET_FIELD_VALUES)
199
+ end
200
+ assert_equal [
201
+ [event_time, { 'other' => 'foo', 'k1' => 'v1' }],
202
+ [event_time, { 'other' => 'foo', 'k2' => 'v2' }]
203
+ ], d.filtered
204
+ end
205
+ end
206
+
207
+ sub_test_case 'keep_other_key' do
208
+ test 'keep other field' do
209
+ d = create_driver %(
210
+ @type filter_split
211
+ split_key target_field
212
+ keep_other_key true
213
+ )
214
+ d.run(default_tag: 'test') do
215
+ d.feed(event_time,
216
+ 'other' => 'foo',
217
+ 'target_field' => TARGET_FIELD_VALUES)
218
+ end
219
+ assert_equal [
220
+ [event_time, {'other' => 'foo', 'k1' => 'v1' }],
221
+ [event_time, {'other' => 'foo', 'k2' => 'v2' }]
222
+ ], d.filtered
223
+ end
224
+ end
225
+
226
+ private
227
+
228
+ def create_driver(conf = '')
229
+ Fluent::Test::Driver::Filter.new(Fluent::Plugin::FilterSplitFilter).configure(conf)
230
+ end
231
+
232
+ def event_time
233
+ Time.parse('2023-10-23 00:11:22 UTC').to_i
234
+ end
235
+ end
metadata ADDED
@@ -0,0 +1,116 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: fluent-plugin-filter-split
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Kentaro Hayashi
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2023-10-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 2.4.19
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 2.4.19
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 13.0.6
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 13.0.6
41
+ - !ruby/object:Gem::Dependency
42
+ name: test-unit
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 3.6.1
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 3.6.1
55
+ - !ruby/object:Gem::Dependency
56
+ name: fluentd
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: 0.14.10
62
+ - - "<"
63
+ - !ruby/object:Gem::Version
64
+ version: '2'
65
+ type: :runtime
66
+ prerelease: false
67
+ version_requirements: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: 0.14.10
72
+ - - "<"
73
+ - !ruby/object:Gem::Version
74
+ version: '2'
75
+ description: It works as record splitter in filter stage.
76
+ email:
77
+ - hayashi@clear-code.com
78
+ executables: []
79
+ extensions: []
80
+ extra_rdoc_files: []
81
+ files:
82
+ - ".github/workflows/linux.yml"
83
+ - Gemfile
84
+ - LICENSE
85
+ - README.md
86
+ - Rakefile
87
+ - fluent-plugin-filter-split.gemspec
88
+ - lib/fluent/plugin/filter_filter_split.rb
89
+ - test/helper.rb
90
+ - test/plugin/test_filter_filter_split.rb
91
+ homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-filter-split
92
+ licenses:
93
+ - Apache-2.0
94
+ metadata: {}
95
+ post_install_message:
96
+ rdoc_options: []
97
+ require_paths:
98
+ - lib
99
+ required_ruby_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ required_rubygems_version: !ruby/object:Gem::Requirement
105
+ requirements:
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: '0'
109
+ requirements: []
110
+ rubygems_version: 3.4.10
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Flexible filter plugin to split record for Fluentd
114
+ test_files:
115
+ - test/helper.rb
116
+ - test/plugin/test_filter_filter_split.rb