Use this documentation with care! It describes the heavily outdated version 5, which was actively developed around 2010 and is considered dead by the rsyslog team for many years now.

This documentation reflects the latest update of the previously existing (now removed) v5-stable branch. It describes the 5.10.2 version, which was never released. As such, it contains some content that does not apply to any released version.

To obtain the doc that properly matches your installed v5 version, obtain the doc set from your distro. Each version of rsyslog contained the version that exactly matches it.

As general advise, it is strongly suggested to upgrade to the current version supported by the rsyslog project. The current version can always be found on the right-hand side info box on the rsyslog web site.

Note that there is no rsyslog community support available for this heavily outdated version. If you need to stick with it, please ask your distribution for support.

Configuration Parameter Types

Configuration parameter values have different data types. Unfortunately, the type currently must be guessed from the description (consider contributing to the doc to help improve it). In general, the following types are used:

  • numbers

    The traditional integer format. Numbers may include ‘.’ and ‘,’ for readability. So you can for example specify either “1000” or “1,000” with the same result. Please note that rsyslogd simply ignores the punctuation. From it’s point of view, “1,,0.0.,.,0” also has the value 1000.

  • sizes

    Used for things like file size, main message queue sizes and the like. These are integers, but support modifier after the number part. For example, 1k means 1024. Supported are k(ilo), m(ega), g(iga), t(era), p(eta) and e(xa). Lower case letters refer to the traditional binary defintion (e.g. 1m equals 1,048,576) whereas upper case letters refer to their new 1000-based definition (e.g 1M equals 1,000,000).

  • complete line

    A string consisting of multiple characters. This is relatively seldom used and sometimes looks confusing (rsyslog v7+ has a much better approach at these types of values).

  • single word

    This is used when only a single word can be provided. A “single word” is a string without spaces in it. No quoting is necessary nor permitted (the quotes would become part of the word).

  • character

    A single (printable) character. Must not be quoted.

  • boolean

    The traditional boolean type, specified as “on” (1) or “off” (0).

Note that some other value types are occasionally used. However, the majority of types is one of those listed above. The list is updated as need arises and time permits.

Previous topic

Configuration Directives

Next topic

Global Configuration Statements

This Page