-
Notifications
You must be signed in to change notification settings - Fork 478
/
kafka.go
318 lines (276 loc) · 10.4 KB
/
kafka.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
// Package kafka provides an otelcol.receiver.kafka component.
package kafka
import (
"time"
"github.com/grafana/agent/component"
"github.com/grafana/agent/component/otelcol"
"github.com/grafana/agent/component/otelcol/receiver"
otel_service "github.com/grafana/agent/service/otel"
"github.com/grafana/river/rivertypes"
"github.com/mitchellh/mapstructure"
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/kafkaexporter"
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/kafkareceiver"
otelcomponent "go.opentelemetry.io/collector/component"
otelextension "go.opentelemetry.io/collector/extension"
)
func init() {
component.Register(component.Registration{
Name: "otelcol.receiver.kafka",
Args: Arguments{},
NeedsServices: []string{otel_service.ServiceName},
Build: func(opts component.Options, args component.Arguments) (component.Component, error) {
fact := kafkareceiver.NewFactory()
return receiver.New(opts, fact, args.(Arguments))
},
})
}
// Arguments configures the otelcol.receiver.kafka component.
type Arguments struct {
Brokers []string `river:"brokers,attr"`
ProtocolVersion string `river:"protocol_version,attr"`
Topic string `river:"topic,attr,optional"`
Encoding string `river:"encoding,attr,optional"`
GroupID string `river:"group_id,attr,optional"`
ClientID string `river:"client_id,attr,optional"`
InitialOffset string `river:"initial_offset,attr,optional"`
Authentication AuthenticationArguments `river:"authentication,block,optional"`
Metadata MetadataArguments `river:"metadata,block,optional"`
AutoCommit AutoCommitArguments `river:"autocommit,block,optional"`
MessageMarking MessageMarkingArguments `river:"message_marking,block,optional"`
HeaderExtraction HeaderExtraction `river:"header_extraction,block,optional"`
// DebugMetrics configures component internal metrics. Optional.
DebugMetrics otelcol.DebugMetricsArguments `river:"debug_metrics,block,optional"`
// Output configures where to send received data. Required.
Output *otelcol.ConsumerArguments `river:"output,block"`
}
var _ receiver.Arguments = Arguments{}
// DefaultArguments holds default values for Arguments.
var DefaultArguments = Arguments{
// We use the defaults from the upstream OpenTelemetry Collector component
// for compatibility, even though that means using a client and group ID of
// "otel-collector".
Topic: "otlp_spans",
Encoding: "otlp_proto",
Brokers: []string{"localhost:9092"},
ClientID: "otel-collector",
GroupID: "otel-collector",
InitialOffset: "latest",
Metadata: MetadataArguments{
IncludeAllTopics: true,
Retry: MetadataRetryArguments{
MaxRetries: 3,
Backoff: 250 * time.Millisecond,
},
},
AutoCommit: AutoCommitArguments{
Enable: true,
Interval: time.Second,
},
MessageMarking: MessageMarkingArguments{
AfterExecution: false,
IncludeUnsuccessful: false,
},
HeaderExtraction: HeaderExtraction{
ExtractHeaders: false,
Headers: []string{},
},
}
// SetToDefault implements river.Defaulter.
func (args *Arguments) SetToDefault() {
*args = DefaultArguments
}
// Convert implements receiver.Arguments.
func (args Arguments) Convert() (otelcomponent.Config, error) {
input := make(map[string]interface{})
input["auth"] = args.Authentication.Convert()
var result kafkareceiver.Config
err := mapstructure.Decode(input, &result)
if err != nil {
return nil, err
}
result.Brokers = args.Brokers
result.ProtocolVersion = args.ProtocolVersion
result.Topic = args.Topic
result.Encoding = args.Encoding
result.GroupID = args.GroupID
result.ClientID = args.ClientID
result.InitialOffset = args.InitialOffset
result.Metadata = args.Metadata.Convert()
result.AutoCommit = args.AutoCommit.Convert()
result.MessageMarking = args.MessageMarking.Convert()
result.HeaderExtraction = args.HeaderExtraction.Convert()
return &result, nil
}
// Extensions implements receiver.Arguments.
func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension {
return nil
}
// Exporters implements receiver.Arguments.
func (args Arguments) Exporters() map[otelcomponent.DataType]map[otelcomponent.ID]otelcomponent.Component {
return nil
}
// NextConsumers implements receiver.Arguments.
func (args Arguments) NextConsumers() *otelcol.ConsumerArguments {
return args.Output
}
// AuthenticationArguments configures how to authenticate to the Kafka broker.
type AuthenticationArguments struct {
Plaintext *PlaintextArguments `river:"plaintext,block,optional"`
SASL *SASLArguments `river:"sasl,block,optional"`
TLS *otelcol.TLSClientArguments `river:"tls,block,optional"`
Kerberos *KerberosArguments `river:"kerberos,block,optional"`
}
// Convert converts args into the upstream type.
func (args AuthenticationArguments) Convert() map[string]interface{} {
auth := make(map[string]interface{})
if args.Plaintext != nil {
conv := args.Plaintext.Convert()
auth["plain_text"] = &conv
}
if args.SASL != nil {
conv := args.SASL.Convert()
auth["sasl"] = &conv
}
if args.TLS != nil {
auth["tls"] = args.TLS.Convert()
}
if args.Kerberos != nil {
conv := args.Kerberos.Convert()
auth["kerberos"] = &conv
}
return auth
}
// PlaintextArguments configures plaintext authentication against the Kafka
// broker.
type PlaintextArguments struct {
Username string `river:"username,attr"`
Password rivertypes.Secret `river:"password,attr"`
}
// Convert converts args into the upstream type.
func (args PlaintextArguments) Convert() map[string]interface{} {
return map[string]interface{}{
"username": args.Username,
"password": string(args.Password),
}
}
// SASLArguments configures SASL authentication against the Kafka broker.
type SASLArguments struct {
Username string `river:"username,attr"`
Password rivertypes.Secret `river:"password,attr"`
Mechanism string `river:"mechanism,attr"`
Version int `river:"version,attr,optional"`
AWSMSK AWSMSKArguments `river:"aws_msk,block,optional"`
}
// Convert converts args into the upstream type.
func (args SASLArguments) Convert() map[string]interface{} {
return map[string]interface{}{
"username": args.Username,
"password": string(args.Password),
"mechanism": args.Mechanism,
"version": args.Version,
"aws_msk": args.AWSMSK.Convert(),
}
}
// AWSMSKArguments exposes additional SASL authentication measures required to
// use the AWS_MSK_IAM mechanism.
type AWSMSKArguments struct {
Region string `river:"region,attr"`
BrokerAddr string `river:"broker_addr,attr"`
}
// Convert converts args into the upstream type.
func (args AWSMSKArguments) Convert() map[string]interface{} {
return map[string]interface{}{
"region": args.Region,
"broker_addr": args.BrokerAddr,
}
}
// KerberosArguments configures Kerberos authentication against the Kafka
// broker.
type KerberosArguments struct {
ServiceName string `river:"service_name,attr,optional"`
Realm string `river:"realm,attr,optional"`
UseKeyTab bool `river:"use_keytab,attr,optional"`
Username string `river:"username,attr"`
Password rivertypes.Secret `river:"password,attr,optional"`
ConfigPath string `river:"config_file,attr,optional"`
KeyTabPath string `river:"keytab_file,attr,optional"`
}
// Convert converts args into the upstream type.
func (args KerberosArguments) Convert() map[string]interface{} {
return map[string]interface{}{
"service_name": args.ServiceName,
"realm": args.Realm,
"use_keytab": args.UseKeyTab,
"username": args.Username,
"password": string(args.Password),
"config_file": args.ConfigPath,
"keytab_file": args.KeyTabPath,
}
}
// MetadataArguments configures how the otelcol.receiver.kafka component will
// retrieve metadata from the Kafka broker.
type MetadataArguments struct {
IncludeAllTopics bool `river:"include_all_topics,attr,optional"`
Retry MetadataRetryArguments `river:"retry,block,optional"`
}
// Convert converts args into the upstream type.
func (args MetadataArguments) Convert() kafkaexporter.Metadata {
return kafkaexporter.Metadata{
Full: args.IncludeAllTopics,
Retry: args.Retry.Convert(),
}
}
// MetadataRetryArguments configures how to retry retrieving metadata from the
// Kafka broker. Retrying is useful to avoid race conditions when the Kafka
// broker is starting at the same time as the otelcol.receiver.kafka component.
type MetadataRetryArguments struct {
MaxRetries int `river:"max_retries,attr,optional"`
Backoff time.Duration `river:"backoff,attr,optional"`
}
// Convert converts args into the upstream type.
func (args MetadataRetryArguments) Convert() kafkaexporter.MetadataRetry {
return kafkaexporter.MetadataRetry{
Max: args.MaxRetries,
Backoff: args.Backoff,
}
}
// AutoCommitArguments configures how to automatically commit updated topic
// offsets back to the Kafka broker.
type AutoCommitArguments struct {
Enable bool `river:"enable,attr,optional"`
Interval time.Duration `river:"interval,attr,optional"`
}
// Convert converts args into the upstream type.
func (args AutoCommitArguments) Convert() kafkareceiver.AutoCommit {
return kafkareceiver.AutoCommit{
Enable: args.Enable,
Interval: args.Interval,
}
}
// MessageMarkingArguments configures when Kafka messages are marked as read.
type MessageMarkingArguments struct {
AfterExecution bool `river:"after_execution,attr,optional"`
IncludeUnsuccessful bool `river:"include_unsuccessful,attr,optional"`
}
// Convert converts args into the upstream type.
func (args MessageMarkingArguments) Convert() kafkareceiver.MessageMarking {
return kafkareceiver.MessageMarking{
After: args.AfterExecution,
OnError: args.IncludeUnsuccessful,
}
}
type HeaderExtraction struct {
ExtractHeaders bool `river:"extract_headers,attr,optional"`
Headers []string `river:"headers,attr,optional"`
}
// Convert converts HeaderExtraction into the upstream type.
func (h HeaderExtraction) Convert() kafkareceiver.HeaderExtraction {
return kafkareceiver.HeaderExtraction{
ExtractHeaders: h.ExtractHeaders,
Headers: h.Headers,
}
}
// DebugMetricsConfig implements receiver.Arguments.
func (args Arguments) DebugMetricsConfig() otelcol.DebugMetricsArguments {
return args.DebugMetrics
}