Skip to content

Commit 8beec5b

Browse files
committed
Adjusted kafka-c options.
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
1 parent d2d4435 commit 8beec5b

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

doc/_admin-guide/070_Destinations/100_Kafka-c/003_Kafka-c_options.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: "Options of the kafka() destination's C implementation"
2+
title: "Options of the kafka-c() destination"
33
id: adm-dest-kafkac-opt
44
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 }}.
66
---
77

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.
1010

1111
## Required options
1212

1313
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
1515
add the following lines to the beginning of your {{ site.product.short_name }}
1616
configuration:
1717

@@ -63,8 +63,6 @@ the address to specify the port number of the server. When specifying
6363
multiple addresses, use a comma to separate the addresses, for example,
6464
bootstrap-servers(\"127.0.0.1:2525,remote-server-hostname:6464\")
6565

66-
{% include doc/admin-guide/options/client-lib-dir.md %}
67-
6866
For the kafka destination, include the path to the directory where you
6967
copied the required libraries (see [[Prerequisites|adm-dest-hdfs-pre]]), for example,
7068
**client-lib-dir("/opt/syslog-ng/lib/syslog-ng/java-modules/KafkaDestination.jar:/usr/share/kafka/lib/*.jar")**.
@@ -99,6 +97,16 @@ config(
9997

10098
{% include doc/admin-guide/options/disk-buffer.md %}
10199

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+
102110
{% include doc/admin-guide/options/frac-digits.md %}
103111

104112
## flush-timeout-on-reload()
@@ -212,9 +220,9 @@ recommends that you set sync-send() to "yes", as this setting
212220
delivers messages to the Kafka client more reliably.
213221
{: .notice--danger}
214222

215-
## template()
223+
## message()
216224

217-
| Type:| template or template function|
225+
| Type:| message template|
218226
|Default:| ${ISODATE} ${HOST} ${MSGHDR}${MSG}\\n|
219227

220228
*Description:* The message as published to Apache Kafka. You can use
@@ -229,6 +237,13 @@ For details on formatting messages in JSON format, see
229237

230238
{% include doc/admin-guide/options/time-zone.md %}
231239

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.
246+
232247
## topic()
233248

234249
| Type:| string|

0 commit comments

Comments
 (0)