fluent-plugin-event-collector 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.byebug_history +11 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +52 -0
- data/LICENSE +202 -0
- data/README.md +56 -0
- data/Rakefile +13 -0
- data/fluent-plugin-event-collector.gemspec +28 -0
- data/lib/fluent/plugin/filter_event_collector.rb +126 -0
- data/test/helper.rb +8 -0
- data/test/plugin/test_filter_event_collector.rb +118 -0
- metadata +132 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 146231cd93a07178cbe9af43b52394d81fb507e3
|
4
|
+
data.tar.gz: eafc4834c59d638f07878573ba3b17f2e7446765
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 10f2e31ae8986359cb93bb92b4d1ea2806987f8ce0af9c9b9f45d12d46bbf1dde6f5d63c8e07703ff8823b50a0b3108fbd37dbed1e89fb4fe13514f3c48e29f2
|
7
|
+
data.tar.gz: d142354ef65272bdfc30761b758d6caa383f016b8e0b527978bd402e068563bba4a88033a73b7a8e395640a28505a31e29a8c75f49b2c275f9e940073667a26f
|
data/.byebug_history
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
fluent-plugin-event-collector (0.1.0)
|
5
|
+
fluentd (>= 0.14.10, < 2)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
byebug (10.0.2)
|
11
|
+
cool.io (1.5.3)
|
12
|
+
dig_rb (1.0.1)
|
13
|
+
fluentd (1.2.0)
|
14
|
+
cool.io (>= 1.4.5, < 2.0.0)
|
15
|
+
dig_rb (~> 1.0.0)
|
16
|
+
http_parser.rb (>= 0.5.1, < 0.7.0)
|
17
|
+
msgpack (>= 0.7.0, < 2.0.0)
|
18
|
+
serverengine (>= 2.0.4, < 3.0.0)
|
19
|
+
sigdump (~> 0.2.2)
|
20
|
+
strptime (>= 0.2.2, < 1.0.0)
|
21
|
+
tzinfo (~> 1.0)
|
22
|
+
tzinfo-data (~> 1.0)
|
23
|
+
yajl-ruby (~> 1.0)
|
24
|
+
http_parser.rb (0.6.0)
|
25
|
+
msgpack (1.2.4)
|
26
|
+
power_assert (1.1.1)
|
27
|
+
rake (12.3.1)
|
28
|
+
serverengine (2.0.6)
|
29
|
+
sigdump (~> 0.2.2)
|
30
|
+
sigdump (0.2.4)
|
31
|
+
strptime (0.2.3)
|
32
|
+
test-unit (3.2.7)
|
33
|
+
power_assert
|
34
|
+
thread_safe (0.3.6)
|
35
|
+
tzinfo (1.2.5)
|
36
|
+
thread_safe (~> 0.1)
|
37
|
+
tzinfo-data (1.2018.5)
|
38
|
+
tzinfo (>= 1.0.0)
|
39
|
+
yajl-ruby (1.4.0)
|
40
|
+
|
41
|
+
PLATFORMS
|
42
|
+
ruby
|
43
|
+
|
44
|
+
DEPENDENCIES
|
45
|
+
bundler (~> 1.14)
|
46
|
+
byebug
|
47
|
+
fluent-plugin-event-collector!
|
48
|
+
rake (~> 12.0)
|
49
|
+
test-unit (~> 3.0)
|
50
|
+
|
51
|
+
BUNDLED WITH
|
52
|
+
1.16.1
|
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,56 @@
|
|
1
|
+
# fluent-plugin-event-collector
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) filter plugin to do something.
|
4
|
+
|
5
|
+
Event Collector merges multiple Fluentd events into a single event with key fields concatenated. The terminating event should be designated with a special key value pair, however unfinished events will timeout and be emitted normally. For example with the key field `message` and the event key `request_id`, the two events:
|
6
|
+
|
7
|
+
```json
|
8
|
+
{'request_id' => '123abc', 'foo' => 'bar', 'message' => 'Hello'}
|
9
|
+
{'request_id' => '123abc', 'foo' => 'baz', 'message' => 'World!', 'complete' => 'true'}
|
10
|
+
```
|
11
|
+
|
12
|
+
will be emitted as
|
13
|
+
|
14
|
+
```json
|
15
|
+
{'request_id' => '123abc', 'foo' => 'bar', 'message' => 'Hello World!', 'complete' => 'true'}
|
16
|
+
```
|
17
|
+
|
18
|
+
All non-key fields follow a last write wins model, however multiple key fields are allowed.
|
19
|
+
|
20
|
+
## Installation
|
21
|
+
|
22
|
+
### RubyGems
|
23
|
+
|
24
|
+
```
|
25
|
+
$ gem install fluent-plugin-event-collector
|
26
|
+
```
|
27
|
+
|
28
|
+
### Bundler
|
29
|
+
|
30
|
+
Add following line to your Gemfile:
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
gem "fluent-plugin-event-collector"
|
34
|
+
```
|
35
|
+
|
36
|
+
And then execute:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ bundle
|
40
|
+
```
|
41
|
+
|
42
|
+
## Configuration
|
43
|
+
|
44
|
+
You can generate configuration template:
|
45
|
+
|
46
|
+
```
|
47
|
+
$ fluent-plugin-config-format filter event_collector
|
48
|
+
```
|
49
|
+
|
50
|
+
You can copy and paste generated documents here.
|
51
|
+
|
52
|
+
## Copyright
|
53
|
+
|
54
|
+
* Copyright(c) 2018- Adam Hart
|
55
|
+
* License
|
56
|
+
* 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,28 @@
|
|
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-event-collector"
|
6
|
+
spec.version = "0.1.0"
|
7
|
+
spec.authors = ["Adam Hart"]
|
8
|
+
spec.email = ["ahart@zendesk.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{A Fluentd plugin to aggregate events based on a common field key}
|
11
|
+
spec.homepage = "https://github.com/adam-hart/fluent-plugin-event-collector"
|
12
|
+
spec.license = "Apache-2.0"
|
13
|
+
|
14
|
+
test_files, files = `git ls-files -z`.split("\x0").partition do |f|
|
15
|
+
f.match(%r{^(test|spec|features)/})
|
16
|
+
end
|
17
|
+
spec.files = files
|
18
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
19
|
+
spec.test_files = test_files
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
23
|
+
spec.add_development_dependency "rake", "~> 12.0"
|
24
|
+
spec.add_development_dependency "test-unit", "~> 3.0"
|
25
|
+
spec.add_development_dependency "byebug"
|
26
|
+
|
27
|
+
spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
|
28
|
+
end
|
@@ -0,0 +1,126 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2018- Adam Hart
|
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
|
+
|
18
|
+
module Fluent
|
19
|
+
module Plugin
|
20
|
+
class EventCollectorFilter < Fluent::Plugin::Filter
|
21
|
+
Fluent::Plugin.register_filter("event_collector", self)
|
22
|
+
|
23
|
+
helpers :timer, :event_emitter
|
24
|
+
|
25
|
+
config_param :event_key, :string
|
26
|
+
|
27
|
+
config_param :end_tag_key, :string
|
28
|
+
config_param :end_tag_value, :string
|
29
|
+
|
30
|
+
config_param :merge_fields, :array, value_type: :string, default: []
|
31
|
+
config_param :merge_field_delimeter, :string, default: ' '
|
32
|
+
|
33
|
+
config_param :event_timeout, :integer, default: 30
|
34
|
+
|
35
|
+
def configure(conf)
|
36
|
+
super
|
37
|
+
|
38
|
+
@event_buffer = {}
|
39
|
+
@event_buffer_lock = Mutex.new
|
40
|
+
end
|
41
|
+
|
42
|
+
def start
|
43
|
+
super
|
44
|
+
|
45
|
+
# Set up event timeout
|
46
|
+
timer_execute(:event_timeout, event_timeout, repeat: false, &method(:timeout_flush))
|
47
|
+
end
|
48
|
+
|
49
|
+
def filter(tag, time, record)
|
50
|
+
# Pass through if we can't associate a record with a event
|
51
|
+
return record unless record[event_key]
|
52
|
+
|
53
|
+
@event_buffer_lock.synchronize do
|
54
|
+
if record[end_tag_key] == end_tag_value
|
55
|
+
# Complete event object and publish to rest of fluent chain
|
56
|
+
publish_event(record)
|
57
|
+
else
|
58
|
+
# Merge in fluent's tag and time in case we need to manually emit later
|
59
|
+
update_event(record.merge({'fd_tag' => tag, 'fd_time' => time}))
|
60
|
+
|
61
|
+
# nil return halts the fluent event chain for this event
|
62
|
+
nil
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
private
|
68
|
+
|
69
|
+
# Return a full formed event
|
70
|
+
def publish_event(record)
|
71
|
+
return record unless event = @event_buffer.delete(record[event_key])
|
72
|
+
|
73
|
+
# Remove any fluent fields we added
|
74
|
+
merge_records(event, record).delete_if { |k, _| k =~ /\Afd_/ }
|
75
|
+
end
|
76
|
+
|
77
|
+
# Initializes or merges record hashes into a event
|
78
|
+
def update_event(record)
|
79
|
+
event_id = record[event_key]
|
80
|
+
|
81
|
+
if event = @event_buffer[event_id]
|
82
|
+
merge_records(event, record)
|
83
|
+
else
|
84
|
+
@event_buffer[event_id] = record
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
# Merges record hashes where key fields are concatenated
|
89
|
+
def merge_records(r1, r2)
|
90
|
+
r1.merge!(r2) do |k, v1, v2|
|
91
|
+
if merge_fields.include?(k)
|
92
|
+
"#{v1}#{merge_field_delimeter}#{v2}"
|
93
|
+
else
|
94
|
+
v2
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# event timeout callback
|
100
|
+
def timeout_flush
|
101
|
+
now = Time.now.to_i
|
102
|
+
|
103
|
+
# Snapshot the event buffer and timeout a event if it hasn't been updated in 30s
|
104
|
+
timeout_buffer = @event_buffer.dup.each_with_object([]) do |(id, event), buffer|
|
105
|
+
buffer << id if (now - event['fd_time'].to_i) > event_timeout
|
106
|
+
end
|
107
|
+
|
108
|
+
@event_buffer_lock.synchronize { timeout_events(timeout_buffer) } if timeout_buffer.any?
|
109
|
+
|
110
|
+
# To ensure we don't run more than one timer at a time, enqueue at the end
|
111
|
+
timer_execute(:event_timeout, event_timeout, repeat: false, &method(:timeout_flush))
|
112
|
+
end
|
113
|
+
|
114
|
+
# Manually emit a fluent event for all timed out events
|
115
|
+
def timeout_events(timeout_buffer)
|
116
|
+
timeout_buffer.each do |event_id|
|
117
|
+
emit_event(@event_buffer.delete(event_id), 'event_timeout')
|
118
|
+
end
|
119
|
+
end
|
120
|
+
|
121
|
+
def emit_event(event, reason)
|
122
|
+
router.emit("#{event.delete('fd_tag')}.#{reason}", event.delete('fd_time'), event)
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
|
2
|
+
require "test-unit"
|
3
|
+
require "fluent/test"
|
4
|
+
require "fluent/test/driver/filter"
|
5
|
+
require "fluent/test/helpers"
|
6
|
+
|
7
|
+
Test::Unit::TestCase.include(Fluent::Test::Helpers)
|
8
|
+
Test::Unit::TestCase.extend(Fluent::Test::Helpers)
|
@@ -0,0 +1,118 @@
|
|
1
|
+
require "helper"
|
2
|
+
require "fluent/plugin/filter_event_collector.rb"
|
3
|
+
|
4
|
+
class EventCollectorFilterTest < Test::Unit::TestCase
|
5
|
+
setup do
|
6
|
+
Fluent::Test.setup
|
7
|
+
end
|
8
|
+
|
9
|
+
BASIC_CONF = %[
|
10
|
+
event_key request_id
|
11
|
+
end_tag_key complete
|
12
|
+
end_tag_value true
|
13
|
+
event_timeout 1
|
14
|
+
]
|
15
|
+
|
16
|
+
MERGE_CONF = BASIC_CONF + %[
|
17
|
+
merge_fields message
|
18
|
+
merge_field_delimeter +
|
19
|
+
]
|
20
|
+
|
21
|
+
R1 = [
|
22
|
+
{'request_id' => '1', 'message' => 'Hello'},
|
23
|
+
{'request_id' => '1', 'message' => 'World!', 'complete' => 'true'}
|
24
|
+
]
|
25
|
+
R2 = [
|
26
|
+
{'request_id' => '2', 'message' => 'Poop'},
|
27
|
+
{'request_id' => '2', 'message' => 'The Cat', 'complete' => 'true'}
|
28
|
+
]
|
29
|
+
|
30
|
+
def create_driver(conf = BASIC_CONF)
|
31
|
+
Fluent::Test::Driver::Filter.new(Fluent::Plugin::EventCollectorFilter).configure(conf)
|
32
|
+
end
|
33
|
+
|
34
|
+
sub_test_case 'filter base functionality' do
|
35
|
+
test 'passes through unidentifiable events' do
|
36
|
+
d = create_driver
|
37
|
+
|
38
|
+
d.run do
|
39
|
+
d.feed('filter.test', event_time, {'foo' => 'bar'})
|
40
|
+
end
|
41
|
+
|
42
|
+
assert_equal(d.filtered_records.size, 1)
|
43
|
+
end
|
44
|
+
|
45
|
+
test 'aggregates multiple events with same key value' do
|
46
|
+
d = create_driver
|
47
|
+
|
48
|
+
d.run do
|
49
|
+
d.feed('filter.test', event_time, R1[0])
|
50
|
+
d.feed('filter.test', event_time, R1[1])
|
51
|
+
end
|
52
|
+
|
53
|
+
assert_equal(d.filtered_records.size, 1)
|
54
|
+
assert_equal(R1[1], d.filtered_records.first)
|
55
|
+
end
|
56
|
+
|
57
|
+
test 'can aggregate conflated events' do
|
58
|
+
d = create_driver
|
59
|
+
|
60
|
+
d.run do
|
61
|
+
d.feed('filter.test', event_time, R1[0])
|
62
|
+
d.feed('filter.test', event_time, R2[0])
|
63
|
+
d.feed('filter.test', event_time, R1[1])
|
64
|
+
d.feed('filter.test', event_time, R2[1])
|
65
|
+
end
|
66
|
+
|
67
|
+
assert_equal(d.filtered_records.size, 2)
|
68
|
+
assert_equal(R1[1], d.filtered_records.first)
|
69
|
+
assert_equal(R2[1], d.filtered_records.last)
|
70
|
+
end
|
71
|
+
|
72
|
+
test 'emits single line events' do
|
73
|
+
d = create_driver
|
74
|
+
|
75
|
+
d.run do
|
76
|
+
d.feed('filter.test', event_time, R1[1])
|
77
|
+
end
|
78
|
+
|
79
|
+
assert_equal(d.filtered_records.size, 1)
|
80
|
+
assert_equal(R1[1], d.filtered_records.first)
|
81
|
+
end
|
82
|
+
|
83
|
+
test 'holds events in buffer if unfinished' do
|
84
|
+
d = create_driver
|
85
|
+
|
86
|
+
d.run do
|
87
|
+
d.feed('filter.test', event_time, R1[0])
|
88
|
+
end
|
89
|
+
|
90
|
+
assert_equal(d.filtered_records.size, 0)
|
91
|
+
end
|
92
|
+
|
93
|
+
test 'requests time out if not finished' do
|
94
|
+
d = create_driver
|
95
|
+
|
96
|
+
d.run do
|
97
|
+
d.feed('filter.test', event_time, R1[0])
|
98
|
+
sleep(3)
|
99
|
+
end
|
100
|
+
|
101
|
+
assert_equal(d.emit_count, 1)
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
sub_test_case 'filter with merge fields' do
|
106
|
+
test 'merges the key fields' do
|
107
|
+
d = create_driver(MERGE_CONF)
|
108
|
+
|
109
|
+
d.run do
|
110
|
+
d.feed('filter.test', event_time, R1[0])
|
111
|
+
d.feed('filter.test', event_time, R1[1])
|
112
|
+
end
|
113
|
+
|
114
|
+
assert_equal(1, d.filtered_records.size)
|
115
|
+
assert_equal('Hello+World!', d.filtered_records.first['message'])
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
metadata
ADDED
@@ -0,0 +1,132 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-event-collector
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Adam Hart
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-05-24 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: '1.14'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.14'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '12.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '12.0'
|
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.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: byebug
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: fluentd
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 0.14.10
|
76
|
+
- - "<"
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: '2'
|
79
|
+
type: :runtime
|
80
|
+
prerelease: false
|
81
|
+
version_requirements: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - ">="
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: 0.14.10
|
86
|
+
- - "<"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '2'
|
89
|
+
description:
|
90
|
+
email:
|
91
|
+
- ahart@zendesk.com
|
92
|
+
executables: []
|
93
|
+
extensions: []
|
94
|
+
extra_rdoc_files: []
|
95
|
+
files:
|
96
|
+
- ".byebug_history"
|
97
|
+
- Gemfile
|
98
|
+
- Gemfile.lock
|
99
|
+
- LICENSE
|
100
|
+
- README.md
|
101
|
+
- Rakefile
|
102
|
+
- fluent-plugin-event-collector.gemspec
|
103
|
+
- lib/fluent/plugin/filter_event_collector.rb
|
104
|
+
- test/helper.rb
|
105
|
+
- test/plugin/test_filter_event_collector.rb
|
106
|
+
homepage: https://github.com/adam-hart/fluent-plugin-event-collector
|
107
|
+
licenses:
|
108
|
+
- Apache-2.0
|
109
|
+
metadata: {}
|
110
|
+
post_install_message:
|
111
|
+
rdoc_options: []
|
112
|
+
require_paths:
|
113
|
+
- lib
|
114
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
115
|
+
requirements:
|
116
|
+
- - ">="
|
117
|
+
- !ruby/object:Gem::Version
|
118
|
+
version: '0'
|
119
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - ">="
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
requirements: []
|
125
|
+
rubyforge_project:
|
126
|
+
rubygems_version: 2.5.1
|
127
|
+
signing_key:
|
128
|
+
specification_version: 4
|
129
|
+
summary: A Fluentd plugin to aggregate events based on a common field key
|
130
|
+
test_files:
|
131
|
+
- test/helper.rb
|
132
|
+
- test/plugin/test_filter_event_collector.rb
|