Skip to content

alertmanager: Sync metric documentation from upstream#10470

Merged
alexweav merged 2 commits intomainfrom
alexweav/am-metric-docs
Jan 17, 2025
Merged

alertmanager: Sync metric documentation from upstream#10470
alexweav merged 2 commits intomainfrom
alexweav/am-metric-docs

Conversation

@alexweav
Copy link
Copy Markdown
Contributor

What this PR does

Incorporates prometheus/alertmanager#4210, which changes the helptext of alertmanager_config_hash to state that the hash is expected to collide.

Since that's documented in the hash we deliver to users, we can safely suppress g401 on the code generating the hash.

Since Mimir metrics layer their own helptext on top of the base alertmanager metrics, this can be done without updating the vendored code, which can be left to Alerting team.

Which issue(s) this PR fixes or relates to

n/a

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

Copy link
Copy Markdown
Contributor

@gotjosh gotjosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alexweav alexweav merged commit a78d78c into main Jan 17, 2025
@alexweav alexweav deleted the alexweav/am-metric-docs branch January 17, 2025 15:40
@alexweav alexweav mentioned this pull request Jan 17, 2025
4 tasks
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.

2 participants