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 Premium Edition


5.8. Modules in syslog-ng PE

The syslog-ng PE application is modular, to increase its flexibility and also to simplify the development of additional modules. Most of the functionality of syslog-ng PE is in separate modules. That way it becomes also possible to finetune the resource requirements of syslog-ng PE, for example, by loading only the modules that are actually used in the configuration, or simply omitting modules that are not used but require large amount of memory.

Each module contains one or more plugins, which add some functionality to syslog-ng PE, for example, a destination or a source driver.

  • To display the list of available modules, execute the syslog-ng --version command.

  • To the description of the available modules, execute the syslog-ng --module-registry command.

  • To customize which modules are loaded automatically when syslog-ng PE is started, use the --default-modules command-line option of syslog-ng PE.

  • To request loading a module from the syslog-ng PE configuration file, see Section 5.8.1, Loading modules.

For details on the command-line parameters of syslog-ng PE mentioned in the previous list, see the syslog-ng PE man page at syslog-ng(8).