alerting: Improve documentation regarding linking and visualizing alert rules in dashboards #87892
Conversation
This file contains 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
tonypowa
added
type/docs
no-changelog
|
This PR must be merged before a backport PR will be created. |
1 similar comment
|
This PR must be merged before a backport PR will be created. |
|
@brendamuir |
|
done ✅ let me know what you think @brendamuir @ppcano commit 1 commit 2 commit 3 commit 4 commit 5 |
ppcano
reviewed
May 15, 2024
| @@ -41,6 +41,10 @@ Add labels to uniquely identify your alert rule and configure alert routing. Lab | |||
|
|
|||
| After alert rules are created, they go through various states and transitions. | |||
|
|
|||
| You can also link alert rules to panels, allowing you to visualize the alert conditions directly within your dashboards and gain insights into the metrics triggering the alerts. | |||
There was a problem hiding this comment.
I am for Not mentioning Play in this section.
ppcano
reviewed
May 15, 2024
| @@ -54,6 +54,12 @@ An alert instance can be in either of the following states: | |||
| | **NoData** | No data has been received for the configured time window. | | |||
| | **Error** | The error that occurred when attempting to evaluate an alert rule. | | |||
|
|
|||
|
|
|||
| Grafana provides an Alert List panel that allows you to visualize the states of different alert instances in a centralized view. By adding this panel to your dashboards, you can monitor which alerts are firing, pending, or inactive, enabling a comprehensive overview of your alerting landscape and facilitating quicker response times to any issues. | |||
There was a problem hiding this comment.
I am for Not mentioning Play in this section.
ppcano
reviewed
May 15, 2024
| @@ -43,6 +43,10 @@ How do you want your alert to be evaluated? | |||
|
|
|||
| How do you want to route your alert? What kind of additional labels could you add to annotate your alert rules and ease searching? | |||
|
|
|||
| In this section you also have the option to link an alert to a visualization. | |||
There was a problem hiding this comment.
I am for Not mentioning Play in this section.
ppcano
reviewed
May 15, 2024
|
done |
brendamuir
approved these changes
May 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is this feature?
Commit 1: https://grafana.com/docs/grafana/next/alerting/fundamentals/#alert-rules Mention linking dashboards to Alerts, and add shortcode to alerting demo dashboard in play
Commit 2: https://grafana.com/docs/grafana/next/alerting/fundamentals/alert-rule-evaluation/state-and-health/#alert-rule-state Add link to alerting demo dashboard in play to showcase alert rule state with the alert list panel and a panel that contains an alert (heart icon in the dashboard)
Commit 3: https://grafana.com/docs/grafana/next/alerting/alerting-rules/ mention the config option to link to existing panel and add link to alerting demo dashboard in play
Commit 4: https://grafana.com/docs/grafana/next/alerting/alerting-rules/create-grafana-managed-rule/#add-annotations edit the link to panel bit, and add link to alerting demo dashboard in play
Commit 5: https://grafana.com/docs/grafana/next/alerting/alerting-rules/create-mimir-loki-managed-rule/#add-annotations edit the link to panel bit, and add link to alerting demo dashboard in play
Why do we need this feature?
Improve documentation regarding linking and visualizing alert rules in dashboards by adding content to the docs above and showcase that feature by adding shortcode to link to play.grafana