Skip to content

[DOCS] Alert status topic - #5718

Open
catalinaadam wants to merge 6 commits into
mainfrom
3.9.0_update
Open

[DOCS] Alert status topic#5718
catalinaadam wants to merge 6 commits into
mainfrom
3.9.0_update

Conversation

@catalinaadam

@catalinaadam catalinaadam commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

status changes

Ticket number: PMM-0

Feature build: SUBMODULES-0

If this PR adds, removes or alters one or more API endpoints, please review and update the relevant API documentation as well:

  • API Docs updated

If this PR is related to other PRs, contributions, or ongoing work in this or other repositories, please reference them here:

  • Links to related work items (optional).

Summary by CodeRabbit

  • Documentation
    • Added guidance for viewing, filtering, inspecting, silencing, and unsilencing alerts.
    • Documented alert states, prerequisites, permissions, and custom templates with node and service labels.
    • Added the alert status guide to the documentation navigation.
    • Clarified that four built-in alert templates remain visible while metrics are within configured thresholds.
    • Updated the 3.9.0 release notes with continuous reporting details and a clearer known-issues warning.

status changes
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 81c0e256-fe2f-405c-a21f-8d9cb51c2d59

📥 Commits

Reviewing files that changed from the base of the PR and between 7c41ccf and 05f0e16.

📒 Files selected for processing (3)
  • documentation/docs/alert/alert_status.md
  • documentation/docs/alert/silence_alerts.md
  • documentation/mkdocs-base.yml
🚧 Files skipped from review as they are similar to previous changes (2)
  • documentation/mkdocs-base.yml
  • documentation/docs/alert/alert_status.md

Walkthrough

The change adds an Alert Status guide, adds it to Percona Alerting navigation, updates persistent alert template descriptions, and expands the 3.9.0 release notes.

Changes

Alert Status documentation

Layer / File(s) Summary
Alert Status guide and navigation
documentation/docs/alert/alert_status.md, documentation/mkdocs-base.yml, documentation/docs/alert/silence_alerts.md
The guide documents filtering, alert details, states, silencing, permissions, prerequisites, custom labels, and supported templates. The page is added to Percona Alerting navigation. Silenced alert terminology is updated.
Persistent alert templates and release notes
documentation/docs/alert/templates_list.md, documentation/docs/release-notes/3.9.0.md
The documentation identifies four templates that remain visible while metrics stay within configured thresholds. The release notes describe these templates, future reporting expansion, custom labels, and an emoji-prefixed Known issues heading.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: nailya, shrutipradhan-percona, rasika-chivate

Poem

A rabbit checks each alert state,
Then finds the page in the menu gate.
Labels, silence, templates too,
Keep threshold details in view.
Orange diamonds mark what’s new.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the pull request as documentation for the alert status topic.
Description check ✅ Passed The description includes the required ticket, feature build, API documentation, and related work sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 3.9.0_update

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@documentation/docs/alert/alert_status.md`:
- Line 3: Align the Alert Status introduction with the documented silencing
workflow: update the statement near “Alert Status” to say users start the
silencing process there, or revise the steps around the Silences page so they
remain consistent with the existing introduction.
- Line 19: Update the alert-state terminology in silence_alerts.md, replacing
every user-facing occurrence of “Suppressed” with “Silenced” to match the UI and
the wording used in alert_status.md.
- Line 60: Update the documentation link in alert_status.md to reference
../alert/alert_rules.md instead of the nonexistent templates.md path, preserving
the existing link text.

In `@documentation/mkdocs-base.yml`:
- Line 398: Update the navigation entry in mkdocs-base.yml to reference the
existing alert_status.md filename under alert, or rename the file to match the
current entry, ensuring the navigation link resolves correctly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f4e872fb-6251-48e2-ae21-e287477b67c5

📥 Commits

Reviewing files that changed from the base of the PR and between 3fb35bd and ce681a9.

📒 Files selected for processing (3)
  • documentation/docs/alert/alert_status.md
  • documentation/docs/release-notes/3.9.0.md
  • documentation/mkdocs-base.yml

@@ -0,0 +1,60 @@
# View alert status by node or service

Use the **Alert Status** page to see all active alerts for a node or service in one place, check their states, and silence them without switching views.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Align the introduction with the silencing workflow.

Line 3 says users can silence alerts without switching views. Lines 45-47 say PMM opens the Silences page. Update the introduction to describe starting the silencing workflow, or change the steps to match the actual UI behavior.

Also applies to: 45-47

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@documentation/docs/alert/alert_status.md` at line 3, Align the Alert Status
introduction with the documented silencing workflow: update the statement near
“Alert Status” to say users start the silencing process there, or revise the
steps around the Silences page so they remain consistent with the existing
introduction.

Comment thread documentation/docs/alert/alert_status.md
Comment thread documentation/docs/alert/alert_status.md Outdated
Comment thread documentation/mkdocs-base.yml Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants