Skip to content

Re-introduce documentation for Prometheus alert integrations

Sarah Yasonik requested to merge sy-prometheus-docs-ideas into master

What does this MR do and why?

Related issue: Revert Prometheus Alerts Documentation (#373301 - closed).

Per !97715 (comment 1156365582), this MR re-adds docs for "External Prometheus" alert integrations.

Primary changes:

  • improve cross-linking between sections
  • move alerting-configuration info out of doc/operations/metrics/alerts.md and into doc/operations/incident_management/alerts.md
    • this old organization seems like an artifact of the previous feature to configure alerting rules through gitlab. But that doesn't really make sense to me anymore 🤔
  • uniformly format prometheus & generic alert configuration info
  • reduce duplication of setup instructions
  • shift prose to lists/tables where applicable
  • shift focus to consequences/outcomes of any given action/input
  • adds an explanation of what using alert endpoints actually gets you
  • adds section on configuring Prometheus alerting rules

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports