Configuration
Rsyslog Configuration Reference Manual Introduction
This document serves as a detailed guide to rsyslog configuration, offering extensive information on the setup and management of system logging using rsyslog It covers various aspects of rsyslog configuration, including constructs, statements, and key concepts, designed to assist users in customizing their logging infrastructure according to specific needs.
The primary configuration file for rsyslog, located at /etc/rsyslog.conf, acts as the central point for establishing logging rules. This file is used to define input modules, filters, actions, and global directives, facilitating the processes of log collection, filtering, routing, and formatting.
Please note that this documentation is currently in the process of being refined to improve its clarity, structure, and accessibility. We value your patience and understanding during this phase and are committed to delivering a comprehensive and easy-to-navigate guide to rsyslog.
For further exploration of rsyslog’s configuration intricacies, please refer to the links provided below. This manual is designed to be a valuable resource for both experienced system administrators and those new to the field, aiming to fully leverage the capabilities of rsyslog.
Note that configurations can be built interactively via the online rsyslog configuration builder tool.
- Configuration Formats
- Converting older formats to
advanced
- sysklogd format
- Basic Structure
- Templates
- rsyslog Properties
- The Property Replacer
- Filter Conditions
- RainerScript
- Actions
- Input
- Parser
- timezone
- Examples
- Legacy Configuration Directives
- rsyslog statistic counter
- Modules
- Output Channels
- Dropping privileges in rsyslog
- Notes on IPv6 Handling in Rsyslog
- libgcrypt Log Crypto Provider (gcry)
- libossl Log Crypto Provider (ossl)
- Dynamic Stats
- Lookup Tables
- Percentile Stats
Configuration file examples can be found in the rsyslog wiki. Also keep the rsyslog config snippets on your mind. These are ready-to-use real building blocks for rsyslog configuration.
There is also one sample file provided together with the documentation
set. If you do not like to read, be sure to have at least a quick look
at rsyslog-example.conf
.
While rsyslogd contains enhancements over standard syslogd, efforts have been made to keep the configuration file as compatible as possible. While, for obvious reasons, enhanced features require a different config file syntax, rsyslogd should be able to work with a standard syslog.conf file. This is especially useful while you are migrating from syslogd to rsyslogd.
See also
Help with configuring/using Rsyslog
:
Mailing list - best route for general questions
GitHub: rsyslog source project - detailed questions, reporting issues that are believed to be bugs with
Rsyslog
See also
Contributing to Rsyslog
:
Source project: rsyslog project README.
Documentation: rsyslog-doc project README
Copyright 2008-2023 Rainer Gerhards (Großrinderfeld), and Others.