Skip to main content

Configuration helper for axosyslog.

Project description

AxoSyslog CFG Helper

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

The options are generated from AxoSyslog v4.9.0.

Quickstart

Install with pipx

pipx install axosyslog-cfg-helper

Or pull the container image

docker pull ghcr.io/alltilla/axosyslog-cfg-helper

List the contexts

axosyslog-cfg-helper

List the drivers in a context

axosyslog-cfg-helper --context parser

List the options of a driver

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

Community

You can reach out to the AxoSyslog 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

axosyslog_cfg_helper-1.11.2.tar.gz (41.2 kB view details)

Uploaded Source

Built Distribution

axosyslog_cfg_helper-1.11.2-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

Details for the file axosyslog_cfg_helper-1.11.2.tar.gz.

File metadata

  • Download URL: axosyslog_cfg_helper-1.11.2.tar.gz
  • Upload date:
  • Size: 41.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for axosyslog_cfg_helper-1.11.2.tar.gz
Algorithm Hash digest
SHA256 7247bd23a5be27abf1583782e4f546ef1023f8d4650c1960844339ecc2c6be6b
MD5 eb4000b83e5d39832eb6fd9a1c34b6e7
BLAKE2b-256 baf08ac687f12332acea2aec4629f7e1bf3e4eeb2165925a7e315d6ef222e8bf

See more details on using hashes here.

File details

Details for the file axosyslog_cfg_helper-1.11.2-py3-none-any.whl.

File metadata

File hashes

Hashes for axosyslog_cfg_helper-1.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8d5d81890239859ec7f839ac020816e3bab56de215662f12c93c9fd0a6469e95
MD5 74fc5e0204c9ff5ea45a74fe96ad9266
BLAKE2b-256 5532d74270b9b4192b546153055c80f05fadde86868eff726d92c015870d4ec6

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