From 06a99d6be3bd7c0a51c274219ef5bdd9815e2814 Mon Sep 17 00:00:00 2001 From: antonio <45235678+tonypowa@users.noreply.github.com> Date: Wed, 12 Jun 2024 08:58:45 +0200 Subject: [PATCH] docs: alerting: manual backport (#88756) (#88848) * docs: alerting: clarify which panels support alerts (#88756) * alerting: clarify which panels support alerts * changed note placement * small change to link * added links * Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/panels-visualizations/visualizations/_index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/panels-visualizations/visualizations/time-series/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/panels-visualizations/visualizations/time-series/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> --------- Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> (cherry picked from commit 000b5dd6eabbe3d1ff344fb6fa8f7c051611721d) * removed markers * removed markers --- .../create-grafana-managed-rule.md | 14 +++++++++++++ .../create-mimir-loki-managed-rule.md | 14 +++++++++++++ .../visualizations/_index.md | 2 +- .../visualizations/time-series/index.md | 21 +++++++++++++++++++ 4 files changed, 50 insertions(+), 1 deletion(-) diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 2976f91fd61..b4047b404e0 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -49,6 +49,16 @@ refs: destination: /docs/grafana//dashboards/use-dashboards/#time-units-and-relative-ranges - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/dashboards/use-dashboards/#time-units-and-relative-ranges + alert-list: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/alert-list/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/alert-list/ + time-series: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/time-series/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series/ --- # Configure Grafana-managed alert rules @@ -212,6 +222,10 @@ Annotations add metadata to provide more information on the alert in your alert Links alerts to panels in a dashboard. + {{% admonition type="note" %}} + At the moment, alerts are only supported in the [time series](ref:time-series) and [alert list](ref:alert-list) visualizations. + {{% /admonition %}} + {{< docs/play title="visualizations with linked alerts in Grafana" url="https://play.grafana.org/d/000000074/" >}} 1. Click **Save rule**. diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md index 3876ff4d76a..c21dc2e9fa7 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md @@ -29,6 +29,16 @@ refs: destination: /docs/grafana//alerting/fundamentals/alert-rules/annotation-label/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/alerting-and-irm/alerting/fundamentals/alert-rules/annotation-label/ + alert-list: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/alert-list/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/alert-list/ + time-series: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/time-series/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series/ --- # Configure data source-managed alert rules @@ -134,6 +144,10 @@ Annotations add metadata to provide more information on the alert in your alert Links alerts to panels in a dashboard. + {{% admonition type="note" %}} + At the moment, alerts are only supported in the [time series](ref:time-series) and [alert list](ref:alert-list) visualizations. + {{% /admonition %}} + {{< docs/play title="visualizations with linked alerts in Grafana" url="https://play.grafana.org/d/000000074/" >}} 1. Click **Save rule**. diff --git a/docs/sources/panels-visualizations/visualizations/_index.md b/docs/sources/panels-visualizations/visualizations/_index.md index 864720021e9..f779e73b7cc 100644 --- a/docs/sources/panels-visualizations/visualizations/_index.md +++ b/docs/sources/panels-visualizations/visualizations/_index.md @@ -162,7 +162,7 @@ If you are unsure which visualization to pick, Grafana can provide visualization {{< /admonition >}} - Graphs & charts - - [Time series](ref:time-series) is the default and main Graph visualization. + - [Time series](ref:time-series) is the default and main graph visualization. Alerts are supported in this panel. - [State timeline](ref:state-timeline) for state changes over time. - [Status history](ref:status-history) for periodic state over time. - [Bar chart](ref:bar-chart) shows any categorical data. diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index e2daafce136..58a676bdd98 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -57,6 +57,22 @@ refs: destination: /docs/grafana//panels-visualizations/configure-standard-options/#max - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options/#max + destination: /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides/#add-a-field-override + configure-field-overrides: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/configure-overrides/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides/ + alert-list: + - pattern: /docs/grafana/ + destination: /docs/grafana//panels-visualizations/visualizations/alert-list/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/alert-list/ + link-alert: + - pattern: /docs/grafana/ + destination: /docs/grafana//alerting/alerting-rules/create-grafana-managed-rule/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/create-grafana-managed-rule/ --- # Time series @@ -65,6 +81,11 @@ refs: Time series visualizations are the default and primary way to visualize time series data as a graph. They can render series as lines, points, or bars. They're versatile enough to display almost any time-series data. +{{% admonition type="note" %}} +You can [link alert rules](ref:link-alert) to time series visualization to observe when alerts fire and are resolved in the form of annotations. In addition, you can create alert rules from the Alert tab within the panel options. +At the moment, alerts are only supported in the time series and [alert list](ref:alert-list) visualizations. +{{% /admonition %}} + {{% admonition type="note" %}} You can migrate from the old Graph visualization to the new time series visualization. To migrate, open the panel and click the **Migrate** button in the side pane. {{% /admonition %}}