Skip to content

docs: describe Alertmanager architecture - #5390

Open
locker95 wants to merge 2 commits into
prometheus:mainfrom
locker95:docs/describe-architecture
Open

docs: describe Alertmanager architecture#5390
locker95 wants to merge 2 commits into
prometheus:mainfrom
locker95:docs/describe-architecture

Conversation

@locker95

@locker95 locker95 commented Jul 16, 2026

Copy link
Copy Markdown

Summary

Keep a short, stable summary and documentation link below the architecture diagram. Add an architecture overview to docs/alertmanager.md covering the alert flow, while linking to the existing high-availability documentation for cluster-specific behavior.

This keeps implementation details out of the README so they are less likely to become stale.

cc @simonpasquier

Pull Request Checklist

  • Please list all open issue(s) discussed with maintainers related to this change
  • Is this a new Receiver integration?
    • I have already tried to use the Webhook Receiver Integration and 3rd party integrations before adding this new Receiver Integration
  • Is this a bugfix?
    • I have added tests that can reproduce the bug which pass with this bugfix applied
  • Is this a new feature?
    • I have added tests that test the new feature functionality
  • Does this change affect performance?
    • I have provided benchmarks comparison that shows performance is improved or is not degraded
    • I have added new benchmarks if required or requested by maintainers
  • Is this a breaking change?
    • My changes do not break the existing cluster messages
    • My changes do not break the existing api
  • I have added/updated the required documentation
  • I have signed-off my commits
  • I will follow best practices for contributing to this project

Validation

  • git diff --check
  • Verified the README architecture link resolves to docs/alertmanager.md#architecture
  • Verified the architecture overview links to docs/high_availability.md

Which user-facing changes does this PR introduce?

NONE

Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
@locker95
locker95 requested a review from a team as a code owner July 16, 2026 18:44
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md and docs/alertmanager.md now document Alertmanager’s alert flow, architecture, high-availability replication, and alert-limit metric labeling.

Changes

Alertmanager documentation

Layer / File(s) Summary
Architecture flow description
README.md, docs/alertmanager.md
Adds descriptions of alert ingestion, storage, grouping, routing, silences, inhibition, notification delivery, and high-availability replication.
Alert-limit metric description
docs/alertmanager.md
Updates the description of the alert-names-in-metrics feature flag and its alertname label.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes satisfy #2424 by adding a brief architecture description for the README diagram and linking to the detailed docs.
Out of Scope Changes check ✅ Passed The modified README and Alertmanager docs align with the stated documentation goal and do not introduce unrelated scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title is concise and accurately summarizes the main change: documenting the Alertmanager architecture.
Description check ✅ Passed The description follows the template closely, with a summary, checklist, validation, and release-notes section.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@SoloJacobs

Copy link
Copy Markdown
Contributor

Hi @locker95 ,

This is the kind description that tends to go stale over time. I think it is probably better to have a link pointing towards architecture documentation, and put the description there (if it adds something).

Kind regards

@SoloJacobs
SoloJacobs self-requested a review July 18, 2026 14:08
Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
@locker95

Copy link
Copy Markdown
Author

Thanks @SoloJacobs, addressed in bf55531. The README now keeps only a short, stable summary and links to the architecture overview in docs/alertmanager.md. The overview links to the existing high-availability documentation for cluster-specific behavior, avoiding duplicated implementation details in the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add description for Architecture diagram in README

4 participants