fluent-plugin-avroturf_confluent 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/Gemfile +3 -0
- data/LICENSE +202 -0
- data/README.md +246 -0
- data/Rakefile +13 -0
- data/fluent-plugin-avroturf_confluent.gemspec +28 -0
- data/lib/fluent/plugin/formatter_avroturf_serializer.rb +82 -0
- data/test/helper.rb +8 -0
- data/test/plugin/test_formatter_avroturf_confluent.rb +18 -0
- metadata +137 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 564d0b924f1eb20e6685b2ed3be8191d0c0a7993b9e51412b8af6c65414438f0
|
4
|
+
data.tar.gz: 19fb10a949d509d324f73ce52a449c6a84ac41bd822fdd3658752977026c9de8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b24f1fc425affcb11f7da447f04030b83abcff294222cc871176467e7fad2850d66944f168986c85851376105e000020db0bf31c6f3562d4958bc1913b32a8f6
|
7
|
+
data.tar.gz: 50cda25ac57e802d472bf8ce5037ad5666eabdd160bd877a0e9a132fcf42d2cdf1958343ae6874a229cf68bbd8b0068ce685644beb867f702e8569b50330ea03
|
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,246 @@
|
|
1
|
+
# fluent-plugin-avroturf_confluent
|
2
|
+
## Overview
|
3
|
+
Schema Registry manages and stores data schemas that are shared between different services. It is commonly used in Apache Kafka to ensure that data exchanged among different producers and consumers adheres to a predefined schema or data structure. `fluent-plugin-avroturf_confluent` is formatter plugin developed for `fluent-plugin-kafka/out_rdkafka2` to serialize messages in key-value pairs format into Avro format before shipping messages to Kafka brokers. The plugin utilizes [AvroTurf](https://github.com/dasch/avro_turf) library to register and retrieve schemas from the Schema Registry provided by Confluent Cloud, and then serialize key-value pairs into avro format.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
### RubyGems
|
8
|
+
For vanila Fluentd :
|
9
|
+
```
|
10
|
+
$ gem install fluent-plugin-avroturf-confluent
|
11
|
+
```
|
12
|
+
For td-agent v4 or later (scheduled EoL on Dec 2023) :
|
13
|
+
```
|
14
|
+
$ /opt/td-agent/bin/fluent-gem install fluent-plugin-avroturf-confluent
|
15
|
+
```
|
16
|
+
For fluent-package v5 or later :
|
17
|
+
```
|
18
|
+
$ /opt/fluent/bin/fluent-gem install fluent-plugin-avroturf-confluent
|
19
|
+
```
|
20
|
+
|
21
|
+
## Configuration
|
22
|
+
### Available Options of `avroturf_serializer` formatter
|
23
|
+
The following options are mandatory to access Schema Registry
|
24
|
+
- `schema_registry_url` : URL of Schema Resigtry
|
25
|
+
- `schema_registry_api_key` : API key to access Schema Resigtry
|
26
|
+
- `schema_registry_api_secret` : API Secret to access Schema Resigtry
|
27
|
+
|
28
|
+
The options below are required to configure based on schema fetching patterns.
|
29
|
+
- `schema_subject` : Subject name of schema (default: nil)
|
30
|
+
- `schema_version` : Version of schema (default: nil)
|
31
|
+
- `schema_id` : ID of schema (default: nil)
|
32
|
+
- `schemas_path` : Path of directory which stores avsc files (default: ./schemas/)
|
33
|
+
- `schema_name` : Name of schema (default: nil)
|
34
|
+
- `validate` : validate a message before serializing it. (default: false)
|
35
|
+
- `format_as_json_when_encode_failed` : Format as JSON when encode process failed. (defalut: false)
|
36
|
+
|
37
|
+
### Configuration Patterns
|
38
|
+
There are 3 configuration patterns to fetch schema.
|
39
|
+
- Pattern#1 : Fetch schema with subject name and its version
|
40
|
+
- It is required to configure both `schema_subject` and `schema_version`.
|
41
|
+
- Formatter plugin fetches that schema from the Schema Registry and cache it. When `schema_version` is `latest`, formatter fetches schema from Schema Registry every time before encoding.
|
42
|
+
- `validate` option is optional.
|
43
|
+
```
|
44
|
+
<format>
|
45
|
+
@type avroturf_serializer
|
46
|
+
schema_registry_url "#{ENV['SCHEMA_REGISTRY_URL']}"
|
47
|
+
schema_registry_api_key "#{ENV['SCHEMA_REGISTRY_API_KEY']}"
|
48
|
+
schema_registry_api_secret "#{ENV['SCHEMA_REGISTRY_API_SECRET']}"
|
49
|
+
|
50
|
+
### Pattern#1 : Fetch schema with subject name and version
|
51
|
+
schema_subject <your subject name>
|
52
|
+
schema_version <version of your subject>
|
53
|
+
validate false
|
54
|
+
</format>
|
55
|
+
```
|
56
|
+
- Pattern#2 : Fetch schema with ID
|
57
|
+
- `schema_id` option is required.
|
58
|
+
- `validate` option is optional.
|
59
|
+
```
|
60
|
+
<format>
|
61
|
+
@type avroturf_serializer
|
62
|
+
schema_registry_url "#{ENV['SCHEMA_REGISTRY_URL']}"
|
63
|
+
schema_registry_api_key "#{ENV['SCHEMA_REGISTRY_API_KEY']}"
|
64
|
+
schema_registry_api_secret "#{ENV['SCHEMA_REGISTRY_API_SECRET']}"
|
65
|
+
|
66
|
+
### Pattern#2 : Fetch schema with ID
|
67
|
+
#schema_id <your Schema ID>
|
68
|
+
</format>
|
69
|
+
```
|
70
|
+
- Pattern#3 : Fetch schema from avsc
|
71
|
+
- `schemas_path` and `schema_name` are needed to fetch schema from local avsc files.
|
72
|
+
- Given the following configuration, formatter plugin fetches schema from `/etc/fluent/schemas/test_address1.avsc`.
|
73
|
+
- When `namespace` is defined in a schema, avsc files shoud be stored under `<schemas_path>/<namespace>/<schema_name>.avsc`
|
74
|
+
- New schema is registered when there is no compatible schemas in Schema Registry.
|
75
|
+
```
|
76
|
+
### Configuration schema without namespace definition
|
77
|
+
<format>
|
78
|
+
@type avroturf_serializer
|
79
|
+
schema_registry_url "#{ENV['SCHEMA_REGISTRY_URL']}"
|
80
|
+
schema_registry_api_key "#{ENV['SCHEMA_REGISTRY_API_KEY']}"
|
81
|
+
schema_registry_api_secret "#{ENV['SCHEMA_REGISTRY_API_SECRET']}"
|
82
|
+
|
83
|
+
### Pattern#3 : Get schema from avsc
|
84
|
+
schemas_path /etc/fluent/schemas
|
85
|
+
schema_name test_address1
|
86
|
+
</format>
|
87
|
+
|
88
|
+
### /etc/fluent/schemas/test_address1.avsc
|
89
|
+
{
|
90
|
+
"name": "test_address1",
|
91
|
+
"type": "record",
|
92
|
+
"fields": [
|
93
|
+
{
|
94
|
+
"name": "state",
|
95
|
+
"type": "string"
|
96
|
+
},
|
97
|
+
{
|
98
|
+
"name": "city",
|
99
|
+
"type": "string"
|
100
|
+
}
|
101
|
+
]
|
102
|
+
}
|
103
|
+
```
|
104
|
+
```
|
105
|
+
### Configuration when schema with namespace definition
|
106
|
+
<format>
|
107
|
+
@type avroturf_serializer
|
108
|
+
schema_registry_url "#{ENV['SCHEMA_REGISTRY_URL']}"
|
109
|
+
schema_registry_api_key "#{ENV['SCHEMA_REGISTRY_API_KEY']}"
|
110
|
+
schema_registry_api_secret "#{ENV['SCHEMA_REGISTRY_API_SECRET']}"
|
111
|
+
|
112
|
+
### Get schema from avsc
|
113
|
+
schemas_path /etc/fluent/schemas/
|
114
|
+
namespace demo
|
115
|
+
schema_name test_address2
|
116
|
+
</format>
|
117
|
+
|
118
|
+
### /etc/fluent/schemas/demo/test_address2.avsc
|
119
|
+
{
|
120
|
+
"name": "test_address2",
|
121
|
+
"namespace": "demo",
|
122
|
+
"type": "record",
|
123
|
+
"fields": [
|
124
|
+
{
|
125
|
+
"name": "city",
|
126
|
+
"type": "string"
|
127
|
+
},
|
128
|
+
{
|
129
|
+
"name": "state",
|
130
|
+
"type": "string"
|
131
|
+
},
|
132
|
+
{
|
133
|
+
"name": "country",
|
134
|
+
"type": "string"
|
135
|
+
}
|
136
|
+
]
|
137
|
+
}
|
138
|
+
```
|
139
|
+
|
140
|
+
## Working sample with rdkafka2 output plugin
|
141
|
+
|
142
|
+
As noted in the introduction, `fluent-plugin-avroturf-confluent` plugin is developed primary for `out_rdkafka2`. It may work with other output plugins but not tested yet.
|
143
|
+
Here is the sample configuration which serializes dummy messages into avro format with `avroturf_serializer` formatter plugin, and sends them to Kafka cluster in Confluent Cloud.
|
144
|
+
|
145
|
+
```
|
146
|
+
<source>
|
147
|
+
@type dummy
|
148
|
+
### test_address2; 100009
|
149
|
+
dummy {"state":"ca","city":"santa clara","country":"us"}
|
150
|
+
tag dummy
|
151
|
+
</source>
|
152
|
+
|
153
|
+
<match dummy>
|
154
|
+
@type rdkafka2
|
155
|
+
|
156
|
+
## Broker settings
|
157
|
+
brokers "#{ENV['CONFLUENT_BOOTSTRAP_SERVERS']}"
|
158
|
+
|
159
|
+
## Kafka producer settings
|
160
|
+
required_acks 1
|
161
|
+
ack_timeout 20
|
162
|
+
compression_codec snappy
|
163
|
+
share_producer true
|
164
|
+
|
165
|
+
## SASL settings
|
166
|
+
rdkafka_options {"security.protocol":"SASL_SSL","sasl.mechanisms":"PLAIN"}
|
167
|
+
username "#{ENV['CONFLUENT_SASL_USERNAME']}"
|
168
|
+
password "#{ENV['CONFLUENT_SASL_PASSWORD']}"
|
169
|
+
|
170
|
+
## topic settings
|
171
|
+
default_topic topic-test-01
|
172
|
+
|
173
|
+
<format>
|
174
|
+
@type avroturf_serializer
|
175
|
+
schema_registry_url "#{ENV['SCHEMA_REGISTRY_URL']}"
|
176
|
+
schema_registry_api_key "#{ENV['SCHEMA_REGISTRY_API_KEY']}"
|
177
|
+
schema_registry_api_secret "#{ENV['SCHEMA_REGISTRY_API_SECRET']}"
|
178
|
+
schema_id 100009
|
179
|
+
</format>
|
180
|
+
|
181
|
+
<buffer>
|
182
|
+
@type file
|
183
|
+
path /data/fluentd/buffer/
|
184
|
+
flush_interval 5s
|
185
|
+
flush_thread_count 32
|
186
|
+
queued_chunks_limit_size 32
|
187
|
+
chunk_limit_size 1m
|
188
|
+
total_limit_size 10000m
|
189
|
+
</buffer>
|
190
|
+
|
191
|
+
</match>
|
192
|
+
```
|
193
|
+
Here is the sample Kafka Consumer application written in Ruby.
|
194
|
+
```
|
195
|
+
### rdkafka_consumer_sasl_plaintext.rb
|
196
|
+
require 'rdkafka'
|
197
|
+
require 'avro_turf/messaging'
|
198
|
+
require 'avro_turf/confluent_schema_registry'
|
199
|
+
|
200
|
+
bootstrap_servers=ENV["CONFLUENT_BOOTSTRAP_SERVERS"]
|
201
|
+
security_protocol="SASL_SSL"
|
202
|
+
sasl_mechanisms="PLAIN"
|
203
|
+
sasl_username=ENV["CONFLUENT_SASL_USERNAME"]
|
204
|
+
sasl_password=ENV["CONFLUENT_SASL_PASSWORD"]
|
205
|
+
|
206
|
+
sr_url=ENV["SCHEMA_REGISTRY_URL"]
|
207
|
+
sr_api_key=ENV["SCHEMA_REGISTRY_API_KEY"]
|
208
|
+
sr_api_secret=ENV["SCHEMA_REGISTRY_API_SECRET"]
|
209
|
+
|
210
|
+
topic = "topic-order-01"
|
211
|
+
|
212
|
+
config = {
|
213
|
+
:"bootstrap.servers" => bootstrap_servers,
|
214
|
+
:"security.protocol" => security_protocol,
|
215
|
+
:"sasl.mechanisms" => sasl_mechanisms,
|
216
|
+
:"sasl.username" => sasl_username,
|
217
|
+
:"sasl.password" => sasl_password,
|
218
|
+
:"group.id" => "mygroup"
|
219
|
+
}
|
220
|
+
|
221
|
+
registry = AvroTurf::ConfluentSchemaRegistry.new(sr_url, user:sr_api_key, password:sr_api_secret)
|
222
|
+
avro = AvroTurf::Messaging.new(registry:registry)
|
223
|
+
|
224
|
+
rdkafka = Rdkafka::Config.new(config)
|
225
|
+
consumer = rdkafka.consumer
|
226
|
+
consumer.subscribe(topic)
|
227
|
+
consumer.each do |message|
|
228
|
+
puts avro.decode(message.payload)
|
229
|
+
end
|
230
|
+
```
|
231
|
+
If you are using `fluent-package`, you can try out easily with the following command:
|
232
|
+
```
|
233
|
+
root@fluent-guest01 schema (test)$ /opt/fluent/bin/ruby rdkafka_consumer_sasl_plaintext.rb
|
234
|
+
I, [2023-10-24T23:04:28.019645 #363246] INFO -- : Fetching schema with id 100009
|
235
|
+
{"city"=>"santa clara", "state"=>"ca", "country"=>"us"}
|
236
|
+
{"city"=>"santa clara", "state"=>"ca", "country"=>"us"}
|
237
|
+
{"city"=>"santa clara", "state"=>"ca", "country"=>"us"}
|
238
|
+
{"city"=>"santa clara", "state"=>"ca", "country"=>"us"}
|
239
|
+
```
|
240
|
+
|
241
|
+
|
242
|
+
## Copyright
|
243
|
+
|
244
|
+
* Copyright(c) 2023- Tomonori Kubota (TK)
|
245
|
+
* License
|
246
|
+
* 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-avroturf_confluent"
|
6
|
+
spec.version = "0.1.0"
|
7
|
+
spec.authors = ["kubotat"]
|
8
|
+
spec.email = ["tkubota@ctc-america.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{Fluentd formatter plugin for Confluent Schema Registry}
|
11
|
+
spec.description = %q{fluent-plugin-avroturf_confluent is formatter plugin developed for fluent-plugin-kafka/out_rdkafka2 to serialize messages in key-value pairs format into Avro format before shipping messages to Kafka brokers.}
|
12
|
+
spec.homepage = "https://github.com/FluentdSubscriptionNetwork/fluent-plugin-avroturf_confluent"
|
13
|
+
spec.license = "Apache-2.0"
|
14
|
+
|
15
|
+
test_files, files = `git ls-files -z`.split("\x0").partition do |f|
|
16
|
+
f.match(%r{^(test|spec|features)/})
|
17
|
+
end
|
18
|
+
spec.files = files
|
19
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
20
|
+
spec.test_files = test_files
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
24
|
+
spec.add_development_dependency "rake", "~> 12.0"
|
25
|
+
spec.add_development_dependency "test-unit", "~> 3.0"
|
26
|
+
spec.add_development_dependency 'avro_turf', '~> 1.14', '>= 1.14.0'
|
27
|
+
spec.add_runtime_dependency "fluentd", [">= 1.11", "< 2"]
|
28
|
+
end
|
@@ -0,0 +1,82 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2023- Tomonori Kubota (TK)
|
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/formatter"
|
17
|
+
require 'fluent/oj_options'
|
18
|
+
require 'avro_turf/messaging'
|
19
|
+
require 'avro_turf/confluent_schema_registry'
|
20
|
+
|
21
|
+
module Fluent
|
22
|
+
module Plugin
|
23
|
+
class AvroturfSerializer < Fluent::Plugin::Formatter
|
24
|
+
Fluent::Plugin.register_formatter("avroturf_serializer", self)
|
25
|
+
|
26
|
+
config_param :schema_registry_url, :string, :default => nil, :desc => "URL of Confluent Schema Registry"
|
27
|
+
config_param :schema_registry_api_key, :string, :default => nil, :secret => true, :desc => "API key of Confluent Schema Registry"
|
28
|
+
config_param :schema_registry_api_secret, :string, :default => nil, :secret => true, :desc => "API secret of Confluent Schema Registry"
|
29
|
+
|
30
|
+
config_param :namespace, :string, :default => nil, :desc => "The namespace of schema"
|
31
|
+
config_param :schema_subject, :string, :default => nil, :desc => "The name of subject stored in Schema Registry"
|
32
|
+
config_param :schema_version, :string, :default => nil, :desc => "The version of subject stored in Schema Registry"
|
33
|
+
|
34
|
+
config_param :schemas_path, :string, :default => "./schemas/", :desc => "The directory path where Avro schema files(.avsc) are stored"
|
35
|
+
config_param :schema_name, :string, :default => nil, :desc => "The name of schemas stored in Avro schema files"
|
36
|
+
|
37
|
+
config_param :schema_id, :integer, :default => nil, :desc => "The ID of schemas stored in Schema Registry"
|
38
|
+
config_param :validate, :bool, :default => false, :desc => "Validate the message during encoding process(default: false)"
|
39
|
+
|
40
|
+
config_param :format_as_json_when_encode_failed, :bool, :default => false, :desc => "Format events as JSON when encoding failed(default: false)"
|
41
|
+
|
42
|
+
def configure(conf)
|
43
|
+
super
|
44
|
+
if @schema_registry_url == nil || @schema_registry_api_key == nil || @schema_registry_api_secret ==nil
|
45
|
+
raise Fluent::ConfigError, "schema_registry_url, schema_registry_api_key and schema_registry_api_secret are mandatory"
|
46
|
+
end
|
47
|
+
@avro = AvroTurf::Messaging.new(
|
48
|
+
registry_url: @schema_registry_url,
|
49
|
+
user: @schema_registry_api_key,
|
50
|
+
password: @schema_registry_api_secret,
|
51
|
+
schemas_path: @schemas_path,
|
52
|
+
)
|
53
|
+
if @format_as_json_when_encode_failed
|
54
|
+
@dump_proc = Oj.method(:dump)
|
55
|
+
end
|
56
|
+
|
57
|
+
if @schema_subject
|
58
|
+
raise Fluent::ConfigError, "schema_version is required when fetching schema with schema_subject" if @schema_version == nil
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
def format(tag, time, record)
|
63
|
+
begin
|
64
|
+
encoded_data = @avro.encode(
|
65
|
+
record,
|
66
|
+
subject: @schema_subject,
|
67
|
+
version: @schema_version,
|
68
|
+
schema_name: @schema_name,
|
69
|
+
schema_id: @schema_id,
|
70
|
+
validate: @validate,
|
71
|
+
namespace: @namespace
|
72
|
+
)
|
73
|
+
rescue => e
|
74
|
+
if @format_as_json_when_encode_failed
|
75
|
+
log.debug "Encode failed. Format events as JSON instead.", :error => e.to_s, :error_class => e.class.to_s, :tag => tag
|
76
|
+
"#{@dump_proc.call(record)}#{@newline}"
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
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/formatter"
|
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,18 @@
|
|
1
|
+
require "helper"
|
2
|
+
require "fluent/plugin/formatter_avroturf_confluent.rb"
|
3
|
+
|
4
|
+
class AvroturfConfluentFormatterTest < Test::Unit::TestCase
|
5
|
+
setup do
|
6
|
+
Fluent::Test.setup
|
7
|
+
end
|
8
|
+
|
9
|
+
test "failure" do
|
10
|
+
flunk
|
11
|
+
end
|
12
|
+
|
13
|
+
private
|
14
|
+
|
15
|
+
def create_driver(conf)
|
16
|
+
Fluent::Test::Driver::Formatter.new(Fluent::Plugin::AvroturfConfluentFormatter).configure(conf)
|
17
|
+
end
|
18
|
+
end
|
metadata
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-avroturf_confluent
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- kubotat
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-10-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: avro_turf
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.14'
|
62
|
+
- - ">="
|
63
|
+
- !ruby/object:Gem::Version
|
64
|
+
version: 1.14.0
|
65
|
+
type: :development
|
66
|
+
prerelease: false
|
67
|
+
version_requirements: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - "~>"
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: '1.14'
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 1.14.0
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: fluentd
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '1.11'
|
82
|
+
- - "<"
|
83
|
+
- !ruby/object:Gem::Version
|
84
|
+
version: '2'
|
85
|
+
type: :runtime
|
86
|
+
prerelease: false
|
87
|
+
version_requirements: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - ">="
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '1.11'
|
92
|
+
- - "<"
|
93
|
+
- !ruby/object:Gem::Version
|
94
|
+
version: '2'
|
95
|
+
description: fluent-plugin-avroturf_confluent is formatter plugin developed for fluent-plugin-kafka/out_rdkafka2
|
96
|
+
to serialize messages in key-value pairs format into Avro format before shipping
|
97
|
+
messages to Kafka brokers.
|
98
|
+
email:
|
99
|
+
- tkubota@ctc-america.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- Gemfile
|
105
|
+
- LICENSE
|
106
|
+
- README.md
|
107
|
+
- Rakefile
|
108
|
+
- fluent-plugin-avroturf_confluent.gemspec
|
109
|
+
- lib/fluent/plugin/formatter_avroturf_serializer.rb
|
110
|
+
- test/helper.rb
|
111
|
+
- test/plugin/test_formatter_avroturf_confluent.rb
|
112
|
+
homepage: https://github.com/FluentdSubscriptionNetwork/fluent-plugin-avroturf_confluent
|
113
|
+
licenses:
|
114
|
+
- Apache-2.0
|
115
|
+
metadata: {}
|
116
|
+
post_install_message:
|
117
|
+
rdoc_options: []
|
118
|
+
require_paths:
|
119
|
+
- lib
|
120
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - ">="
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
requirements: []
|
131
|
+
rubygems_version: 3.4.10
|
132
|
+
signing_key:
|
133
|
+
specification_version: 4
|
134
|
+
summary: Fluentd formatter plugin for Confluent Schema Registry
|
135
|
+
test_files:
|
136
|
+
- test/helper.rb
|
137
|
+
- test/plugin/test_formatter_avroturf_confluent.rb
|