Skip to main content

Semantic linter for Prometheus Alertmanager configs

Project description

amlint

CI Docs Coverage PyPI Python Docker

Semantic linter for Prometheus Alertmanager configs.

amtool check-config validates syntax. amlint validates semantics: will alerts actually reach a receiver, does the inhibition rule do anything, are there unreachable routing branches? These are the bugs that burn teams — config is valid, alerts silently vanish.

Why

Alertmanager configs are YAML routing trees with inhibition rules and receivers. The most painful mistakes are syntactically valid:

  • route references a receiver that doesn't exist → alerts are dropped
  • inhibition without equal → silences unrelated alerts, you think it's quiet, there's actually a fire
  • catch-all branch before specific ones → specific branches are unreachable
  • match_re that doesn't compile
  • group_by that doesn't behave the way you think

amtool won't catch any of this. amlint will.

Install

pip install amlint

Or with Docker (no Python required):

docker run --rm -v $(pwd):/cfg ghcr.io/danikdanik2013/amlint check /cfg/alertmanager.yml

Usage

amlint check alertmanager.yml
amlint check prod.yml staging.yml        # multiple files
cat alertmanager.yml | amlint check -    # stdin
amlint check alertmanager.yml --strict   # WARN also exits non-zero
amlint check alertmanager.yml --format json
amlint diff old.yml new.yml              # show what changed
amlint init > alertmanager.yml           # generate minimal valid config

Shell completions (bash/zsh):

pip install "amlint[completions]"
eval "$(register-python-argcomplete amlint)"  # add to ~/.zshrc or ~/.bashrc

Example output:

  ERROR  Route references receiver 'pager-team' which is not defined in receivers. Alerts matched here will be dropped.
  ↳ route.routes[1]  [undefined-receiver]

  WARN   Catch-all route (no matchers) with continue:false will intercept all alerts — 2 subsequent sibling(s) are unreachable.
  ↳ route.routes[0]  [unreachable-route]

  2 error · 3 warn · 1 info

Exit code 1 on ERROR — ready for CI. --strict makes WARN block too.

CI example

# .github/workflows/lint.yml
- name: Lint Alertmanager config
  run: amlint check alertmanager.yml --strict

Checks

code level what it catches
undefined-receiver error route references a receiver that doesn't exist
bad-regex error match_re pattern fails to compile
no-root-route error no root route defined
inhibit-no-equal warn inhibition without equal silences too broadly
unreachable-route warn catch-all hides subsequent sibling routes
groupby-ellipsis warn ... mixed with explicit labels in group_by
inhibit-same-match info source and target match the same label value
unused-receiver info receiver defined but not used in any route
duplicate-receiver error receiver name defined more than once
empty-receiver warn/info receiver has no integration configured — alerts will be dropped
undefined-time-interval error mute_time_intervals / active_time_intervals references unknown interval
repeat-before-group warn repeat_interval shorter than group_interval
circular-inhibition warn two inhibition rules that silence each other
wait-exceeds-interval warn group_wait longer than group_interval
useless-continue info continue:true on the last sibling route has no effect

Tests

python3 -m pytest test_linter.py -v

License

MIT

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

amlint-0.1.5.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

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

amlint-0.1.5-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file amlint-0.1.5.tar.gz.

File metadata

  • Download URL: amlint-0.1.5.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for amlint-0.1.5.tar.gz
Algorithm Hash digest
SHA256 db46dd603650d69b65427ba2215f43bc4a63063450bed685893334d084ec90e0
MD5 f4350b48e9c525a11d31449299b5340a
BLAKE2b-256 1434050b94c1f17d742fcba409fc5f8f655f4798bdc52aae489ec1f696141a01

See more details on using hashes here.

Provenance

The following attestation bundles were made for amlint-0.1.5.tar.gz:

Publisher: publish.yml on danikdanik2013/amlint

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

File details

Details for the file amlint-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: amlint-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for amlint-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 74694a73f69cdd6fc02212b98d4a22ae4234709c5fbc78d4d18ff549d95709e4
MD5 4a8445f71ca790722c04370cd78f495a
BLAKE2b-256 a551f6ba37977e950e58115daa23b8a54e78cb517e17e7f6094ac635207858ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for amlint-0.1.5-py3-none-any.whl:

Publisher: publish.yml on danikdanik2013/amlint

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