mirror of https://github.com/grafana/grafana
Alerting docs: Update `Create alert rules from panels` (#95566)
* Alerting docs: Update `Create alert rules from panels` * Remove screenshots except when the panel displays alert status * Further changes sync with Brenda * minor changes * Relocate admonition * Specify `dashboardUId` and `panelId` must be set together * Update docs/sources/alerting/alerting-rules/link-alert-rules-to-dashboards.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * change title * change URL * fix spell error --------- Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>pull/95821/head
Pepe Cano
1 year ago
committed by
GitHub
parent
2b370d6e27
commit
facca37f4d
@ -1,51 +0,0 @@ |
||||
--- |
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/create-alerts-panels/ |
||||
description: Create alert rules from panels. Reuse the queries in the panel and create alert rules based on them. |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- panels |
||||
- create |
||||
- grafana-managed |
||||
- data source-managed |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
title: Create alert rules from panels |
||||
weight: 300 |
||||
refs: |
||||
time-series-visualizations: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/visualizations/time-series/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series/ |
||||
--- |
||||
|
||||
## Create alert rules from panels |
||||
|
||||
Create alert rules from time series panels. By doing so, you can reuse the queries in the panel and create alert rules based on them. |
||||
|
||||
1. Navigate to a dashboard in the **Dashboards** section. |
||||
2. Hover over the top-right corner of a time series panel and click the panel menu icon. |
||||
3. From the dropdown menu, select **More...** > **New alert rule**. |
||||
|
||||
The New alert rule form opens where you can configure and create your alert rule based on the query used in the panel. |
||||
|
||||
{{% admonition type="note" %}} |
||||
Changes to the panel aren't reflected on the linked alert rules. If you change a query, you have to update it in both the panel and the alert rule. |
||||
|
||||
Alert rules are only supported in [time series](ref:time-series-visualizations) visualizations. |
||||
{{% /admonition %}} |
||||
|
||||
{{< docs/play title="visualizations with linked alerts in Grafana" url="https://play.grafana.org/d/000000074/" >}} |
||||
|
||||
## View alert rules from panels |
||||
|
||||
To view alert rules associated with a time series panel, complete the following steps. |
||||
|
||||
1. Open the panel editor by hovering over the top-right corner of any panel |
||||
1. Click the panel menu icon that appears. |
||||
1. Click **Edit**. |
||||
1. Click the **Alert** tab to view existing alert rules or create a new one. |
||||
@ -0,0 +1,84 @@ |
||||
--- |
||||
aliases: |
||||
- ../../alerting/alerting-rules/create-alerts-panels/ # /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-alerts-panels/ |
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/link-alert-rules-to-panels/ |
||||
description: Grafana allows you to link alert rules with panels and dashboards. This helps connect alerts with an existing dashboard and informs alert responders on where to investigate. |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- panels |
||||
- create |
||||
- grafana-managed |
||||
- data source-managed |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
title: Create and link alert rules to panels |
||||
weight: 300 |
||||
refs: |
||||
time-series-visualizations: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/visualizations/time-series/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series/ |
||||
annotations: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rules/annotation-label/#annotations |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/fundamentals/alert-rules/annotation-label/#annotations |
||||
view-alert-state-on-panels: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/manage-notifications/view-alert-state-on-panels/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/manage-notifications/view-alert-state-on-panels/ |
||||
--- |
||||
|
||||
# Create and link alert rules to panels |
||||
|
||||
Grafana allows you to link an alert rule to a dashboard panel. This can help you: |
||||
|
||||
- Inform alert responders about where to investigate and which data to examine. |
||||
- Visualize the alert state directly from dashboards. |
||||
|
||||
An alert rule is linked to a panel by setting the [`dashboardUId` and `panelId` annotations](ref:annotations). Both annotations must be set together. |
||||
|
||||
## Link alert rules to panels |
||||
|
||||
When configuring the alert rule, you can set the dashboard and panel annotations as shown in this [video](https://youtu.be/ClLp-iSoaSY?si=qKWnvSVaQuvYcuw9&t=170). |
||||
|
||||
1. Configure the alert rule. |
||||
1. In the **Configure notification message** section, click **Link dashboard and panel**. |
||||
1. Select an existing dashboard, then choose a panel from the selected dashboard. |
||||
1. Complete the alert rule configuration and click **Save rule** to initiate the alert rule. |
||||
|
||||
You can then [view the alert state on the panel](ref:view-alert-state-on-panels). |
||||
|
||||
{{< figure src="/media/docs/alerting/panel-displays-alert-state.png" max-width="1200px" caption="A panel displaying the alert status and state changes." >}} |
||||
|
||||
## Create alert rules from panels |
||||
|
||||
To streamline alert creation, you can create an alert rule directly from a panel. |
||||
|
||||
1. Navigate to a dashboard in the **Dashboards** section. |
||||
1. Hover over the top-right corner of a panel and click the panel menu icon. |
||||
1. From the dropdown menu, select **More...** > **New alert rule**. |
||||
1. This opens the **Edit rule** form and pre-fills some values: |
||||
- Sets the `dashboardUId` and `panelId` annotations to the corresponding dashboard and panel. |
||||
- Sets the alert rule query using the panel query. |
||||
1. Complete the alert rule configuration and click **Save rule** to initiate the alert rule. |
||||
|
||||
You can then [view the alert state on the panel](ref:view-alert-state-on-panels). |
||||
|
||||
{{% admonition type="note" %}} |
||||
Changes to panel and alert rule queries aren't synchronized. If you change a query, you have to update it in both the panel and the alert rule. |
||||
{{% /admonition %}} |
||||
|
||||
## Access linked alert rules from panels |
||||
|
||||
This option is available only in [time series panels](ref:time-series-visualizations). To access alert rules associated to a time series panel, complete the following steps. |
||||
|
||||
1. Hover over the top-right corner of the panel and click the panel menu icon. |
||||
1. Click **Edit**. |
||||
1. Click the **Alert** tab to view existing alert rules or create a new one. |
||||
@ -0,0 +1,54 @@ |
||||
--- |
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/manage-notifications/view-alert-state-on-panels/ |
||||
description: View alert rules |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- rules |
||||
- view |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
title: View alert state on panels |
||||
weight: 430 |
||||
refs: |
||||
time-series-visualizations: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/visualizations/time-series/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series/ |
||||
alert-list-panel: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/visualizations/alert-list/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/alert-list/ |
||||
link-alert-rules-to-panels: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/link-alert-rules-to-panels/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/link-alert-rules-to-panels/ |
||||
--- |
||||
|
||||
# View alert state on panels |
||||
|
||||
When an [alert rule is linked to a time series panel](ref:link-alert-rules-to-panels), the time series panel displays the alert state and alert events. |
||||
|
||||
A heart icon near the panel title shows the current alert state: |
||||
|
||||
- A broken red heart when the alert is in `Alerting` state. |
||||
- A green heart when the alert is in `Normal` state. |
||||
|
||||
Colored annotations indicate changes in alert state, such as pending, alerting, and resolving. |
||||
|
||||
{{< figure src="/media/docs/alerting/panel-displays-alert-state.png" max-width="1200px" alt="A panel with a firing alert and annotations that display the pending and alerting state changes." >}} |
||||
|
||||
Additionally, Grafana provides an [alert list panel](ref:alert-list-panel) that you can add to a dashboard to display a list of alerts and their states. |
||||
|
||||
{{< figure src="/static/img/docs/alert-list-panel/alert-list-panel.png" max-width="850px" alt="Two alert list panels displaying distinct lists of alerts." >}} |
||||
|
||||
You can configure the alert list panel with various visualization options and filters to control how alerts are displayed. For more details, refer to the [Alert list documentation](ref:alert-list-panel). |
||||
|
||||
{{< docs/play title="this demo dashboard with alert list panels and linked alert rules" url="https://play.grafana.org/d/000000074/" >}} |
||||
Loading…
Reference in new issue