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.

back

$IncludeConfig

Type: global configuration directive

Default:

Description:

This directive allows to include other files into the main configuration file. As soon as an IncludeConfig directive is found, the contents of the new file is processed. IncludeConfigs can be nested. Please note that from a logical point of view the files are merged. Thus, if the include modifies some parameters (e.g. $DynaFileChacheSize), these new parameters are in place for the “calling” configuration file when the include is completed. To avoid any side effects, do a $ResetConfigVariables after the $IncludeConfig. It may also be a good idea to do a $ResetConfigVariables right at the start of the include, so that the module knows exactly what it does. Of course, one might specifically NOT do this to inherit parameters from the main file. As always, use it as it best fits…

If all regular files in the /etc/rsyslog.d directory are included, then files starting with “.” are ignored - so you can use them to place comments into the dir (e.g. “/etc/rsyslog.d/.mycomment” will be ignored). Michael Biebl had the idea to this functionality. Let me quote him:

Say you can add an option
$IncludeConfig /etc/rsyslog.d/ (which probably would make a good default) to /etc/rsyslog.conf, which would then merge and include all
*.conf files
in /etc/rsyslog.d/. This way, a distribution can modify its packages easily to drop a
simple
config file into this directory upon installation. As an example, the network-manager package could install a simple
config
file /etc/rsyslog.d/network-manager.conf which would contain. :programname, contains, “NetworkManager”
-/var/log/NetworkManager.log
Upon uninstallation, the file could be easily removed again. This
approach
would be much cleaner and less error prone, than having to munge
around
with the /etc/rsyslog.conf file directly.

Sample:

$IncludeConfig /etc/some-included-file.conf

Directories can also be included. To do so, the name must end on a slash:

$IncludeConfig /etc/rsyslog.d/

And finally, only specific files matching a wildcard my be included from a directory:

$IncludeConfig /etc/rsyslog.d/*.conf

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

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

Previous topic

$GenerateConfigGraph

Next topic

$MainMsgQueueSize

This Page