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.3.tar.gz (12.1 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.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: amlint-0.1.3.tar.gz
  • Upload date:
  • Size: 12.1 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.3.tar.gz
Algorithm Hash digest
SHA256 d87547b2d5d41daa74a7c13284d26b8f3c2991040b72e8cd9b587b1b6fd65ed7
MD5 9b57085fef2a1dbf4e9f751f70ea7b1f
BLAKE2b-256 71e7b91368d19fdbaa934ce70e1422de3fc22c6f7e322575fc7645ddfb71944a

See more details on using hashes here.

Provenance

The following attestation bundles were made for amlint-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: amlint-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3bc36ba1fcc17f271c08049267574d9af6d919e3b1aa7d88a12cb20932de6862
MD5 1859894e8a0ce6e926a2fed260920889
BLAKE2b-256 c8f0d0a5d87f69ac89e4a81d30e1ab87294b6d4178fc1f3b29dcbe54e0b52b36

See more details on using hashes here.

Provenance

The following attestation bundles were made for amlint-0.1.3-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