Skip to main content

Systemd journal reader and exporter

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Propagation Exporter

A small tool that watches systemd journal entries from opendnssec-signer.service, parses zone update stats, checks downstream DNS SOA serial propagation, and exposes Prometheus metrics.

Install

This project uses pyproject.toml. Install in your environment of choice.

Run

  • As a console script (recommended):

    propogation-exporter -c /etc/coralogix-exporter/zones.yaml --metrics-port 8000

  • As a module:

    python -m propogation_exporter -c /etc/coralogix-exporter/zones.yaml

  • Legacy script (still supported):

    python main.py -c /etc/coralogix-exporter/zones.yaml

Testing with uv

This project uses uv for Python environment and dependency management in development.

  • Install dev deps (once):

    uv sync --extra dev

  • Run tests with coverage:

    uv run pytest -q --cov=propogation_exporter --cov-report=term-missing

  • Optional: type and style checks:

    uv run mypy propogation_exporter uv run flake8 propogation_exporter

CLI options

  • -c, --config-file: YAML with zones and nameservers
  • --metrics-port: Prometheus HTTP port (default 8000)
  • --zone / --ns: Ad-hoc SOA serial checks without systemd
  • --stats-regex: Override the regex used to parse journal "[STATS]" lines.

Regex parsing

By default, the parser extracts zone, serial, and RR count from lines like:

[STATS] example.com 2024072826 RR[count=4 time=0(sec)] ...

Default pattern:

^\[STATS\]\s+(?P<zone>\S+)\s+(?P<serial>\d+)\s+RR\[count=(?P<rr_count>\d+)

You can override it via CLI --stats-regex or programmatically when creating ZoneManager.

Module layout

  • propogation_exporter/
    • init.py: public exports
    • main.py: python -m entry
    • cli.py: argument parsing and app wiring
    • journal.py: systemd journal reader
    • zone.py: ZoneInfo, ZoneConfig, ZoneManager, and parsing
    • dns_utils.py: DNSChecker utilities
    • metrics.py: Prometheus metrics

Prometheus metrics

  • zone_rr_count{zone}
  • zone_in_sync{zone}
  • zone_propagation_delay_seconds{zone, nameserver, serial}

Config file

YAML example:

zones:
	example.com.:
		primary_nameserver: 192.0.2.1
		downstream_nameservers:
			- 192.0.2.2
			- 192.0.2.3

Notes

  • Ensure systemd-python, dnspython, PyYAML, and prometheus-client are available in the runtime environment.

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

propogation_exporter-0.1.0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

propogation_exporter-0.1.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file propogation_exporter-0.1.0.tar.gz.

File metadata

  • Download URL: propogation_exporter-0.1.0.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for propogation_exporter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2552015ccdb7d65e2e2abf198ffd3c229c256d3927d06d6e66af7cd7e1044ba5
MD5 290b2f7535446419836700d1db3599fc
BLAKE2b-256 45938e51571a526092397554d051c3606b02db5da52f8cb5026a03177182f246

See more details on using hashes here.

Provenance

The following attestation bundles were made for propogation_exporter-0.1.0.tar.gz:

Publisher: build.yml on icann-dns/zone_propogation_exporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file propogation_exporter-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for propogation_exporter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b11a51fed4f23e2a266b9c96dee194263baa03a1359166f401d9d3b2218be710
MD5 22ae078fb16ebd72e06747c477aa998d
BLAKE2b-256 6d0ded031d1313cba6c144c823cf8829b9ef4238882278035d8ac56d0d2627a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for propogation_exporter-0.1.0-py3-none-any.whl:

Publisher: build.yml on icann-dns/zone_propogation_exporter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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