forked from vectordotdev/vector
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathkafka.toml
More file actions
90 lines (77 loc) · 2.5 KB
/
Copy pathkafka.toml
File metadata and controls
90 lines (77 loc) · 2.5 KB
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
[sinks.kafka]
title = "Kafka"
beta = false
common = true
delivery_guarantee = "at_least_once"
egress_method = "streaming"
function_category = "transmit"
healthcheck = true
input_types = ["log"]
min_version = "0.8"
requirements = {}
service_providers = ["AWS", "Confluent"]
write_to_description = "[Apache Kafka][urls.kafka] via the [Kafka protocol][urls.kafka_protocol]"
<%= render("_partials/_component_options.toml", type: "sink", name: "kafka") %>
<%= render("_partials/_buffer_options.toml", namespace: "sinks.kafka.options") %>
[sinks.kafka.options.bootstrap_servers]
type = "string"
common = true
examples = ["10.14.22.123:9092,10.14.23.332:9092"]
required = true
description = """\
A comma delimited list of host and port pairs that the Kafka client should contact to bootstrap \
its cluster metadata.\
"""
[sinks.kafka.options.encoding]
type = "string"
category = "requests"
common = true
required = true
description = """\
The encoding format used to serialize the events before outputting.\
"""
[sinks.kafka.options.encoding.enum]
json = "Each event is encoded into JSON and the payload is represented as a JSON array."
text = "Each event is encoded into text via the `message` key and the payload is new line delimited."
[sinks.kafka.options.key_field]
type = "string"
common = true
examples = ["user_id"]
required = true
description = """\
The log field name to use for the topic key. If unspecified, the key will be \
randomly generated. If the field does not exist on the log, a blank value \
will be used.\
"""
<%= render("_partials/_tls_connector_options.toml", namespace: "sinks.kafka.options", can_enable: true, can_verify: false) %>
[sinks.kafka.options.topic]
type = "string"
common = true
examples = ["topic-1234"]
required = true
description = "The Kafka topic name to write events to."
[sinks.kafka.options.socket_timeout_ms]
type = "int"
examples = [30000, 90000]
default = 60000
description = "Default timeout for network requests."
[sinks.kafka.options.message_timeout_ms]
type = "int"
examples = [150000, 450000]
default = 300000
description = "Local message timeout."
[sinks.kafka.options.librdkafka_options]
type = "table"
category = "Advanced"
description = """\
Advanced producer options. See [`librdkafka` documentation][urls.lib_rdkafka_config] for details.
"""
[sinks.kafka.options.librdkafka_options.children."`[field-name]`"]
type = "string"
examples = [
{"client.id" = "${ENV_VAR}"},
{"socket.send.buffer.bytes" = "100"},
]
description = """\
The options and their values. Accepts `string` values.
"""