RSyslog - Documentation

Rsyslog is an enhanced syslogd supporting, among others, MySQL, PostgreSQL, failover log destinations, syslog/tcp, fine grain output format control, and the ability to filter on any message part. It is quite compatible to stock sysklogd and can be used as a drop-in replacement. Its advanced features make it suitable for enterprise-class, encryption protected syslog relay chains while at the same time being very easy to setup for the novice user.

Visit the rsyslog status page to obtain current version information and ports. If you like rsyslog, you might want to lend us a helping hand. It doesn't require a lot of time - even a single mouse click helps. Learn how to help the rsyslog project. Due to popular demand, there is now a side-by-side comparison between rsyslog and syslog-ng.

Warning: rsyslog v3 is under active development and as of this writing has a number of backwards compatibility issues. If you have never run it, be sure to read the rsyslog v3 compatibility document! This also applies if you upgrade from stock sysklogd - you need to make some configuration file changes.
Documentation for 3.x is currently sparse. If you need assistance, please post in the rsyslog forums!
If you do not like this, use a stable branch release!

Follow the links below for the

• rsyslogd man page (somewhat outdated)
• configuration file syntax (rsyslog.conf)
• property replacer, an important core component
• a commented sample rsyslog.conf
• rsyslog bug list
• rsyslog packages
• backgrounder on generic syslog application design
• contributor "Hall of Fame"
• description of rsyslog modules

We have some in-depth papers on

• installing rsyslog
• rsyslog and IPv6 (which is fully supported)
• ssl-encrypting syslog with stunnel
• writing syslog messages to MySQL
• writing massive amounts of syslog messages to a database
• using php-syslog-ng with rsyslog
• recording the syslog priority (severity and facility) to the log file
• preserving syslog sender over NAT (online only)
• the rsyslog message queue object

Also, there is an article from Dennis Olvany on Syslog-to-SQL with rsyslog-0.8.4 on FreeBSD 5.4 (which unfortunately is a bit outdated now).

Our rsyslog history page is for you if you would like to learn a little more on why there is an rsyslog at all. If you are interested why you should care about rsyslog at all, you may want to read Rainer's essay on "why the world needs another syslogd".

Documentation is added continuously. Please note that the documentation here matches only the current version of rsyslog. If you use an older version, be sure to use the doc that came with it.

You can also browse the following online resources:

• the rsyslog wiki, a community resource
• rsyslog online documentation
• rsyslog FAQ
• rsyslog discussion forum
• rsyslog change log
• syslog device configuration guide (off-site)

And don't forget about the rsyslog mailing list. If you are interested in the "backstage", you may find Rainer's blog an interesting read (filter on syslog and rsyslog tags).