From 17cc1fbfa95fc1f0aec27a74c9de1c61e96aa1dc Mon Sep 17 00:00:00 2001 From: "Zsolt Gyulai (zgyulai)" Date: Wed, 2 Oct 2024 11:31:08 +0200 Subject: [PATCH 1/3] Added "no-piggyback-errors" to parser flags. Signed-off-by: Zsolt Gyulai (zgyulai) --- _includes/doc/admin-guide/options/source-flags.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_includes/doc/admin-guide/options/source-flags.md b/_includes/doc/admin-guide/options/source-flags.md index a5985dd8..854473c4 100644 --- a/_includes/doc/admin-guide/options/source-flags.md +++ b/_includes/doc/admin-guide/options/source-flags.md @@ -1,6 +1,6 @@ ## flags() -|Type:| assume-utf8, empty-lines, expect-hostname, kernel, no-hostname, no-multi-line, no-parse, sanitize-utf8, store-legacy-msghdr, store-raw-message, syslog-protocol, threaded, validate-utf8| +|Accepted values:| assume-utf8, empty-lines, expect-hostname, kernel, no-hostname, no-multi-line, no-parse, sanitize-utf8, store-legacy-msghdr, store-raw-message, syslog-protocol, threaded, validate-utf8, no-piggyback-errors| |Default: | empty set| *Description:* Specifies the log parsing options of the source. @@ -139,5 +139,6 @@ If the BOM[^1] character is missing, but the message is otherwise UTF-8 compliant, {{ site.product.short_name }} automatically adds the BOM character to the message. +- *no-piggyback-errors*: This option configures syslog-ng OSE to ignore parsing errors caused by piggybacked messages. If the parser encounters issues separating multiple messages sent together, it skips them without raising an error. [^1]: The byte order mark (BOM) is a Unicode character used to signal the byte-order of the message text. From cbe17fe436688bb17f50bafde9e4a75299ee3913 Mon Sep 17 00:00:00 2001 From: "Zsolt Gyulai (zgyulai)" Date: Thu, 3 Oct 2024 12:27:13 +0200 Subject: [PATCH 2/3] Fixed description of parser options. Signed-off-by: Zsolt Gyulai (zgyulai) --- _includes/doc/admin-guide/options/source-flags.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_includes/doc/admin-guide/options/source-flags.md b/_includes/doc/admin-guide/options/source-flags.md index 854473c4..ee18d3ec 100644 --- a/_includes/doc/admin-guide/options/source-flags.md +++ b/_includes/doc/admin-guide/options/source-flags.md @@ -139,6 +139,7 @@ If the BOM[^1] character is missing, but the message is otherwise UTF-8 compliant, {{ site.product.short_name }} automatically adds the BOM character to the message. -- *no-piggyback-errors*: This option configures syslog-ng OSE to ignore parsing errors caused by piggybacked messages. If the parser encounters issues separating multiple messages sent together, it skips them without raising an error. +- *no-piggyback-errors*: On failure, the original message will be left as it was before parsing, the value of `$MSGFORMAT` will be set to `syslog-error`, and a tag will be placed on the message corresponding to the parser's failure. +- *piggyback-errors*: On failure, the old behaviour is used (clearing the entire message then syslog-ng will generate a new message in place of the old one describing the parser's error). [^1]: The byte order mark (BOM) is a Unicode character used to signal the byte-order of the message text. From f2b57652886e0c80adeb7980ac3005241f860664 Mon Sep 17 00:00:00 2001 From: "Zsolt Gyulai (zgyulai)" Date: Thu, 17 Oct 2024 12:24:57 +0200 Subject: [PATCH 3/3] Fixed syslog-error, to syslog:error, and referenced a section detailing tags. Signed-off-by: Zsolt Gyulai (zgyulai) --- _includes/doc/admin-guide/options/source-flags.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/doc/admin-guide/options/source-flags.md b/_includes/doc/admin-guide/options/source-flags.md index ee18d3ec..9121a70d 100644 --- a/_includes/doc/admin-guide/options/source-flags.md +++ b/_includes/doc/admin-guide/options/source-flags.md @@ -139,7 +139,7 @@ If the BOM[^1] character is missing, but the message is otherwise UTF-8 compliant, {{ site.product.short_name }} automatically adds the BOM character to the message. -- *no-piggyback-errors*: On failure, the original message will be left as it was before parsing, the value of `$MSGFORMAT` will be set to `syslog-error`, and a tag will be placed on the message corresponding to the parser's failure. +- *no-piggyback-errors*: On failure, the original message will be left as it was before parsing, the value of `$MSGFORMAT` will be set to `syslog:error`, and a tag (see Tagging messages) will be placed on the message corresponding to the parser's failure. - *piggyback-errors*: On failure, the old behaviour is used (clearing the entire message then syslog-ng will generate a new message in place of the old one describing the parser's error). [^1]: The byte order mark (BOM) is a Unicode character used to signal the byte-order of the message text.