fluent-plugin-kafka-status 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/.gitignore +3 -0
- data/.rubocop.yml +33 -0
- data/Gemfile +5 -0
- data/Gemfile.lock +128 -0
- data/LICENSE +202 -0
- data/README.md +63 -0
- data/Rakefile +18 -0
- data/fluent-plugin-kafka-status.gemspec +39 -0
- data/lib/fluent/plugin/in_kafka_status.rb +220 -0
- data/lib/fluent/plugin/kafka_status_utils.rb +12 -0
- data/lib/fluent/plugin/time_ext.rb +15 -0
- metadata +233 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e63e584615aed1277ffa8ee1217164c55712252e0e89efe6f6a4344aa34afa71
|
4
|
+
data.tar.gz: 575723958151ac961ae4ce8a7494c69ea304599150c58434720fcce769a39020
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f76cc5ebf49a79d656313d1c360ae52eebeba0e38d94b06621b357310548189308b51d462f17daa8e5af51e224d05e6f346002237819c1c92ae84a1b857dcb3b
|
7
|
+
data.tar.gz: e25bfdeac65df107dab55993e6dbf245477badf06794bedc3a1cf89f893e1da4f514a695429b54a6f84000514e5bfd61d977d02615daaf924194b9c549752274
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
require:
|
2
|
+
- rubocop-rake
|
3
|
+
|
4
|
+
AllCops:
|
5
|
+
TargetRubyVersion: 2.4
|
6
|
+
NewCops: enable
|
7
|
+
|
8
|
+
Gemspec/DevelopmentDependencies:
|
9
|
+
Enabled: false
|
10
|
+
|
11
|
+
Layout/LineLength:
|
12
|
+
Max: 140
|
13
|
+
|
14
|
+
# Metrics/AbcSize:
|
15
|
+
# Max: 40
|
16
|
+
|
17
|
+
Metrics/BlockLength:
|
18
|
+
Exclude:
|
19
|
+
- fluent-plugin-kafka-status.gemspec
|
20
|
+
- test/**/*.rb
|
21
|
+
|
22
|
+
Metrics/ClassLength:
|
23
|
+
Exclude:
|
24
|
+
- test/**/*.rb
|
25
|
+
- lib/fluent/plugin/in_ssl_check.rb
|
26
|
+
|
27
|
+
Metrics/MethodLength:
|
28
|
+
Max: 25
|
29
|
+
Exclude:
|
30
|
+
- test/**/*.rb
|
31
|
+
|
32
|
+
Style/Documentation:
|
33
|
+
Enabled: false
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
fluent-plugin-kafka-status (0.2.0)
|
5
|
+
fluentd (>= 0.14.10, < 2)
|
6
|
+
ruby-kafka (>= 1.3.0, < 2)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ast (2.4.2)
|
12
|
+
bigdecimal (3.1.6)
|
13
|
+
bump (0.10.0)
|
14
|
+
byebug (11.1.3)
|
15
|
+
concurrent-ruby (1.2.3)
|
16
|
+
cool.io (1.8.0)
|
17
|
+
digest-crc (0.6.5)
|
18
|
+
rake (>= 12.0.0, < 14.0.0)
|
19
|
+
dry-configurable (1.1.0)
|
20
|
+
dry-core (~> 1.0, < 2)
|
21
|
+
zeitwerk (~> 2.6)
|
22
|
+
dry-core (1.0.1)
|
23
|
+
concurrent-ruby (~> 1.0)
|
24
|
+
zeitwerk (~> 2.6)
|
25
|
+
dry-inflector (1.0.0)
|
26
|
+
dry-initializer (3.1.1)
|
27
|
+
dry-logic (1.5.0)
|
28
|
+
concurrent-ruby (~> 1.0)
|
29
|
+
dry-core (~> 1.0, < 2)
|
30
|
+
zeitwerk (~> 2.6)
|
31
|
+
dry-schema (1.13.3)
|
32
|
+
concurrent-ruby (~> 1.0)
|
33
|
+
dry-configurable (~> 1.0, >= 1.0.1)
|
34
|
+
dry-core (~> 1.0, < 2)
|
35
|
+
dry-initializer (~> 3.0)
|
36
|
+
dry-logic (>= 1.4, < 2)
|
37
|
+
dry-types (>= 1.7, < 2)
|
38
|
+
zeitwerk (~> 2.6)
|
39
|
+
dry-types (1.7.2)
|
40
|
+
bigdecimal (~> 3.0)
|
41
|
+
concurrent-ruby (~> 1.0)
|
42
|
+
dry-core (~> 1.0)
|
43
|
+
dry-inflector (~> 1.0)
|
44
|
+
dry-logic (~> 1.4)
|
45
|
+
zeitwerk (~> 2.6)
|
46
|
+
fluentd (1.16.3)
|
47
|
+
bundler
|
48
|
+
cool.io (>= 1.4.5, < 2.0.0)
|
49
|
+
http_parser.rb (>= 0.5.1, < 0.9.0)
|
50
|
+
msgpack (>= 1.3.1, < 2.0.0)
|
51
|
+
serverengine (>= 2.3.2, < 3.0.0)
|
52
|
+
sigdump (~> 0.2.5)
|
53
|
+
strptime (>= 0.2.4, < 1.0.0)
|
54
|
+
tzinfo (>= 1.0, < 3.0)
|
55
|
+
tzinfo-data (~> 1.0)
|
56
|
+
webrick (~> 1.4)
|
57
|
+
yajl-ruby (~> 1.0)
|
58
|
+
http_parser.rb (0.8.0)
|
59
|
+
json (2.7.1)
|
60
|
+
language_server-protocol (3.17.0.3)
|
61
|
+
msgpack (1.7.2)
|
62
|
+
parallel (1.24.0)
|
63
|
+
parser (3.3.0.5)
|
64
|
+
ast (~> 2.4.1)
|
65
|
+
racc
|
66
|
+
power_assert (2.0.3)
|
67
|
+
racc (1.7.3)
|
68
|
+
rainbow (3.1.1)
|
69
|
+
rake (13.1.0)
|
70
|
+
reek (6.3.0)
|
71
|
+
dry-schema (~> 1.13.0)
|
72
|
+
parser (~> 3.3.0)
|
73
|
+
rainbow (>= 2.0, < 4.0)
|
74
|
+
rexml (~> 3.1)
|
75
|
+
regexp_parser (2.9.0)
|
76
|
+
rexml (3.2.6)
|
77
|
+
rubocop (1.60.2)
|
78
|
+
json (~> 2.3)
|
79
|
+
language_server-protocol (>= 3.17.0)
|
80
|
+
parallel (~> 1.10)
|
81
|
+
parser (>= 3.3.0.2)
|
82
|
+
rainbow (>= 2.2.2, < 4.0)
|
83
|
+
regexp_parser (>= 1.8, < 3.0)
|
84
|
+
rexml (>= 3.2.5, < 4.0)
|
85
|
+
rubocop-ast (>= 1.30.0, < 2.0)
|
86
|
+
ruby-progressbar (~> 1.7)
|
87
|
+
unicode-display_width (>= 2.4.0, < 3.0)
|
88
|
+
rubocop-ast (1.30.0)
|
89
|
+
parser (>= 3.2.1.0)
|
90
|
+
rubocop-rake (0.6.0)
|
91
|
+
rubocop (~> 1.0)
|
92
|
+
ruby-kafka (1.5.0)
|
93
|
+
digest-crc
|
94
|
+
ruby-progressbar (1.13.0)
|
95
|
+
serverengine (2.3.2)
|
96
|
+
sigdump (~> 0.2.2)
|
97
|
+
sigdump (0.2.5)
|
98
|
+
strptime (0.2.5)
|
99
|
+
test-unit (3.6.1)
|
100
|
+
power_assert
|
101
|
+
timecop (0.9.8)
|
102
|
+
tzinfo (2.0.6)
|
103
|
+
concurrent-ruby (~> 1.0)
|
104
|
+
tzinfo-data (1.2024.1)
|
105
|
+
tzinfo (>= 1.0.0)
|
106
|
+
unicode-display_width (2.5.0)
|
107
|
+
webrick (1.8.1)
|
108
|
+
yajl-ruby (1.4.3)
|
109
|
+
zeitwerk (2.6.13)
|
110
|
+
|
111
|
+
PLATFORMS
|
112
|
+
ruby
|
113
|
+
x86_64-linux
|
114
|
+
|
115
|
+
DEPENDENCIES
|
116
|
+
bump (~> 0.10.0)
|
117
|
+
bundler (~> 2.5.6)
|
118
|
+
byebug (~> 11.1, >= 11.1.3)
|
119
|
+
fluent-plugin-kafka-status!
|
120
|
+
rake (~> 13.1.0)
|
121
|
+
reek (~> 6.1, >= 6.1.4)
|
122
|
+
rubocop (~> 1.56)
|
123
|
+
rubocop-rake (~> 0.6.0)
|
124
|
+
test-unit (~> 3.6.1)
|
125
|
+
timecop (~> 0.9.6)
|
126
|
+
|
127
|
+
BUNDLED WITH
|
128
|
+
2.5.6
|
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,63 @@
|
|
1
|
+
# fluent-plugin-kafka-status
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) input plugin for *kafka* status.
|
4
|
+
|
5
|
+
|
6
|
+
## plugins
|
7
|
+
|
8
|
+
### in - kafka_status
|
9
|
+
|
10
|
+
Poll kafka cluster status.
|
11
|
+
|
12
|
+
#### configuration
|
13
|
+
|
14
|
+
Example:
|
15
|
+
|
16
|
+
``` conf
|
17
|
+
<source>
|
18
|
+
@type kafka_status
|
19
|
+
tag kafka_status
|
20
|
+
</source>
|
21
|
+
```
|
22
|
+
|
23
|
+
Options are:
|
24
|
+
* tag: Tag to emit events on
|
25
|
+
* brokers: list of borkers <host>:<port>,...
|
26
|
+
* connect_timeout: timeout for connecting to brokers
|
27
|
+
* ssl_ca_cert: CA cert to use for SSL connection
|
28
|
+
* ssl_client_cert: client cert for the SSL connection
|
29
|
+
* ssl_client_cert_key: client key for the SSL connection
|
30
|
+
* ssl_verify_hostname: verify certificate hostname
|
31
|
+
* interval: interval between execution
|
32
|
+
* timestamp_format: iso, epochmillis timestamp format (iso)
|
33
|
+
* event_prefix: metric event prefix for extra dimension
|
34
|
+
|
35
|
+
#### output
|
36
|
+
|
37
|
+
Generated metrics are :
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
## Installation
|
42
|
+
|
43
|
+
Manual install, by executing:
|
44
|
+
|
45
|
+
$ gem install fluent-plugin-kafka-status
|
46
|
+
|
47
|
+
Add to Gemfile with:
|
48
|
+
|
49
|
+
$ bundle add fluent-plugin-kafka-status
|
50
|
+
|
51
|
+
|
52
|
+
## Compatibility
|
53
|
+
|
54
|
+
should work with:
|
55
|
+
- ruby >= 2.4.0
|
56
|
+
- ruby-kafka >= 1.3.0
|
57
|
+
|
58
|
+
|
59
|
+
## Copyright
|
60
|
+
|
61
|
+
* Copyright(c) 2024- Thomas Tych
|
62
|
+
* License
|
63
|
+
* Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'bundler'
|
4
|
+
Bundler::GemHelper.install_tasks
|
5
|
+
|
6
|
+
require 'rake/testtask'
|
7
|
+
Rake::TestTask.new(:test) do |t|
|
8
|
+
t.libs.push('lib', 'test')
|
9
|
+
t.test_files = FileList['test/**/test_*.rb', 'test/**/*_test.rb',]
|
10
|
+
t.verbose = true
|
11
|
+
t.warning = true
|
12
|
+
end
|
13
|
+
|
14
|
+
require 'rubocop/rake_task'
|
15
|
+
|
16
|
+
require 'bump/tasks'
|
17
|
+
|
18
|
+
task default: %i[test rubocop]
|
@@ -0,0 +1,39 @@
|
|
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-kafka-status'
|
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 extract status from kafka cluster'
|
13
|
+
spec.homepage = 'https://gitlab.com/ttych/fluent-plugin-kafka-status'
|
14
|
+
spec.license = 'Apache-2.0'
|
15
|
+
|
16
|
+
spec.required_ruby_version = '>= 2.4.0'
|
17
|
+
|
18
|
+
spec.metadata['rubygems_mfa_required'] = 'true'
|
19
|
+
|
20
|
+
_, files = `git ls-files -z`.split("\x0").partition do |f|
|
21
|
+
f.match(%r{^(test|spec|features)/})
|
22
|
+
end
|
23
|
+
spec.files = files
|
24
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
25
|
+
spec.require_paths = ['lib']
|
26
|
+
|
27
|
+
spec.add_development_dependency 'bump', '~> 0.10.0'
|
28
|
+
spec.add_development_dependency 'bundler', '~> 2.5.6'
|
29
|
+
spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
|
30
|
+
spec.add_development_dependency 'rake', '~> 13.1.0'
|
31
|
+
spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.4'
|
32
|
+
spec.add_development_dependency 'rubocop', '~> 1.56'
|
33
|
+
spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
|
34
|
+
spec.add_development_dependency 'test-unit', '~> 3.6.1'
|
35
|
+
spec.add_development_dependency 'timecop', '~> 0.9.6'
|
36
|
+
|
37
|
+
spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
|
38
|
+
spec.add_runtime_dependency 'ruby-kafka', ['>= 1.3.0', '< 2']
|
39
|
+
end
|
@@ -0,0 +1,220 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
#
|
4
|
+
# Copyright 2024- 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
|
+
require 'fluent/plugin/input'
|
19
|
+
|
20
|
+
require 'kafka'
|
21
|
+
|
22
|
+
require_relative 'kafka_status_utils'
|
23
|
+
require_relative 'time_ext'
|
24
|
+
|
25
|
+
module Fluent
|
26
|
+
module Plugin
|
27
|
+
class KafkaStatusInput < Fluent::Plugin::Input
|
28
|
+
NAME = 'kafka_status'
|
29
|
+
Fluent::Plugin.register_input(NAME, self)
|
30
|
+
|
31
|
+
include Fluent::Plugin::KafkaStatusUtils
|
32
|
+
|
33
|
+
helpers :event_emitter, :timer
|
34
|
+
|
35
|
+
DEFAULT_TAG = NAME
|
36
|
+
DEFAULT_BROKERS = ['localhost:9092']
|
37
|
+
DEFAULT_CLIENT_ID = "fluentd:#{NAME}"
|
38
|
+
DEFAULT_INTERVAL = 3600
|
39
|
+
DEFAULT_TIMESTAMP_FORMAT = :iso
|
40
|
+
DEFAULT_EVENT_PREFIX = ''
|
41
|
+
MAX_RETRIES = 3
|
42
|
+
|
43
|
+
config_param :tag, :string, default: DEFAULT_TAG,
|
44
|
+
desc: 'tag to emit status events on'
|
45
|
+
config_param :brokers, :array, value_type: :string, default: DEFAULT_BROKERS,
|
46
|
+
desc: 'kafka brokers: <host>:<port>,...'
|
47
|
+
config_param :client_id, :string, default: DEFAULT_CLIENT_ID,
|
48
|
+
desc: 'user agent like identifier for kafka connection'
|
49
|
+
config_param :connect_timeout, :integer, default: nil,
|
50
|
+
desc: 'timeout for connection to brokers'
|
51
|
+
|
52
|
+
config_param :ssl_ca_cert, :string, default: nil,
|
53
|
+
desc: 'a PEM encoded CA cert for SSL connection'
|
54
|
+
config_param :ssl_client_cert, :string, default: nil,
|
55
|
+
desc: 'a PEM encoded client cert for SSL connection'
|
56
|
+
config_param :ssl_client_cert_key, :string, default: nil,
|
57
|
+
desc: 'a PEM encoded client cert key for SSL connection'
|
58
|
+
config_param :ssl_verify_hostname, :bool, default: true,
|
59
|
+
desc: 'whether hostname of certificate should be verified or not'
|
60
|
+
|
61
|
+
config_param :interval, :time, default: DEFAULT_INTERVAL,
|
62
|
+
desc: 'interval for the plugin execution'
|
63
|
+
|
64
|
+
config_param :timestamp_format, :enum, list: %i[iso epochmillis], default: DEFAULT_TIMESTAMP_FORMAT,
|
65
|
+
desc: 'timestamp format'
|
66
|
+
config_param :event_prefix, :string, default: DEFAULT_EVENT_PREFIX,
|
67
|
+
desc: 'Event prefix'
|
68
|
+
|
69
|
+
def initialize
|
70
|
+
super
|
71
|
+
|
72
|
+
@kafka = nil
|
73
|
+
end
|
74
|
+
|
75
|
+
def configure(conf)
|
76
|
+
super
|
77
|
+
|
78
|
+
raise Fluent::ConfigError, 'tag should not be empty' if tag.nil? || tag.empty?
|
79
|
+
raise Fluent::ConfigError, 'No brokers specified. Need one broker at least.' if brokers.empty?
|
80
|
+
raise Fluent::ConfigError, 'ssl_ca_cert should be a file.' if ssl_ca_cert && !File.file?(ssl_ca_cert)
|
81
|
+
|
82
|
+
raise Fluent::ConfigError, 'ssl_client_cert should be a file.' if ssl_client_cert && !File.file?(ssl_client_cert)
|
83
|
+
raise Fluent::ConfigError, 'ssl_client_cert_key should be a file.' if ssl_client_cert_key && !File.file?(ssl_client_cert_key)
|
84
|
+
end
|
85
|
+
|
86
|
+
def start
|
87
|
+
super
|
88
|
+
|
89
|
+
timer_execute(:kafka_status_first, 1, repeat: false, &method(:kafka_status)) if interval > 60
|
90
|
+
|
91
|
+
timer_execute(:kafka_status, interval, repeat: true, &method(:kafka_status))
|
92
|
+
end
|
93
|
+
|
94
|
+
def shutdown
|
95
|
+
super
|
96
|
+
close_kafka
|
97
|
+
end
|
98
|
+
|
99
|
+
def kafka_status
|
100
|
+
events = []
|
101
|
+
events += events_for_topics
|
102
|
+
events += events_for_cluster_brokers
|
103
|
+
time = Fluent::Engine.now
|
104
|
+
events.each { |event| router.emit(tag, time, event) }
|
105
|
+
end
|
106
|
+
|
107
|
+
### metric 1 - active topic
|
108
|
+
# family: topic
|
109
|
+
# name: active
|
110
|
+
# value: 1
|
111
|
+
# tags_topic: <topic>
|
112
|
+
### metric 2 - partitions_count
|
113
|
+
# family: topic
|
114
|
+
# name: configured_partitions_count
|
115
|
+
# value: X
|
116
|
+
# tags_topic: <topic>
|
117
|
+
### metric 3 - replica_count
|
118
|
+
# family: topic
|
119
|
+
# name: replica_count
|
120
|
+
# value: count
|
121
|
+
# tags_topic: <topic>
|
122
|
+
def events_for_topics
|
123
|
+
kafka do |kafka|
|
124
|
+
events = []
|
125
|
+
timestamp = Time.now.utc.send("to_#{timestamp_format}")
|
126
|
+
kafka.topics.each do |topic|
|
127
|
+
events
|
128
|
+
.append({ 'timestamp' => timestamp,
|
129
|
+
'metric_family' => 'topic',
|
130
|
+
'metric_name' => 'active',
|
131
|
+
'metric_value' => 1,
|
132
|
+
"#{event_prefix}topic" => topic })
|
133
|
+
.append({ 'timestamp' => timestamp,
|
134
|
+
'metric_family' => 'topic',
|
135
|
+
'metric_name' => 'configured_partitions_count',
|
136
|
+
'metric_value' => kafka.partitions_for(topic),
|
137
|
+
"#{event_prefix}topic" => topic })
|
138
|
+
.append({ 'timestamp' => timestamp,
|
139
|
+
'metric_family' => 'topic',
|
140
|
+
'metric_name' => 'replica_count',
|
141
|
+
'metric_value' => kafka.replica_count_for(topic),
|
142
|
+
"#{event_prefix}topic" => topic })
|
143
|
+
end
|
144
|
+
events
|
145
|
+
end
|
146
|
+
end
|
147
|
+
|
148
|
+
### metric 4 - brokers_count
|
149
|
+
# family: cluster
|
150
|
+
# name: brokers_count
|
151
|
+
# value: count
|
152
|
+
# ???
|
153
|
+
### metric 5 - broker_active
|
154
|
+
# family: cluster
|
155
|
+
# name: broker_active
|
156
|
+
# value: 1
|
157
|
+
# tags_member_host: <host>
|
158
|
+
# ???
|
159
|
+
def events_for_cluster_brokers
|
160
|
+
kafka do |kafka|
|
161
|
+
events = []
|
162
|
+
timestamp = Time.now.utc.send("to_#{timestamp_format}")
|
163
|
+
brokers = kafka.brokers
|
164
|
+
events.append({
|
165
|
+
'timestamp' => timestamp,
|
166
|
+
'metric_family' => 'cluster',
|
167
|
+
'metric_name' => 'brokers_count',
|
168
|
+
'metric_value' => brokers.size
|
169
|
+
})
|
170
|
+
brokers.each do |broker|
|
171
|
+
events.append({
|
172
|
+
'timestamp' => timestamp,
|
173
|
+
'metric_family' => 'cluster',
|
174
|
+
'metric_name' => 'broker_active',
|
175
|
+
'metric_value' => 1,
|
176
|
+
'tags_member_host' => broker.host
|
177
|
+
})
|
178
|
+
end
|
179
|
+
events
|
180
|
+
end
|
181
|
+
end
|
182
|
+
|
183
|
+
def kafka(max_retries = MAX_RETRIES)
|
184
|
+
retry_count = 0
|
185
|
+
begin
|
186
|
+
@kafka ||= new_kafka
|
187
|
+
yield @kafka if block_given?
|
188
|
+
rescue StandardError => e
|
189
|
+
log.error "exception with kafka connection: #{e}"
|
190
|
+
raise e if (retry_count += 1) > max_retries
|
191
|
+
|
192
|
+
close_kafka
|
193
|
+
sleep 30
|
194
|
+
retry
|
195
|
+
end
|
196
|
+
end
|
197
|
+
|
198
|
+
def new_kafka
|
199
|
+
kafka = Kafka.new(
|
200
|
+
seed_brokers: brokers,
|
201
|
+
client_id: @client_id,
|
202
|
+
connect_timeout: connect_timeout,
|
203
|
+
ssl_ca_cert: read_file(ssl_ca_cert),
|
204
|
+
ssl_client_cert: read_file(ssl_client_cert),
|
205
|
+
ssl_client_cert_key: read_file(ssl_client_cert_key),
|
206
|
+
ssl_ca_certs_from_system: !!ssl_ca_cert,
|
207
|
+
ssl_verify_hostname: ssl_verify_hostname
|
208
|
+
)
|
209
|
+
log.info "initialized kafka producer: #{@client_id}"
|
210
|
+
kafka
|
211
|
+
end
|
212
|
+
|
213
|
+
def close_kafka
|
214
|
+
@kafka&.close
|
215
|
+
@kafka = nil
|
216
|
+
rescue StandardError
|
217
|
+
end
|
218
|
+
end
|
219
|
+
end
|
220
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# extensions for Time class
|
4
|
+
# provides formater
|
5
|
+
# - to epoch millisecond format
|
6
|
+
# - to iso format with millisecond
|
7
|
+
class Time
|
8
|
+
def to_epochmillis
|
9
|
+
(to_f * 1000).to_i
|
10
|
+
end
|
11
|
+
|
12
|
+
def to_iso
|
13
|
+
iso8601(3)
|
14
|
+
end
|
15
|
+
end
|
metadata
ADDED
@@ -0,0 +1,233 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-kafka-status
|
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: 2024-02-11 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.5.6
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 2.5.6
|
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.1.0
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 13.1.0
|
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.4
|
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.4
|
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.56'
|
102
|
+
type: :development
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - "~>"
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: '1.56'
|
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.6.1
|
130
|
+
type: :development
|
131
|
+
prerelease: false
|
132
|
+
version_requirements: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - "~>"
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: 3.6.1
|
137
|
+
- !ruby/object:Gem::Dependency
|
138
|
+
name: timecop
|
139
|
+
requirement: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - "~>"
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: 0.9.6
|
144
|
+
type: :development
|
145
|
+
prerelease: false
|
146
|
+
version_requirements: !ruby/object:Gem::Requirement
|
147
|
+
requirements:
|
148
|
+
- - "~>"
|
149
|
+
- !ruby/object:Gem::Version
|
150
|
+
version: 0.9.6
|
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: ruby-kafka
|
173
|
+
requirement: !ruby/object:Gem::Requirement
|
174
|
+
requirements:
|
175
|
+
- - ">="
|
176
|
+
- !ruby/object:Gem::Version
|
177
|
+
version: 1.3.0
|
178
|
+
- - "<"
|
179
|
+
- !ruby/object:Gem::Version
|
180
|
+
version: '2'
|
181
|
+
type: :runtime
|
182
|
+
prerelease: false
|
183
|
+
version_requirements: !ruby/object:Gem::Requirement
|
184
|
+
requirements:
|
185
|
+
- - ">="
|
186
|
+
- !ruby/object:Gem::Version
|
187
|
+
version: 1.3.0
|
188
|
+
- - "<"
|
189
|
+
- !ruby/object:Gem::Version
|
190
|
+
version: '2'
|
191
|
+
description:
|
192
|
+
email:
|
193
|
+
- thomas.tych@gmail.com
|
194
|
+
executables: []
|
195
|
+
extensions: []
|
196
|
+
extra_rdoc_files: []
|
197
|
+
files:
|
198
|
+
- ".gitignore"
|
199
|
+
- ".rubocop.yml"
|
200
|
+
- Gemfile
|
201
|
+
- Gemfile.lock
|
202
|
+
- LICENSE
|
203
|
+
- README.md
|
204
|
+
- Rakefile
|
205
|
+
- fluent-plugin-kafka-status.gemspec
|
206
|
+
- lib/fluent/plugin/in_kafka_status.rb
|
207
|
+
- lib/fluent/plugin/kafka_status_utils.rb
|
208
|
+
- lib/fluent/plugin/time_ext.rb
|
209
|
+
homepage: https://gitlab.com/ttych/fluent-plugin-kafka-status
|
210
|
+
licenses:
|
211
|
+
- Apache-2.0
|
212
|
+
metadata:
|
213
|
+
rubygems_mfa_required: 'true'
|
214
|
+
post_install_message:
|
215
|
+
rdoc_options: []
|
216
|
+
require_paths:
|
217
|
+
- lib
|
218
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
219
|
+
requirements:
|
220
|
+
- - ">="
|
221
|
+
- !ruby/object:Gem::Version
|
222
|
+
version: 2.4.0
|
223
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
224
|
+
requirements:
|
225
|
+
- - ">="
|
226
|
+
- !ruby/object:Gem::Version
|
227
|
+
version: '0'
|
228
|
+
requirements: []
|
229
|
+
rubygems_version: 3.5.6
|
230
|
+
signing_key:
|
231
|
+
specification_version: 4
|
232
|
+
summary: fluentd plugin to extract status from kafka cluster
|
233
|
+
test_files: []
|