rsyslog.conf file

From 85045270f69e4dcb25c409c9661e96e3172d7f30 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 27 Jan 2010 15:13:54 +0100 Subject: added $Escape8BitCharactersOnReceive directive Thanks to David Lang for suggesting this functionality. --- doc/Makefile.am | 1 + doc/rsconf1_escape8bitcharsonreceive.html | 44 +++++++++++++++++++++++++++++++ doc/rsyslog_conf_global.html | 1 + 3 files changed, 46 insertions(+) create mode 100644 doc/rsconf1_escape8bitcharsonreceive.html (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 2d451102..30f5771a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -74,6 +74,7 @@ html_files = \ rsconf1_dropmsgswithmaliciousdnsptrrecords.html \ rsconf1_droptrailinglfonreception.html \ rsconf1_dynafilecachesize.html \ + rsconf1_escape8bitcharactersonreceive.html \ rsconf1_escapecontrolcharactersonreceive.html \ rsconf1_failonchownfailure.html \ rsconf1_filecreatemode.html \ diff --git a/doc/rsconf1_escape8bitcharsonreceive.html b/doc/rsconf1_escape8bitcharsonreceive.html new file mode 100644 index 00000000..408851c1 --- /dev/null +++ b/doc/rsconf1_escape8bitcharsonreceive.html @@ -0,0 +1,44 @@ + + +rsyslog.conf file + + +back + +

$Escape8BitCharactersOnReceive

Type: global configuration directive

Default: off

Available Since: 5.5.2

Description:

This directive instructs rsyslogd to replace non US-ASCII characters (those that +have the 8th bit set) during reception of the message. +This may be useful for some systems. +Please note that this escaping breaks Unicode and many other encodings. Most importantly, +it can be assumed that Asian and European characters will be rendered hardly readable by +this settings. However, it may still be useful when the logs themself are primarily +in English and only occasionally contain local script. +If this option is turned on, all control-characters are converted to a 3-digit octal number and be prefixed with the $ControlCharacterEscapePrefix character (being '#' by default). +

Warning:

turning on this option most probably destroys non-western character sets + (like Japanese, Chinese and Korean) as well as European character sets.
turning on this option destroys digital signatures if such exists inside + the message
if turned on, the drop-cc, space-cc and escape-cc + property replacer options do not work + as expected because control characters are already removed upon message + reception. If you intend to use these property replacer options, you must + turn off $Escape8BitCharactersOnReceive.

Sample:

$Escape8BitCharactersOnReceive on

+ +

[rsyslog.conf overview] [manual +index] [rsyslog site]

This documentation is part of the +rsyslog project.
+Copyright © 2010 by Rainer Gerhards and +Adiscon. Released under the GNU GPL +version 3 or higher.

+ + diff --git a/doc/rsyslog_conf_global.html b/doc/rsyslog_conf_global.html index 8796de65..3e926db1 100644 --- a/doc/rsyslog_conf_global.html +++ b/doc/rsyslog_conf_global.html @@ -140,6 +140,7 @@ our paper on using multiple rule sets in rsyslog $DropMsgsWithMaliciousDnsPTRRecords

$DropTrailingLFOnReception

$DynaFileCacheSize

$Escape8BitCharactersOnReceive

$EscapeControlCharactersOnReceive

$EscapeControlCharactersOnReceive [on|off] - escape USASCII HT character

$ErrorMessagesToStderr [on|off] - direct rsyslogd error message to stderr (in addition to other targets)

-- cgit