Skip to main content

Configuration helper for syslog-ng.

Project description

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.6.0.

Quickstart

Install with pipx

pipx install syslog-ng-cfg-helper

List the contexts

syslog-ng-cfg-helper

List the drivers in a context

syslog-ng-cfg-helper --context parser

List the options of a driver

syslog-ng-cfg-helper --context parser --driver csv-parser

Example

Example

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 downloads the syslog-ng release tarball and generates the option database.
  • make db SYSLOG_NG_SOURCE_DIR=/path/to/syslog-ng creates a tarball from the state of the syslog-ng source dir and generates the option database.
  • make package creates the pip package.

Community

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

Axoflow Discord Server

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syslog_ng_cfg_helper-1.8.1.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

syslog_ng_cfg_helper-1.8.1-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

Details for the file syslog_ng_cfg_helper-1.8.1.tar.gz.

File metadata

  • Download URL: syslog_ng_cfg_helper-1.8.1.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1019-azure

File hashes

Hashes for syslog_ng_cfg_helper-1.8.1.tar.gz
Algorithm Hash digest
SHA256 1ac93314feea65cd63b2536ac2e6e2eb0ec4f5ebe18fd67ebf73a044dccb7f57
MD5 7b1f306d769bbf42f9b568c00cfdf6cf
BLAKE2b-256 01716a5e952793091c52a3d285b474b9ecb86ebe25f35d8a1229bb030ccfaf86

See more details on using hashes here.

File details

Details for the file syslog_ng_cfg_helper-1.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for syslog_ng_cfg_helper-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1f1a580a4cc8d0a2b4acfe927cbb0b7be52cecd70dfae6644d9b76c08ca27cf8
MD5 b562336981275ec8109934bc9d9325d3
BLAKE2b-256 0f6676dcd558c6bc38904b4d16a571b0131eb4672a6fc1a30af9e71d0d79b8d6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page