fluent-plugin-redis-enrichment 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rubocop.yml +11 -0
- data/Gemfile +5 -0
- data/LICENSE +202 -0
- data/README.md +43 -0
- data/Rakefile +19 -0
- data/fluent-plugin-redis-enrichment.gemspec +41 -0
- data/lib/fluent/plugin/filter_redis_enrichment.rb +312 -0
- metadata +243 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e523d3d718b67a60e86a6c37f7ba9a08d88ba6ee51570b03fcdb3600b24d9968
|
4
|
+
data.tar.gz: ee9e08c30219913043fff587734019a4896f64aaf26883cc9bdafa34d78b3f71
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 503448814a124ab6c3d912325887dfe87f9c0f1159ab1e34b821c968ab8305cdf9b32ec661a939083fc9b76f854143ac1899829741dbd61519a9879fde5c6f37
|
7
|
+
data.tar.gz: c141425d3b669a4464a10df035956cee8da5957aef5c8bb7d4b5a5478339fe644881859e4bc822f502aff6a522ea75fd9dece70798cf4fee3243b221dd2cd34b
|
data/.rubocop.yml
ADDED
data/Gemfile
ADDED
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,43 @@
|
|
1
|
+
# fluent-plugin-redis-enrichment
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) filter plugin to do something.
|
4
|
+
|
5
|
+
TODO: write description for you plugin.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
### RubyGems
|
10
|
+
|
11
|
+
```
|
12
|
+
$ gem install fluent-plugin-redis-enrichment
|
13
|
+
```
|
14
|
+
|
15
|
+
### Bundler
|
16
|
+
|
17
|
+
Add following line to your Gemfile:
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
gem "fluent-plugin-redis-enrichment"
|
21
|
+
```
|
22
|
+
|
23
|
+
And then execute:
|
24
|
+
|
25
|
+
```
|
26
|
+
$ bundle
|
27
|
+
```
|
28
|
+
|
29
|
+
## Configuration
|
30
|
+
|
31
|
+
You can generate configuration template:
|
32
|
+
|
33
|
+
```
|
34
|
+
$ fluent-plugin-config-format filter redis-enrichment
|
35
|
+
```
|
36
|
+
|
37
|
+
You can copy and paste generated documents here.
|
38
|
+
|
39
|
+
## Copyright
|
40
|
+
|
41
|
+
* Copyright(c) 2022- Thomas Tych
|
42
|
+
* License
|
43
|
+
* Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'bundler'
|
4
|
+
Bundler::GemHelper.install_tasks
|
5
|
+
|
6
|
+
require 'rake/testtask'
|
7
|
+
require 'rubocop/rake_task'
|
8
|
+
require 'bump/tasks'
|
9
|
+
|
10
|
+
Rake::TestTask.new(:test) do |t|
|
11
|
+
t.libs.push('lib', 'test')
|
12
|
+
t.test_files = FileList['test/**/test_*.rb']
|
13
|
+
t.verbose = true
|
14
|
+
t.warning = true
|
15
|
+
end
|
16
|
+
|
17
|
+
RuboCop::RakeTask.new
|
18
|
+
|
19
|
+
task default: %i[test rubocop]
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'fluent-plugin-redis-enrichment'
|
8
|
+
spec.version = '0.2.0'
|
9
|
+
spec.authors = ['Thomas Tych']
|
10
|
+
spec.email = ['thomas.tych@gmail.com']
|
11
|
+
|
12
|
+
spec.summary = 'fluentd plugin to do data enrichment with redis.'
|
13
|
+
spec.homepage = 'https://gitlab.com/ttych/fluent-plugin-redis-enrichment'
|
14
|
+
spec.license = 'Apache-2.0'
|
15
|
+
|
16
|
+
spec.required_ruby_version = '>= 2.4.0'
|
17
|
+
|
18
|
+
spec.files = Dir.chdir(__dir__) do
|
19
|
+
`git ls-files -z`.split("\x0").reject do |f|
|
20
|
+
(f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
|
21
|
+
end
|
22
|
+
end
|
23
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
24
|
+
spec.require_paths = ['lib']
|
25
|
+
|
26
|
+
spec.add_development_dependency 'bump', '~> 0.10.0'
|
27
|
+
spec.add_development_dependency 'bundler', '~> 2.3.20'
|
28
|
+
spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
|
29
|
+
spec.add_development_dependency 'rake', '~> 13.0.6'
|
30
|
+
spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.1'
|
31
|
+
spec.add_development_dependency 'rubocop', '~> 1.21'
|
32
|
+
spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
|
33
|
+
spec.add_development_dependency 'test-unit', '~> 3.5.3'
|
34
|
+
|
35
|
+
spec.add_runtime_dependency 'connection_pool', '~> 2.3'
|
36
|
+
spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
|
37
|
+
spec.add_runtime_dependency 'lru_redux', '~> 1.1'
|
38
|
+
spec.add_runtime_dependency 'redis', '~> 5.0', '>= 5.0.5'
|
39
|
+
|
40
|
+
spec.metadata['rubygems_mfa_required'] = 'true'
|
41
|
+
end
|
@@ -0,0 +1,312 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
#
|
4
|
+
# Copyright 2022- Thomas Tych
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
|
18
|
+
# THIS IS STRONGLY INSPIRATED/COPIED FROM OFFICIAL FLUENTD
|
19
|
+
# source for expand part is from record_transformer plugins
|
20
|
+
|
21
|
+
require 'connection_pool'
|
22
|
+
require 'redis'
|
23
|
+
require 'lru_redux'
|
24
|
+
|
25
|
+
require 'fluent/plugin/filter'
|
26
|
+
|
27
|
+
module Fluent
|
28
|
+
module Plugin
|
29
|
+
# filter plugin
|
30
|
+
# enrich record based on redis fetched content
|
31
|
+
class RedisEnrichmentFilter < Fluent::Plugin::Filter
|
32
|
+
Fluent::Plugin.register_filter('redis_enrichment', self)
|
33
|
+
|
34
|
+
DEFAULT_REDIS_HOST = '127.0.0.1'
|
35
|
+
DEFAULT_REDIS_PORT = 6379
|
36
|
+
DEFAULT_REDIS_DB = 0
|
37
|
+
DEFAULT_REDIS_PASSWORD = nil
|
38
|
+
DEFAULT_REDIS_TIMEOUT = 5.0
|
39
|
+
DEFAULT_REDIS_POOL = 5
|
40
|
+
DEFAULT_SENTINELS = nil
|
41
|
+
DEFAULT_SENTINEL_MASTER = 'mymaster'
|
42
|
+
DEFAULT_SENTINEL_PASSWORD = nil
|
43
|
+
DEFAULT_REDIS_ROLE = :slave
|
44
|
+
DEFAULT_SENTINEL_PORT = 26_379
|
45
|
+
DEFAULT_CACHE_TTL = 30 * 60
|
46
|
+
DEFAULT_CACHE_SIZE = 5000
|
47
|
+
|
48
|
+
desc 'Redis host'
|
49
|
+
config_param :redis_host, :string, default: DEFAULT_REDIS_HOST
|
50
|
+
desc 'Redis port'
|
51
|
+
config_param :redis_port, :integer, default: DEFAULT_REDIS_PORT
|
52
|
+
desc 'Redis db id to select'
|
53
|
+
config_param :redis_db, :integer, default: DEFAULT_REDIS_DB
|
54
|
+
desc 'Redis password'
|
55
|
+
config_param :redis_password, :string, default: DEFAULT_REDIS_PASSWORD, secret: true
|
56
|
+
desc 'Redis timeout'
|
57
|
+
config_param :redis_timeout, :float, default: DEFAULT_REDIS_TIMEOUT
|
58
|
+
desc 'Redis connection pool'
|
59
|
+
config_param :redis_pool, :integer, default: DEFAULT_REDIS_POOL
|
60
|
+
desc 'Sentinels list (host:port,host:port,...)'
|
61
|
+
config_param :sentinels, :array, default: DEFAULT_SENTINELS
|
62
|
+
desc 'Sentinel password'
|
63
|
+
config_param :sentinel_password, :string, default: DEFAULT_SENTINEL_PASSWORD, secret: true
|
64
|
+
desc 'Sentinel redis master name'
|
65
|
+
config_param :sentinel_master, :string, default: DEFAULT_SENTINEL_MASTER
|
66
|
+
desc 'Sentinel redis role'
|
67
|
+
config_param :redis_role, :enum, list: %i[master slave replica], default: DEFAULT_REDIS_ROLE
|
68
|
+
|
69
|
+
desc 'local Cache size'
|
70
|
+
config_param :cache_size, :integer, default: DEFAULT_CACHE_SIZE
|
71
|
+
desc 'local Cache ttl'
|
72
|
+
config_param :cache_ttl, :integer, default: DEFAULT_CACHE_TTL
|
73
|
+
|
74
|
+
desc 'Redis key to fetch'
|
75
|
+
config_param :key, :string, default: nil
|
76
|
+
|
77
|
+
attr_reader :record_enrichment
|
78
|
+
|
79
|
+
def configure(conf)
|
80
|
+
super
|
81
|
+
|
82
|
+
if !key || key.empty?
|
83
|
+
raise Fluent::ConfigError,
|
84
|
+
"key can't be empty, the value will be expanded to a redis key"
|
85
|
+
end
|
86
|
+
|
87
|
+
@record_enrichment = {}
|
88
|
+
conf.elements.select { |element| element.name == 'record' }.each do |element|
|
89
|
+
element.each_pair do |k, v|
|
90
|
+
element.has_key?(k)
|
91
|
+
@record_enrichment[k] = parse_record_value(v)
|
92
|
+
end
|
93
|
+
end
|
94
|
+
|
95
|
+
@placeholder_expander = PlaceholderExpander.new(log)
|
96
|
+
end
|
97
|
+
|
98
|
+
def start
|
99
|
+
super
|
100
|
+
|
101
|
+
@cache = Cache.new(**cache_options)
|
102
|
+
@redis = RedisPool.new(**redis_options)
|
103
|
+
end
|
104
|
+
|
105
|
+
def shutdown
|
106
|
+
@redis.quit
|
107
|
+
|
108
|
+
super
|
109
|
+
end
|
110
|
+
|
111
|
+
def filter(tag, time, record)
|
112
|
+
new_record = record.dup
|
113
|
+
expanded_key = @placeholder_expander.expand(@key, { tag: tag,
|
114
|
+
time: time,
|
115
|
+
record: new_record })
|
116
|
+
log.debug("filter_redis_enrichment: on tag:#{tag}, search #{expanded_key}")
|
117
|
+
redis = @cache.getset(expanded_key) { @redis.get(expanded_key) }
|
118
|
+
new_record_record_enrichment = @placeholder_expander.expand(@record_enrichment,
|
119
|
+
{ tag: tag,
|
120
|
+
time: time,
|
121
|
+
record: new_record,
|
122
|
+
redis: redis })
|
123
|
+
new_record.merge(new_record_record_enrichment)
|
124
|
+
end
|
125
|
+
|
126
|
+
def cache_options
|
127
|
+
{
|
128
|
+
size: cache_size,
|
129
|
+
ttl: cache_ttl
|
130
|
+
}
|
131
|
+
end
|
132
|
+
|
133
|
+
def redis_options
|
134
|
+
redis_options = {
|
135
|
+
db: redis_db,
|
136
|
+
password: redis_password,
|
137
|
+
timeout: redis_timeout,
|
138
|
+
pool_size: redis_pool
|
139
|
+
}
|
140
|
+
|
141
|
+
if sentinels
|
142
|
+
formated_sentinels = sentinels.map do |sentinel|
|
143
|
+
host, port = sentinel.split(':')
|
144
|
+
port = (port || DEFAULT_SENTINEL_PORT).to_i
|
145
|
+
formated = { host: host, port: port }
|
146
|
+
formated[:password] = sentinel_password if sentinel_password
|
147
|
+
formated
|
148
|
+
end
|
149
|
+
redis_options.update({
|
150
|
+
sentinels: formated_sentinels,
|
151
|
+
name: sentinel_master,
|
152
|
+
role: redis_role
|
153
|
+
})
|
154
|
+
else
|
155
|
+
redis_options.update({
|
156
|
+
host: redis_host,
|
157
|
+
port: redis_port
|
158
|
+
})
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
private
|
163
|
+
|
164
|
+
def parse_record_value(value_str)
|
165
|
+
if value_str.start_with?('{', '[')
|
166
|
+
JSON.parse(value_str)
|
167
|
+
else
|
168
|
+
value_str
|
169
|
+
end
|
170
|
+
rescue StandardError => e
|
171
|
+
log.warn "failed to parse #{value_str} as json. Assuming #{value_str} is a string", error: e
|
172
|
+
value_str # emit as string
|
173
|
+
end
|
174
|
+
|
175
|
+
class Cache
|
176
|
+
def initialize(size: DEFAULT_CACHE_SIZE, ttl: DEFAULT_CACHE_TTL)
|
177
|
+
@size = size
|
178
|
+
@ttl = ttl
|
179
|
+
end
|
180
|
+
|
181
|
+
def getset(key, &block)
|
182
|
+
cache.getset(key, &block)
|
183
|
+
end
|
184
|
+
|
185
|
+
private
|
186
|
+
|
187
|
+
def cache
|
188
|
+
@cache ||= if @size == 0 || @ttl == 0
|
189
|
+
NoCache.new
|
190
|
+
else
|
191
|
+
LruRedux::TTL::ThreadSafeCache.new(@size, @ttl)
|
192
|
+
end
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
class NoCache
|
197
|
+
def getset(_key)
|
198
|
+
yield
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
# proxy for Redis client
|
203
|
+
# allow extract caching of cache
|
204
|
+
class RedisPool
|
205
|
+
def initialize(sentinels: DEFAULT_SENTINELS, name: DEFAULT_SENTINEL_MASTER, role: DEFAULT_REDIS_ROLE,
|
206
|
+
host: DEFAULT_REDIS_HOST, port: DEFAULT_REDIS_PORT, db: DEFAULT_REDIS_DB,
|
207
|
+
password: DEFAULT_REDIS_PASSWORD, timeout: DEFAULT_REDIS_TIMEOUT, pool_size: DEFAULT_REDIS_POOL)
|
208
|
+
@sentinels = sentinels
|
209
|
+
@name = name
|
210
|
+
@role = role
|
211
|
+
@host = host
|
212
|
+
@port = port
|
213
|
+
@db = db
|
214
|
+
@password = password
|
215
|
+
@timeout = timeout
|
216
|
+
@pool_size = pool_size
|
217
|
+
end
|
218
|
+
|
219
|
+
def get(key)
|
220
|
+
return if key.nil?
|
221
|
+
|
222
|
+
key_type = redis.type(key)
|
223
|
+
case key_type
|
224
|
+
when 'none' then nil
|
225
|
+
when 'string' then redis.get(key)
|
226
|
+
when 'hash' then redis.hgetall(key)
|
227
|
+
else
|
228
|
+
log.warn("redis key '#{key}' has an unmanaged type '#{key_type}'")
|
229
|
+
nil
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
def quit
|
234
|
+
redis.quit
|
235
|
+
end
|
236
|
+
|
237
|
+
private
|
238
|
+
|
239
|
+
def redis
|
240
|
+
@redis ||= ConnectionPool::Wrapper.new(size: @pool_size, timeout: @timeout) do
|
241
|
+
if @sentinels
|
242
|
+
Redis.new(sentinels: @sentinels, name: @name, role: @role, db: @db, password: @password,
|
243
|
+
timeout: @timeout)
|
244
|
+
else
|
245
|
+
Redis.new(host: @host, port: @port, db: @db, password: @password, timeout: @timeout)
|
246
|
+
end
|
247
|
+
end
|
248
|
+
end
|
249
|
+
end
|
250
|
+
|
251
|
+
# The expand recurse loop
|
252
|
+
# from record_transformer filter plugin
|
253
|
+
class PlaceholderExpander
|
254
|
+
def initialize(log)
|
255
|
+
@log = log
|
256
|
+
@cleanroom_expander = CleanroomExpander.new(log)
|
257
|
+
end
|
258
|
+
|
259
|
+
def expand(value, context = {})
|
260
|
+
new_value = nil
|
261
|
+
case value
|
262
|
+
when String
|
263
|
+
num_placeholders = value.scan('${').size
|
264
|
+
if num_placeholders == 1 && value.start_with?('${') && value.end_with?('}')
|
265
|
+
new_value = value[2..-2] # ${..} => ..
|
266
|
+
end
|
267
|
+
new_value ||= "%Q[#{value.gsub('${', '#{')}]"
|
268
|
+
new_value = @cleanroom_expander.expand(new_value, **context)
|
269
|
+
when Hash
|
270
|
+
new_value = {}
|
271
|
+
value.each_pair do |k, v|
|
272
|
+
new_value[expand(k, context)] = expand(v, context)
|
273
|
+
end
|
274
|
+
when Array
|
275
|
+
new_value = []
|
276
|
+
value.each_with_index do |v, i|
|
277
|
+
new_value[i] = expand(v, context)
|
278
|
+
end
|
279
|
+
else
|
280
|
+
new_value = value
|
281
|
+
end
|
282
|
+
|
283
|
+
new_value
|
284
|
+
end
|
285
|
+
end
|
286
|
+
|
287
|
+
# safer object to eval code
|
288
|
+
# from record_transformer filter plugin
|
289
|
+
class CleanroomExpander
|
290
|
+
attr_reader :log
|
291
|
+
|
292
|
+
def initialize(log)
|
293
|
+
@log = log
|
294
|
+
end
|
295
|
+
|
296
|
+
def expand(__str_to_eval__, tag: nil, time: nil, record: nil, redis: nil, **_extra)
|
297
|
+
instance_eval(__str_to_eval__)
|
298
|
+
rescue NoMethodError => e
|
299
|
+
nil
|
300
|
+
rescue StandardError => e
|
301
|
+
log.warn("while expanding #{__str_to_eval__}: #{e}")
|
302
|
+
end
|
303
|
+
|
304
|
+
Object.instance_methods.each do |m|
|
305
|
+
unless m.to_s =~ /^__|respond_to_missing\?|object_id|public_methods|instance_eval|method_missing|define_singleton_method|respond_to\?|new_ostruct_member|^class$/
|
306
|
+
undef_method m
|
307
|
+
end
|
308
|
+
end
|
309
|
+
end
|
310
|
+
end
|
311
|
+
end
|
312
|
+
end
|
metadata
ADDED
@@ -0,0 +1,243 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-redis-enrichment
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Thomas Tych
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-11-23 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bump
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.10.0
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.10.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 2.3.20
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.3.20
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: byebug
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '11.1'
|
48
|
+
- - ">="
|
49
|
+
- !ruby/object:Gem::Version
|
50
|
+
version: 11.1.3
|
51
|
+
type: :development
|
52
|
+
prerelease: false
|
53
|
+
version_requirements: !ruby/object:Gem::Requirement
|
54
|
+
requirements:
|
55
|
+
- - "~>"
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: '11.1'
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 11.1.3
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: rake
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: 13.0.6
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 13.0.6
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: reek
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '6.1'
|
82
|
+
- - ">="
|
83
|
+
- !ruby/object:Gem::Version
|
84
|
+
version: 6.1.1
|
85
|
+
type: :development
|
86
|
+
prerelease: false
|
87
|
+
version_requirements: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - "~>"
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '6.1'
|
92
|
+
- - ">="
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: 6.1.1
|
95
|
+
- !ruby/object:Gem::Dependency
|
96
|
+
name: rubocop
|
97
|
+
requirement: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - "~>"
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '1.21'
|
102
|
+
type: :development
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - "~>"
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '1.21'
|
109
|
+
- !ruby/object:Gem::Dependency
|
110
|
+
name: rubocop-rake
|
111
|
+
requirement: !ruby/object:Gem::Requirement
|
112
|
+
requirements:
|
113
|
+
- - "~>"
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: 0.6.0
|
116
|
+
type: :development
|
117
|
+
prerelease: false
|
118
|
+
version_requirements: !ruby/object:Gem::Requirement
|
119
|
+
requirements:
|
120
|
+
- - "~>"
|
121
|
+
- !ruby/object:Gem::Version
|
122
|
+
version: 0.6.0
|
123
|
+
- !ruby/object:Gem::Dependency
|
124
|
+
name: test-unit
|
125
|
+
requirement: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - "~>"
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: 3.5.3
|
130
|
+
type: :development
|
131
|
+
prerelease: false
|
132
|
+
version_requirements: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - "~>"
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: 3.5.3
|
137
|
+
- !ruby/object:Gem::Dependency
|
138
|
+
name: connection_pool
|
139
|
+
requirement: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - "~>"
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: '2.3'
|
144
|
+
type: :runtime
|
145
|
+
prerelease: false
|
146
|
+
version_requirements: !ruby/object:Gem::Requirement
|
147
|
+
requirements:
|
148
|
+
- - "~>"
|
149
|
+
- !ruby/object:Gem::Version
|
150
|
+
version: '2.3'
|
151
|
+
- !ruby/object:Gem::Dependency
|
152
|
+
name: fluentd
|
153
|
+
requirement: !ruby/object:Gem::Requirement
|
154
|
+
requirements:
|
155
|
+
- - ">="
|
156
|
+
- !ruby/object:Gem::Version
|
157
|
+
version: 0.14.10
|
158
|
+
- - "<"
|
159
|
+
- !ruby/object:Gem::Version
|
160
|
+
version: '2'
|
161
|
+
type: :runtime
|
162
|
+
prerelease: false
|
163
|
+
version_requirements: !ruby/object:Gem::Requirement
|
164
|
+
requirements:
|
165
|
+
- - ">="
|
166
|
+
- !ruby/object:Gem::Version
|
167
|
+
version: 0.14.10
|
168
|
+
- - "<"
|
169
|
+
- !ruby/object:Gem::Version
|
170
|
+
version: '2'
|
171
|
+
- !ruby/object:Gem::Dependency
|
172
|
+
name: lru_redux
|
173
|
+
requirement: !ruby/object:Gem::Requirement
|
174
|
+
requirements:
|
175
|
+
- - "~>"
|
176
|
+
- !ruby/object:Gem::Version
|
177
|
+
version: '1.1'
|
178
|
+
type: :runtime
|
179
|
+
prerelease: false
|
180
|
+
version_requirements: !ruby/object:Gem::Requirement
|
181
|
+
requirements:
|
182
|
+
- - "~>"
|
183
|
+
- !ruby/object:Gem::Version
|
184
|
+
version: '1.1'
|
185
|
+
- !ruby/object:Gem::Dependency
|
186
|
+
name: redis
|
187
|
+
requirement: !ruby/object:Gem::Requirement
|
188
|
+
requirements:
|
189
|
+
- - "~>"
|
190
|
+
- !ruby/object:Gem::Version
|
191
|
+
version: '5.0'
|
192
|
+
- - ">="
|
193
|
+
- !ruby/object:Gem::Version
|
194
|
+
version: 5.0.5
|
195
|
+
type: :runtime
|
196
|
+
prerelease: false
|
197
|
+
version_requirements: !ruby/object:Gem::Requirement
|
198
|
+
requirements:
|
199
|
+
- - "~>"
|
200
|
+
- !ruby/object:Gem::Version
|
201
|
+
version: '5.0'
|
202
|
+
- - ">="
|
203
|
+
- !ruby/object:Gem::Version
|
204
|
+
version: 5.0.5
|
205
|
+
description:
|
206
|
+
email:
|
207
|
+
- thomas.tych@gmail.com
|
208
|
+
executables: []
|
209
|
+
extensions: []
|
210
|
+
extra_rdoc_files: []
|
211
|
+
files:
|
212
|
+
- ".rubocop.yml"
|
213
|
+
- Gemfile
|
214
|
+
- LICENSE
|
215
|
+
- README.md
|
216
|
+
- Rakefile
|
217
|
+
- fluent-plugin-redis-enrichment.gemspec
|
218
|
+
- lib/fluent/plugin/filter_redis_enrichment.rb
|
219
|
+
homepage: https://gitlab.com/ttych/fluent-plugin-redis-enrichment
|
220
|
+
licenses:
|
221
|
+
- Apache-2.0
|
222
|
+
metadata:
|
223
|
+
rubygems_mfa_required: 'true'
|
224
|
+
post_install_message:
|
225
|
+
rdoc_options: []
|
226
|
+
require_paths:
|
227
|
+
- lib
|
228
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
229
|
+
requirements:
|
230
|
+
- - ">="
|
231
|
+
- !ruby/object:Gem::Version
|
232
|
+
version: 2.4.0
|
233
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
234
|
+
requirements:
|
235
|
+
- - ">="
|
236
|
+
- !ruby/object:Gem::Version
|
237
|
+
version: '0'
|
238
|
+
requirements: []
|
239
|
+
rubygems_version: 3.3.7
|
240
|
+
signing_key:
|
241
|
+
specification_version: 4
|
242
|
+
summary: fluentd plugin to do data enrichment with redis.
|
243
|
+
test_files: []
|