Skip to content

docs/observability.md says three receivers; there are four #212

Closed

Description

@Gerrrt

docs/observability.md
opens its Routing section with:

Three receivers, three separate destinations (see
alertmanager/alertmanager.yaml).

alertmanager.yaml has four notifying receivers — default, urgent,
security, heartbeat — plus "null". Its own header comment says "four
channels and four destinations".

The prose went stale when security was added and the sentence was not
revisited. The routing table immediately below it is correct and lists all four,
so the paragraph contradicts the table it introduces.

check_docs.py does not catch this: it guards counted claims about rules,
dashboards and panels, and asserts the routing table row by row with
amtool config routes test, but the receiver count in that sentence is not one
of the counted claims. Adding it is probably the real fix — the count is derived
from alertmanager.yaml the same way the rule counts are derived from the rule
files, and this is the second time a number in that file has drifted (#72).

Note the checker's spelled-number matching was case-insensitive as of #81, so
"Three receivers" at the start of a sentence is now matchable where it would not
have been before.

Found while doing #81.

Activity

  1. added
    docsImprovements or additions to documentation
    on Aug 31, 2026
  2. added a commit that references this issue on Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions