global() configuration object

The global configuration object permits to set global parameters. Note that each parameter can only be set once and cannot be re-set thereafter. If a parameter is set multiple times, the behaviour is unpredictable.

The following paramters can be set:

  • action.reportSuspension - binary, default “on”, v7.5.8+

    If enabled (“on”) action will log message under syslog.* when an action suspends or resume itself. This usually happens when there are problems connecting to backend systems. If disabled (“off”), these messages are not generated. These messages can be useful in detecting problems with backend systems. Most importantly, frequent suspension and resumption points to a problem area.

  • action.reportSuspensionContinuation - binary, default “off”, v7.6.1+, v8.2.0+

    If enabled (“on”) the action will not only report the first suspension but each time the suspension is prolonged. Otherwise, the follow-up messages are not logged. If this setting is set to “on”, action.reportSuspension is also automaticaly turned “on”.

  • workDirectory

  • dropMsgsWithMaliciousDNSPtrRecords

  • localHostname

  • preserveFQDN

  • defaultNetstreamDriverCAFile

    For TLS syslog, the CA certificate that can verify the machine keys and certs (see below)

  • defaultNetstreamDriverKeyFile

    Machine private key

  • defaultNetstreamDriver

    Set it to “gtls” to enable TLS for TLS syslog

  • maxMessageSize

    The maximum message size rsyslog can process. Default is 4K. Anything above the maximum size will be truncated.

  • debug.onShutdown available in 7.5.8+

    If enabled (“on”), rsyslog will log debug messages when a system shutdown is requested. This can be used to track issues that happen only during shutdown. During normal operations, system performance is NOT affected. Note that for this option to be useful, the debug.logFile parameter must also be set (or the respective environment variable).

  • debug.logFile available in 7.5.8+

    This is used to specify the debug log file name. It is used for all debug output. Please note that the RSYSLOG_DEBUGLOG environment variable always overrides the value of debug.logFile.

[rsyslog.conf overview] [RainerScript reference] [rsyslog site]

This documentation is part of the rsyslog project. Copyright © 2013-2014 by Rainer Gerhards and Adiscon. Released under ASL 2.0 or higher.

Previous topic

The rsyslog “call” statement

Next topic

Actions

This Page