Welcome to the syslog-ng Open Source Edition 3.20 Administrator Guide!
This document describes how to configure and manage syslog-ng. Background information for the technology and concepts used by the product is also discussed.
Introduction to syslog-ng describes the main functionality and purpose of syslog-ng OSE.
The concepts of syslog-ng discusses the technical concepts and philosophies behind syslog-ng OSE.
Installing syslog-ng describes how to install syslog-ng OSE on various UNIX-based platforms using the precompiled binaries.
The syslog-ng OSE quick-start guide provides a briefly explains how to perform the most common log collecting tasks with syslog-ng OSE.
The syslog-ng OSE configuration file discusses the configuration file format and syntax in detail, and explains how to manage large-scale configurations using included files and reusable configuration snippets.
source: Read, receive, and collect log messages explains how to collect and receive log messages from various sources.
destination: Forward, send, and store log messages describes the different methods to store and forward log messages.
log: Filter and route log messages using log paths, flags, and filters explains how to route and sort log messages, and how to use filters to select specific messages.
Global options of syslog-ng OSE lists the global options of syslog-ng OSE and explains how to use them.
TLS-encrypted message transfer shows how to secure and authenticate log transport using TLS encryption.
template and rewrite: Format, modify, and manipulate log messages describes how to customize message format using templates and macros, how to rewrite and modify messages, and how to use regular expressions.
parser: Parse and segment structured messages describes how to segment and process structured messages like comma-separated values.
db-parser: Process message content with a pattern database (patterndb) explains how to identify and process log messages using a pattern database.
Correlating log messages explains how to correlate log messages that match a set of filters or that are identified using a pattern database.
Enriching log messages with external data explains how to import data from external sources to include in the log messages, thus extending, enriching, and complementing the data found in the log message.
Statistics of syslog-ng details the available statistics that syslog-ng OSE collects about the processed log messages.
Multithreading and scaling in syslog-ng OSE describes how to configure syslog-ng OSE to use multiple processors, and how to optimize its performance.
Troubleshooting syslog-ng offers tips to solving problems.
Best practices and examples gives recommendations to configure special features of syslog-ng OSE.
The syslog-ng manual pages contains the manual pages of the syslog-ng OSE application.
Third-party contributions includes the text of the licenses applicable to syslog-ng Open Source Edition.
Creative Commons Attribution Non-commercial No Derivatives (by-nc-nd) License includes the text of the Creative Commons Attribution Non-commercial No Derivatives (by-nc-nd) License applicable to The syslog-ng Open Source Edition 3.20 Administrator Guide.
This guide is intended for system administrators and consultants responsible for designing and maintaining logging solutions and log centers. It is also useful for IT decision makers looking for a tool to implement centralized logging in heterogeneous environments.
The following skills and knowledge are necessary for a successful syslog-ng administrator:
At least basic system administration knowledge.
An understanding of networks, TCP/IP protocols, and general network terminology.
Working knowledge of the UNIX or Linux operating system.
In-depth knowledge of the logging process of various platforms and applications.
An understanding of the legacy syslog (BSD-syslog) protocol and the new syslog (IETF-syslog) protocol standard.
This guide describes the use of the following products:
syslog-ng Open Source Edition (syslog-ng OSE) 3.20.1 and later