You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md
+30-9Lines changed: 30 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,22 @@
1
1
---
2
-
title: "Options of the kafka() destination's C implementation"
2
+
title: "Options of the kafka-c() destination"
3
3
id: adm-dest-kafkac-opt
4
4
description: >-
5
-
This section describes the options of the kafka() destination in {{ site.product.short_name }}.
5
+
This section describes the options of the kafka-c() destination in {{ site.product.short_name }}.
6
6
---
7
7
8
-
The C implementation of the kafka() destination of {{ site.product.short_name }} can
9
-
directly publish log messages to the Apache Kafka message bus, where subscribers can access them. The C implementation of the kafka() destination has the following options.
8
+
The kafka-c() destination of {{ site.product.short_name }} can
9
+
directly publish log messages to the Apache Kafka message bus, where subscribers can access them. The destination has the following options.
10
10
11
11
## Required options
12
12
13
-
The following options are required: bootstrap-servers(), topic().
13
+
To use the kafka-c() destination, the following two options are required: `bootstrap-servers()` and `topic()`. Both must appear at the beginning of your {{ site.product.short_name }} configuration.
14
+
15
+
You can specify multiple, comma-separated addresses, demonstrated in the following example:
{% include doc/admin-guide/options/disk-buffer.md %}
93
97
98
+
## fallback-topic()
99
+
100
+
| Type:| string|
101
+
|Default:| N/A|
102
+
103
+
*Description:* If the resolved `topic()` template is not a valid Kafka topic , {{ site.product.short_name }} will use `fallback-topic()` to send messages.
104
+
105
+
**NOTE:** If instead of strings, you use actual templates (that is, a macro like `${MESSAGE}`, or a template function like `$(format-json)`) in the `topic()` option, configuring the `fallback-topic()` option is required.
106
+
{: .notice--info}
107
+
94
108
{% include doc/admin-guide/options/frac-digits.md %}
95
109
96
110
## flush-timeout-on-reload()
@@ -179,9 +193,9 @@ recommends that you set sync-send() to "yes", as this setting
179
193
delivers messages to the Kafka client more reliably.
180
194
{: .notice--danger}
181
195
182
-
## template()
196
+
## message()
183
197
184
-
| Type:|template or template function|
198
+
| Type:|message template|
185
199
|Default:| ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
186
200
187
201
*Description:* The message as published to Apache Kafka. You can use
@@ -196,6 +210,13 @@ For details on formatting messages in JSON format, see
196
210
197
211
{% include doc/admin-guide/options/time-zone.md %}
198
212
213
+
## time-reopen()
214
+
215
+
| Type:| number (seconds)|
216
+
|Default:| 60|
217
+
218
+
*Description:* This is an optional parameter. If message delivery fails, {{ site.product.short_name }} retries sending the messages for `retries()` time (3 times by default) before waiting for `time-reopen()` time to try sending it again.
0 commit comments