rsyslog-doc icon indicating copy to clipboard operation
rsyslog-doc copied to clipboard

Update coverage of parser.escapeControlCharactersOnReceive parameter

Open deoren opened this issue 6 years ago • 2 comments

Looking at some options I had disabled in my configuration, I saw a doc comment of mine that referenced these older pages:

  • http://www.rsyslog.com/doc/rsconf1_controlcharacterescapeprefix.html
  • rsconf1_escapecontrolcharactersonreceive.html
    • http://www.rsyslog.com/doc/v8-stable/configuration/input_directives/rsconf1_escapecontrolcharactersonreceive.html
    • http://www.rsyslog.com/doc/rsconf1_escapecontrolcharactersonreceive.html

Some observations:

  • These are old doc pages (already have a separate issue for reviewing and retiring them)
  • The http://www.rsyslog.com/doc/v8-stable/rainerscript/global.html page does not list this parameter, but probably should
  • It would probably be useful to update the parser object page (http://www.rsyslog.com/doc/v8-stable/configuration/parser.html) with a reference to this parameter (loosely related?)

I'll try to take a stab at some of these items in the next day or so.

deoren avatar Mar 27 '18 18:03 deoren

On a related note, I assume that pulling in content via imfile constitutes "receiving" a message in re to the parser.escapeControlCharactersOnReceive name?

deoren avatar Mar 27 '18 18:03 deoren

Some pages to update to replace the obsolete legacy configuration format names with advanced configuration format names:

  • http://www.rsyslog.com/doc/v8-stable/configuration/properties.html
  • http://www.rsyslog.com/doc/v8-stable/configuration/templates.html
  • http://www.rsyslog.com/doc/v8-stable/configuration/property_replacer.html

deoren avatar Mar 27 '18 18:03 deoren