Skip to content

Commit

Permalink
fix some comments in PR
Browse files Browse the repository at this point in the history
Signed-off-by: Vitalii Parfonov <[email protected]>
  • Loading branch information
vparfonov committed Dec 12, 2024
1 parent 3df4e9a commit 138ebc9
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/features/logforwarding/outputs/syslog-forwarding.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,12 @@ Where `url` and `rfc` parameters are mandatory other are optional
{.foo.bar."baz/with/slashes"}

. `appName`: is APP-NAME part of the syslog-msg header.
`appName` needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 48
This supports template syntax to allow dynamic per-event values.
`appName` needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 48. This supports template syntax* to allow dynamic per-event values.

. `procId`: is `PROCID` part of the syslog-msg header.
`procId` needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 128
This supports template syntax to allow dynamic per-event values.
`procId` needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 128. This supports template syntax* to allow dynamic per-event values.

. `msgId`: is `MSGID` part of the syslog-msg header. This supports template syntax to allow dynamic per-event values.
MsgId needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 32
. `msgId`: is `MSGID` part of the syslog-msg header. This supports template syntax to allow dynamic per-event values. MsgId needs to be specified if using `rfc5424`. The maximum length of the final values is truncated to 32. This supports template syntax* to allow dynamic per-event values.

. `enrichment`: `None` or `KubernetesMinimal`.
`None` add no additional enrichment to the record.
Expand All @@ -91,7 +88,8 @@ This may result in the message body being an invalid JSON structure.

[NOTE]
====
Template syntax
*Template syntax
The `appName`, `msgId` and `procId` can be a combination of static and dynamic values consisting of field paths followed by `||` followed by another field path or a static value.
A dynamic value is encased in single curly brackets `{}` and MUST end with a static fallback value separated with `||`.
Static values can only contain alphanumeric characters along with dashes, underscores, dots and forward slashes.
Expand Down

0 comments on commit 138ebc9

Please sign in to comment.