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
+24-9Lines changed: 24 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
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
13
The following options are required: bootstrap-servers(), topic(). Note
14
-
that to use the C implementation of the kafka() destination, you must
14
+
that to use the kafka-c() destination, you must
15
15
add the following lines to the beginning of your {{ site.product.short_name }}
16
16
configuration:
17
17
@@ -63,8 +63,6 @@ the address to specify the port number of the server. When specifying
63
63
multiple addresses, use a comma to separate the addresses, for example,
{% include doc/admin-guide/options/disk-buffer.md %}
101
99
100
+
## fallback-topic()
101
+
102
+
| Type:| string|
103
+
|Default:| N/A|
104
+
105
+
*Description:* If the resolved `topic()` template is not a valid Kafka topic , {{ site.product.short_name }} will use `fallback-topic()` to send messages.
106
+
107
+
**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.
108
+
{: .notice--info}
109
+
102
110
{% include doc/admin-guide/options/frac-digits.md %}
103
111
104
112
## flush-timeout-on-reload()
@@ -212,9 +220,9 @@ recommends that you set sync-send() to "yes", as this setting
212
220
delivers messages to the Kafka client more reliably.
213
221
{: .notice--danger}
214
222
215
-
## template()
223
+
## message()
216
224
217
-
| Type:|template or template function|
225
+
| Type:|message template|
218
226
|Default:| ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
219
227
220
228
*Description:* The message as published to Apache Kafka. You can use
@@ -229,6 +237,13 @@ For details on formatting messages in JSON format, see
229
237
230
238
{% include doc/admin-guide/options/time-zone.md %}
231
239
240
+
## time-reopen()
241
+
242
+
| Type:| number (seconds)|
243
+
|Default:| 60|
244
+
245
+
*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