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.
RSyslog - Features¶
This page lists both current features as well as those being considered for future versions of rsyslog. If you think a feature is missing, drop Rainer a note. Rsyslog is a vital project. Features are added each few days. If you would like to keep up of what is going on, you can also subscribe to the rsyslog mailing list.
A better structured feature list is now contained in our rsyslog vs. syslog-ng comparison. Probably that page will replace this one in the future.
- native support for writing to MySQL databases
- native support for writing to Postgres databases
- direct support for Firebird/Interbase, OpenTDS (MS SQL, Sybase), SQLLite, Ingres, Oracle, and mSQL via libdbi, a database abstraction layer (almost as good as native)
- native support for sending mail messages (first seen in 3.17.0)
- support for (plain) tcp based syslog - much better reliability
- support for sending and receiving compressed syslog messages
- support for on-demand on-disk spooling of messages that can not be processed fast enough (a great feature for writing massive amounts of syslog messages to a database)
- support for selectively processing messages only during specific timeframes and spooling them to disk otherwise
- ability to monitor text files and convert their contents into syslog messages (one per line)
- ability to configure backup syslog/database servers - if the primary fails, control is switched to a prioritized list of backups
- support for receiving messages via reliable RFC 3195 delivery (a bit clumpsy to build right now…)
- ability to generate file names and directories (log targets) dynamically, based on many different properties
- control of log output format, including ability to present channel and priority as visible log data
- good timestamp format control; at a minimum, ISO 8601/RFC 3339 second-resolution UTC zone
- ability to reformat message contents and work with substrings
- support for log files larger than 2gb
- support for file size limitation and automatic rollover command execution
- support for running multiple rsyslogd instances on a single machine
- support for TLS-protected syslog (both natively and via stunnel)
- ability to filter on any part of the message, not just facility and severity
- ability to use regular expressions in filters
- support for discarding messages based on filters
- ability to execute shell scripts on received messages
- control of whether the local hostname or the hostname of the origin of the data is shown as the hostname in the output
- ability to preserve the original hostname in NAT environments and relay chains
- ability to limit the allowed network senders
- powerful BSD-style hostname and program name blocks for easy multi-host support
- massively multi-threaded with dynamic work thread pools that start up and shut themselves down on an as-needed basis (great for high log volume on multicore machines)
- very experimental and volatile support for syslog-protocol compliant messages (it is volatile because standardization is currently underway and this is a proof-of-concept implementation to aid this effort)
- world’s first implementation of syslog-transport-tls
- the sysklogd’s klogd functionality is implemented as the imklog input plug-in. So rsyslog is a full replacement for the sysklogd package
- support for IPv6
- ability to control repeated line reduction (“last message repeated n times”) on a per selector-line basis
- supports sub-configuration files, which can be automatically read from directories. Includes are specified in the main configuration file
- supports multiple actions per selector/filter condition
- MySQL and Postgres SQL functionality as a dynamically loadable plug-in
- modular design for inputs and outputs - easily extensible via custom plugins
- an easy-to-write to plugin interface
- ability to send SNMP trap messages
- ability to filter out messages based on sequence of arrival
- support for comma-seperated-values (CSV) output generation (via the “csv” property replace option). The CSV format supported is that from RFC 4180.
- support for arbitrary complex boolean, string and arithmetic expressions in message filters
Rsyslog has an interesting number of “world’s firsts” - things that were implemented for the first time ever in rsyslog. Some of them are still features not available elsewhere.
- world’s first implementation of IETF I-D syslog-protocol (February 2006, version 1.12.2 and above), now RFC5424
- world’s first implementation of dynamic syslog on-the-wire compression (December 2006, version 1.13.0 and above)
- world’s first open-source implementation of a disk-queueing syslogd (January 2008, version 3.11.0 and above)
- world’s first implementation of IETF I-D syslog-transport-tls (May 2008, version 3.19.0 and above)
The list below is something like a repository of ideas we’d like to implement. Features on this list are typically NOT scheduled for immediate inclusion. We maintain a feature request tracker at our bugzilla. This tracker has things typically within reach of implementation. Users are encouraged to submit feature requests there (or via our forums). If we like them but they look quite long-lived (aka “not soon to be implemented”), they will possibly be migrated to this list here and at some time moved back to the bugzilla tracker.
Note that we also maintain a `list of features that are looking for sponsors <http://www.rsyslog.com/sponsor_feature>`_. If you are interested in any of these features, or any other feature, you may consider sponsoring the implementation. This is also a great way to show your commitment to the open source community. Plus, it can be financially attractive: just think about how much less it may be to sponsor a feature instead of purchasing a commercial implementation. Also, the benefit of being recognised as a sponsor may even drive new customers to your business!
- port it to more *nix variants (eg AIX and HP UX) - this needs volunteers with access to those machines and knowledge
- pcre filtering - maybe (depending on feedback) - simple regex already partly added. So far, this seems sufficient so that there is no urgent need to do pcre. If done, it will be a loadable RainerScript function.
- support for RFC 3195 as a sender - this is currently unlikely to happen, because there is no real demand for it. Any work on RFC 3195 has been suspend until we see some real interest in it. It is probably much better to use TCP-based syslog, which is interoperable with a large number of applications. You may also read my blog post on the future of liblogging, which contains interesting information about the future of RFC 3195 in rsyslog.
To see when each feature was added, see the rsyslog change log (online only).