Skip to content

Commit 4873c83

Browse files
committed
Updated payloadKey parameter description
1 parent 7ec49dd commit 4873c83

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

modules/cluster-logging-collector-log-forward-syslog.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,13 @@ You can configure the following for the `syslog` outputs. For more information,
123123
** `14` or `console` for the syslog alert log
124124
** `15` or `solaris-cron` for the scheduling daemon
125125
** `16`–`23` or `local0` – `local7` for locally used facilities
126-
* payloadKey: The record field to use as payload for the syslog message.
126+
* Optional. `payloadKey`: The record field to use as payload for the syslog message.
127+
+
128+
[NOTE]
129+
====
130+
Configuring the `payloadKey` parameter prevents other parameters from being forwarded to the syslog.
131+
====
132+
+
127133
* rfc: The RFC to be used for sending log using syslog. The default is RFC5424.
128134
* severity: The link:https://tools.ietf.org/html/rfc5424#section-6.2.1[syslog severity] to set on outgoing syslog records. The value can be a decimal integer or a case-insensitive keyword:
129135
** `0` or `Emergency` for messages indicating the system is unusable

0 commit comments

Comments
 (0)