syslog-ng documentation

Your main source of knowledge

The syslog-ng product family has an extensive documentation, covering everything from how to install a product to the most complex configuration and settings descriptions. If you cannot find an answer to your question, try the mailing list - our community is always eager to help.

syslog-ng Open Source Edition


1. Summary of contents

Chapter 1, Introduction to syslog-ng describes the main functionality and purpose of syslog-ng OSE.

Chapter 2, The concepts of syslog-ng discusses the technical concepts and philosophies behind syslog-ng OSE.

Chapter 3, Installing syslog-ng describes how to install syslog-ng OSE on various UNIX-based platforms using the precompiled binaries.

Chapter 4, The syslog-ng OSE quick-start guide provides a briefly explains how to perform the most common log collecting tasks with syslog-ng OSE.

Chapter 5, 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.

Chapter 6, source: Read, receive, and collect log messages explains how to collect and receive log messages from various sources.

Chapter 7, destination: Forward, send, and store log messages describes the different methods to store and forward log messages.

Chapter 8, 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.

Chapter 9, Global options of syslog-ng OSE lists the global options of syslog-ng OSE and explains how to use them.

Chapter 10, TLS-encrypted message transfer shows how to secure and authenticate log transport using TLS encryption.

Chapter 11, 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.

Chapter 12, parser: Parse and segment structured messages describes how to segment and process structured messages like comma-separated values.

Chapter 13, db-parser: Process message content with a pattern database (patterndb) explains how to identify and process log messages using a pattern database.

Chapter 16, Statistics of syslog-ng details the available statistics that syslog-ng OSE collects about the processed log messages.

Chapter 17, Multithreading and scaling in syslog-ng OSE describes how to configure syslog-ng OSE to use multiple processors, and how to optimize its performance.

Chapter 18, Troubleshooting syslog-ng offers tips to solving problems.

Chapter 19, Best practices and examples gives recommendations to configure special features of syslog-ng OSE.

Appendix A, The syslog-ng manual pages contains the manual pages of the syslog-ng OSE application.

Appendix B, Open source licenses includes the text of the licenses applicable to syslog-ng Open Source Edition.

Section B.2, GNU Lesser General Public License includes the text of the LGPLv2.1 license applicable to the core of syslog-ng Open Source Edition.

Appendix C, 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.14 Administrator Guide.

Glossary defines the important terms used in this guide.

List of syslog-ng OSE parameters provides cross-references to the definitions of options, parameters, and macros available in syslog-ng OSE.

The Index provides cross-references to important terms used in this guide.