-
Notifications
You must be signed in to change notification settings - Fork 226
[DOCS] Alert status topic #5718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
catalinaadam
wants to merge
6
commits into
main
Choose a base branch
from
3.9.0_update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+85
−8
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # View alert status by node or service | ||
| When alerts fire, you need to know which nodes or services are affected and what state each alert is in. Use the **Alert Status** page to get that picture at a glance, triage by state, and silence alerts without switching pages. | ||
|
|
||
|
|
||
| ## Check alerts for a specific node | ||
|
|
||
| To see all alerts affecting a single node: | ||
| {.power-number} | ||
|
|
||
| 1. Go to **Alerts > Status**. | ||
| 2. Toggle **Group by node** in the toolbar. | ||
| 3. Find your node and expand it to see its individual alerts and their states. | ||
|
|
||
| ## Filter alerts by state | ||
|
|
||
| Use the **State** dropdown in the toolbar to show only alerts in a specific state: **Normal**, **Pending**, **Firing**, **Recovering**, **No Data**, **Error** or **Silenced**. | ||
|
|
||
| ## Check alerts for a specific service | ||
|
|
||
| To filter the alert list by service: | ||
| {.power-number} | ||
|
|
||
| 1. Go to **Alerts > Status**. | ||
| 2. Click **Show/Hide filters** in the toolbar to reveal the column filters. | ||
| 3. In the **Service** column filter, enter the service name. | ||
|
|
||
| The table updates to show only alerts associated with that service. | ||
|
|
||
| ## Get details on an alert | ||
|
|
||
| Click any alert row to open the details pane. From here you can: | ||
|
|
||
| - **See what triggered the alert**: the **Details** tab shows the summary, description, state and duration, node, service, severity, triggered at timestamp, and the MetricsQL expression. Check **Rule configuration** to see evaluation settings, template name, folder, and rule health. | ||
| - **Debug custom templates or verify label values**: switch to **Raw data** to inspect the full label set and JSON payload. | ||
| - **Move between alerts**: use the arrow buttons in the pane header to go to the next or previous alert without closing the pane. | ||
|
|
||
| ## Silence an alert | ||
|
|
||
| You need **Editor** role or higher to silence alerts. | ||
| {.power-number} | ||
|
|
||
| 1. Click the actions menu on the alert row. | ||
| 2. Click **Silence**. PMM opens the **Silences** page with the alert labels pre-filled. | ||
| 3. Set the duration and confirm. | ||
|
|
||
| Silenced alerts stay visible in the table with a **Silenced** badge. To unsilence, open the actions menu and click **Unsilence**. | ||
|
|
||
| ## Make custom alerts appear in this view | ||
|
|
||
| Built-in PMM alert templates automatically include the labels that this page uses to group alerts by node and service. | ||
|
|
||
| The following templates show data even when no alert is firing, so you can see how close a node or service is to triggering an alert before it does: | ||
|
|
||
| - **Node high CPU load** | ||
| - **MongoDB DBPath disk space utilization** | ||
| - **PostgreSQL high rate of transaction rollbacks** | ||
| - **PostgreSQL connections in use** | ||
|
|
||
| Support for more templates to show data when no alert is firing will be added in future releases. | ||
|
|
||
| If your custom templates do not show up correctly, add these labels to the template definition: | ||
|
|
||
| - `node_name`: identifies the monitored node. | ||
| - `service_name`: identifies the monitored service. | ||
|
|
||
| For instructions, see [Alert rules and alert templates](../alert/alert_rules.md). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.