syslog-ng-cfg-helper 1.0.2

Configuration helper for syslog-ng.

syslog-ng CFG Helper

This tool makes configuring syslog-ng a bit easier by listing the options of each available driver.

The options are generated from syslog-ng v4.2.0.

Quickstart

Install with pipx

pipx install syslog-ng-cfg-helper

List the contexts

syslog-ng-cfg-helper

Valid contexts:
  destination
  filter
  options
  parser
  rewrite
  source
Print the drivers of CONTEXT with `--context CONTEXT`.

List the drivers in a context

syslog-ng-cfg-helper -c destination

Drivers of context 'destination':
  amqp
  example-destination
  fifo
  file
  http
  java
...
Print the options of DRIVER with `--context destination --driver DRIVER`.

List the options of a driver

syslog-ng-cfg-helper -c destination -d http

http(
    accept-redirects(<yesno>)
    azure-auth-header(
        <path>(<string>)
        content-type(<string>)
        method(<string>)
        secret(<string>)
        workspace-id(<string>)
    )
    batch-bytes(<nonnegative-integer>)
    batch-lines(<nonnegative-integer>)
    batch-timeout(<positive-integer>)
    body(<template-content>)
    body-prefix(<string>)
    body-suffix(<string>)
    ca-dir(<string>)
    ca-file(<path>)
    cert-file(<path>)
...

Development

The tool is still in development, but most of the drivers are supported.

Missing features are:

• Proper rewrite support.
• Proper filter support.
• Drivers defined in SCLs.
• Drivers defined with confgen.

Any contribution is welcome :)

Local setup

The project uses poetry as a dependency management system.

Building of the option database needs the neologism pip package, which gets installed by poetry, however it has another dependency, which is bison. Make sure to install bison (at least 3.7.6) on you system if you wan't to develop locally. make bison can help with that.

The Makefile consists of some useful commands:

• make venv prepares the venv.
• make bison downloads bison 3.7.6, builds it and installs it under /usr/local.
  • You can change the install path with make bison BISON_INSTALL_PATH=...
• make check runs the unit tests, style-checkers and linters.
• make format formats the code.
• make db download the syslog-ng release tarball and generates the option database.
• make package creates the pip package.

Community

You can reach out to the syslog-ng community on Discord: