From 082cfbdb06e87cd5605e7621e239dfd2b23f62f6 Mon Sep 17 00:00:00 2001 From: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Date: Wed, 4 May 2022 08:22:11 -0400 Subject: [PATCH] Docs: Refactor alerting documentation (part 1) (#48664) * Initial commit * Moved files, ad fixed broken relrefs. * Fixed other broken relrefs * More changes. * Fixing broken relrefs * More changes. * Fixed last of the broken links * More re-org. * Added aliases and some weight adjustments * More aliases. * Fix fundamentals topic. * Fixed remaining metadata issues * Ran prettier --- docs/sources/administration/configuration.md | 2 +- .../set-up-for-high-availability.md | 6 +-- docs/sources/alerting/_index.md | 41 ++++++++++--------- .../{unified-alerting => }/alert-groups.md | 1 + docs/sources/alerting/alerting-limitations.md | 10 +++++ .../alerting-rules/_index.md | 2 +- .../alerting-rules/alert-annotation-label.md | 1 + .../create-grafana-managed-rule.md | 5 ++- ...reate-mimir-loki-managed-recording-rule.md | 2 + .../create-mimir-loki-managed-rule.md | 2 +- .../edit-mimir-loki-namespace-group.md | 1 + .../alerting-rules/rule-list.md | 1 + .../{unified-alerting => }/contact-points.md | 5 ++- .../difference-old-new.md | 3 +- .../fundamentals/_index.md | 4 +- .../fundamentals/alertmanager.md | 4 +- .../fundamentals/evaluate-grafana-alerts.md | 12 ++++-- .../fundamentals/state-and-health.md | 0 .../high-availability/_index.md | 3 +- .../high-availability/enable-alerting-ha.md | 0 .../message-templating/_index.md | 2 +- .../message-templating/template-data.md | 1 + .../message-templating/template-functions.md | 1 + .../opt-in.md => migrating-legacy-alerts.md} | 36 ++++------------ .../notifications/_index.md | 3 +- .../notifications/mute-timings.md | 3 +- docs/sources/alerting/opt-in.md | 41 +++++++++++++++++++ .../{unified-alerting => }/silences.md | 5 ++- .../alerting/unified-alerting/_index.md | 28 ------------- docs/sources/basics/timeseries-dimensions.md | 2 +- .../developers/plugins/backend/_index.md | 4 +- .../enterprise/access-control/about-rbac.md | 4 +- .../rbac-fixed-basic-role-definitions.md | 2 +- docs/sources/http_api/alerting.md | 4 +- .../alerting_notification_channels.md | 2 +- docs/sources/http_api/folder.md | 2 +- docs/sources/image-rendering/_index.md | 2 +- docs/sources/introduction/oss-details.md | 4 +- .../{alerting => }/old-alerting/_index.md | 1 + .../old-alerting/add-notification-template.md | 1 + .../old-alerting/create-alerts.md | 1 + .../old-alerting/notifications.md | 1 + .../old-alerting/pause-an-alert-rule.md | 1 + .../old-alerting/troubleshoot-alerts.md | 1 + .../old-alerting/view-alerts.md | 1 + .../about-expressions.md | 2 +- .../navigate-panel-editor.md | 2 +- docs/sources/whatsnew/whats-new-in-v7-4.md | 2 +- docs/sources/whatsnew/whats-new-in-v8-0.md | 4 +- 49 files changed, 148 insertions(+), 120 deletions(-) rename docs/sources/alerting/{unified-alerting => }/alert-groups.md (95%) create mode 100644 docs/sources/alerting/alerting-limitations.md rename docs/sources/alerting/{unified-alerting => }/alerting-rules/_index.md (91%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/alert-annotation-label.md (97%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/create-grafana-managed-rule.md (94%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/create-mimir-loki-managed-recording-rule.md (93%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/create-mimir-loki-managed-rule.md (96%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/edit-mimir-loki-namespace-group.md (91%) rename docs/sources/alerting/{unified-alerting => }/alerting-rules/rule-list.md (97%) rename docs/sources/alerting/{unified-alerting => }/contact-points.md (98%) rename docs/sources/alerting/{unified-alerting => }/difference-old-new.md (96%) rename docs/sources/alerting/{unified-alerting => }/fundamentals/_index.md (73%) rename docs/sources/alerting/{unified-alerting => }/fundamentals/alertmanager.md (88%) rename docs/sources/alerting/{unified-alerting => }/fundamentals/evaluate-grafana-alerts.md (89%) rename docs/sources/alerting/{unified-alerting => }/fundamentals/state-and-health.md (100%) rename docs/sources/alerting/{unified-alerting => }/high-availability/_index.md (97%) rename docs/sources/alerting/{unified-alerting => }/high-availability/enable-alerting-ha.md (100%) rename docs/sources/alerting/{unified-alerting => }/message-templating/_index.md (97%) rename docs/sources/alerting/{unified-alerting => }/message-templating/template-data.md (98%) rename docs/sources/alerting/{unified-alerting => }/message-templating/template-functions.md (98%) rename docs/sources/alerting/{unified-alerting/opt-in.md => migrating-legacy-alerts.md} (52%) rename docs/sources/alerting/{unified-alerting => }/notifications/_index.md (97%) rename docs/sources/alerting/{unified-alerting => }/notifications/mute-timings.md (94%) create mode 100644 docs/sources/alerting/opt-in.md rename docs/sources/alerting/{unified-alerting => }/silences.md (91%) delete mode 100644 docs/sources/alerting/unified-alerting/_index.md rename docs/sources/{alerting => }/old-alerting/_index.md (98%) rename docs/sources/{alerting => }/old-alerting/add-notification-template.md (99%) rename docs/sources/{alerting => }/old-alerting/create-alerts.md (99%) rename docs/sources/{alerting => }/old-alerting/notifications.md (99%) rename docs/sources/{alerting => }/old-alerting/pause-an-alert-rule.md (98%) rename docs/sources/{alerting => }/old-alerting/troubleshoot-alerts.md (99%) rename docs/sources/{alerting => }/old-alerting/view-alerts.md (98%) diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md index c2466a03b4c..49beb2a70a4 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/administration/configuration.md @@ -1181,7 +1181,7 @@ Sets a global limit on number of alert rules that can be created. Default is -1 ## [unified_alerting] -For more information about the Grafana alerts, refer to [Unified Alerting]({{< relref "../alerting/unified-alerting/_index.md" >}}). +For more information about the Grafana alerts, refer to [About Grafana alerting]({{< relref "../alerting/_index.md" >}}). ### enabled diff --git a/docs/sources/administration/set-up-for-high-availability.md b/docs/sources/administration/set-up-for-high-availability.md index 9dd11efcc41..25232458a75 100644 --- a/docs/sources/administration/set-up-for-high-availability.md +++ b/docs/sources/administration/set-up-for-high-availability.md @@ -22,13 +22,13 @@ Grafana will now persist all long term data in the database. How to configure th ## Alerting high availability -Grafana alerting provides a new [highly-available model]({{< relref "../alerting/unified-alerting/high-availability/_index.md" >}}). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time. +Grafana alerting provides a new [highly-available model]({{< relref "../alerting/high-availability/_index.md" >}}). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time. -For instructions on setting up alerting high availability, see [enable alerting high availability]({{< relref "../alerting/unified-alerting/high-availability/enable-alerting-ha.md" >}}). +For instructions on setting up alerting high availability, see [enable alerting high availability](https://grafana.com/docs/grafana/next/alerting/old-alerting/notifications/). **Legacy dashboard alerts** -Legacy Grafana alerting supports a limited form of high availability. In this model, [alert notifications]({{< relref "../alerting/old-alerting/notifications.md" >}}) are deduplicated when running multiple servers. This means all alerts are executed on every server, but alert notifications are only sent once per alert. Grafana does not support load distribution between servers. +Legacy Grafana alerting supports a limited form of high availability. In this model, [alert notifications](https://grafana.com/docs/grafana/next/alerting/old-alerting/notifications/) are deduplicated when running multiple servers. This means all alerts are executed on every server, but alert notifications are only sent once per alert. Grafana does not support load distribution between servers. ## Grafana Live diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index 54c7bfb19c2..5a9a396a5ca 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -1,35 +1,36 @@ +++ title = "Alerts" -weight = 110 +weight = 455 +aliases = ["/docs/grafana/latest/alerting/"] +++ # Grafana alerts -Alerts allow you to learn about problems in your systems moments after they occur. Robust and actionable alerts help you identify and resolve issues quickly, minimizing disruption to your services. - -Grafana 8.0 introduced new and improved alerting that centralizes alerting information in a single, searchable view. It allows you to: +Grafana alerts allow you to learn about problems in your systems moments after they occur. Robust and actionable alerts help you identify and resolve issues quickly, minimizing disruption to your services. It centralizes alerting information in a single, searchable view that allows you to: - Create and manage Grafana alerts - Create and manage Grafana Mimir and Loki managed alerts - View alerting information from Prometheus and Alertmanager compatible data sources -Grafana alerting is enabled by default for new OSS installations. For older installations, it is still an [opt-in]({{< relref "./unified-alerting/opt-in.md" >}}) feature. +For new installations or existing installs without alerting configured, Grafana alerting is enabled by default. -| Release | Cloud | Enterprise | OSS | -| ------------------------ | ------------- | ------------- | -------------------------------- | -| Grafana 8.2 | On by default | Opt-in | Opt-in | -| Grafana 8.3 | On by default | Opt-in | On by default for new installs\* | -| Grafana 9.0 (unreleased) | On by default | On by default | On by default | +| Release | Cloud | Enterprise | OSS | +| ----------- | ------------- | ------------- | ------------- | +| Grafana 9.0 | On by default | On by default | On by default | -> **Note:** New installs include existing installs which do not have any alerts configured. +- For existing OSS installations with legacy dashboard alerting, you can [opt-in]({{< relref "./opt-in.md" >}}) to Grafana alerting. +- For Grafana Cloud instances using legacy cloud alerting, contact customer support to migrate to Grafana alerting. -Grafana alerting has four key components: +Before you begin, we recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "./fundamentals/_index.md" >}}) of Grafana alerting. Refer to [Fine-grained access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to learn more about controlling access to alerts using fine-grained permissions. -- Alerting rule - Evaluation criteria that determine whether an alert will fire. It consists of one or more queries and expressions, a condition, the frequency of evaluation, and optionally, the duration over which the condition is met. -- Contact point - Channel for sending notifications when the conditions of an alerting rule are met. -- Notification policy - Set of matching and grouping criteria used to determine where and how frequently to send notifications. -- Silences - Date and matching criteria used to silence notifications. - -To learn more, see [What's New with Grafana alerting]({{< relref "../alerting/unified-alerting/difference-old-new.md" >}}). - -For information on how to create and manage Grafana alerts and notifications, refer to [Overview of Grafana alerts]({{< relref "../alerting/unified-alerting/_index.md" >}}) and [Create and manage Grafana alerting rules]({{< relref "./unified-alerting/alerting-rules/_index.md" >}}). +- [What's new in Grafana alerting]({{< relref "./difference-old-new.md" >}}) +- [Enable Grafana alerting in OSS]({{< relref "./opt-in.md" >}}) +- [Migrating legacy alerts]({{< relref "./migrating-legacy-alerts.md" >}}) +- [Create Grafana managed alerting rules]({{< relref "alerting-rules/create-grafana-managed-rule.md" >}}) +- [Create Grafana Mimir or Loki managed alerting rules]({{< relref "alerting-rules/create-mimir-loki-managed-rule.md" >}}) +- [View existing alerting rules and manage their current state]({{< relref "alerting-rules/rule-list.md" >}}) +- [View the state and health of alerting rules]({{< relref "./fundamentals/state-and-health.md" >}}) +- [View alert groupings]({{< relref "./alert-groups.md" >}}) +- [Add or edit an alert contact point]({{< relref "./contact-points.md" >}}) +- [Add or edit notification policies]({{< relref "./notifications/_index.md" >}}) +- [Add or edit silences]({{< relref "./silences.md" >}}) diff --git a/docs/sources/alerting/unified-alerting/alert-groups.md b/docs/sources/alerting/alert-groups.md similarity index 95% rename from docs/sources/alerting/unified-alerting/alert-groups.md rename to docs/sources/alerting/alert-groups.md index 8160174c3d1..d20c064ed1b 100644 --- a/docs/sources/alerting/unified-alerting/alert-groups.md +++ b/docs/sources/alerting/alert-groups.md @@ -3,6 +3,7 @@ title = "Alert groups" description = "Alert groups" keywords = ["grafana", "alerting", "alerts", "groups"] weight = 400 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alert-groups/"] +++ # Alert groups diff --git a/docs/sources/alerting/alerting-limitations.md b/docs/sources/alerting/alerting-limitations.md new file mode 100644 index 00000000000..21571f01137 --- /dev/null +++ b/docs/sources/alerting/alerting-limitations.md @@ -0,0 +1,10 @@ ++++ +title = "Limitations" +weight = 552 +aliases = ["/docs/grafana/latest/alerting/alerting-limitations/"] ++++ + +# Limitations + +- Grafana alerting system can retrieve rules from all available Prometheus, Loki, and Alertmanager data sources. It might not be able to fetch alerting rules from all other supported data sources at this time. +- We aim to support the latest two minor versions of both Prometheus and Alertmanager. We cannot guarantee that older versions will work. As an example, if the current Prometheus version is `2.31.1`, we support >= `2.29.0`. diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/_index.md b/docs/sources/alerting/alerting-rules/_index.md similarity index 91% rename from docs/sources/alerting/unified-alerting/alerting-rules/_index.md rename to docs/sources/alerting/alerting-rules/_index.md index 00dcf726d7b..f8906778823 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/_index.md +++ b/docs/sources/alerting/alerting-rules/_index.md @@ -1,6 +1,6 @@ +++ title = "Create and manage rules" -aliases = ["/docs/grafana/latest/alerting/rules/"] +aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/"] weight = 130 +++ diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/alert-annotation-label.md b/docs/sources/alerting/alerting-rules/alert-annotation-label.md similarity index 97% rename from docs/sources/alerting/unified-alerting/alerting-rules/alert-annotation-label.md rename to docs/sources/alerting/alerting-rules/alert-annotation-label.md index 0f421c3df99..19e72834f3d 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/alert-annotation-label.md +++ b/docs/sources/alerting/alerting-rules/alert-annotation-label.md @@ -3,6 +3,7 @@ title = "Annotations and labels for alerting rules" description = "Annotations and labels for alerting" keywords = ["grafana", "alerting", "guide", "rules", "create"] weight = 401 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/alert-annotation-label/"] +++ # Annotations and labels for alerting rules diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md similarity index 94% rename from docs/sources/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule.md rename to docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 56fb61fc26e..7d9b21e1e5b 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -3,6 +3,7 @@ title = "Create Grafana managed alert rule" description = "Create Grafana managed alert rule" keywords = ["grafana", "alerting", "guide", "rules", "create"] weight = 400 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule/"] +++ # Create a Grafana managed alerting rule @@ -20,7 +21,7 @@ Grafana allows you to create alerting rules that query one or more data sources, 1. In Step 2, add queries and expressions to evaluate. - Keep the default name or hover over and click the edit icon to change the name. - For queries, select a data source from the drop-down. - - Add one or more [queries]({{< relref "../../../panels/query-a-data-source/add-a-query.md" >}}) or [expressions]({{< relref "../../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). + - Add one or more [queries]({{< relref "../../panels/query-a-data-source/add-a-query.md" >}}) or [expressions]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). - For each expression, select either **Classic condition** to create a single alert rule, or choose from **Math**, **Reduce**, **Resample** options to generate separate alert for each series. For details on these options, see [Single and multi dimensional rule](#single-and-multi-dimensional-rule). - Click **Run queries** to verify that the query is successful. 1. In Step 3, add conditions. @@ -57,7 +58,7 @@ To generate a separate alert for each series, create a multi-dimensional rule. U #### Rule with classic condition -For more information, see [expressions documentation]({{< relref "../../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). +For more information, see [expressions documentation]({{< relref "../../panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md" >}}). ### No data and error handling diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md similarity index 93% rename from docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md rename to docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md index d56fb1a41cb..d0ca1870555 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md @@ -3,6 +3,8 @@ title = "Create Grafana Mimir or Loki managed recording rule" description = "Create Grafana Mimir or Loki managed recording rule" keywords = ["grafana", "alerting", "guide", "rules", "recording rules", "create"] weight = 400 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/"] + +++ # Create a Grafana Mimir or Loki managed recording rule diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md similarity index 96% rename from docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-rule.md rename to docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md index 416d4b8b3ea..2e1974e3fa2 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md @@ -2,7 +2,7 @@ title = "Create Grafana Mimir or Loki managed alert rule" description = "Create Grafana Mimir or Loki managed alerting rule" keywords = ["grafana", "alerting", "guide", "rules", "create"] -aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/"] +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-recording-rule/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/create-mimir-loki-managed-recording-rule/"] weight = 400 +++ diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group.md b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md similarity index 91% rename from docs/sources/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group.md rename to docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md index 992d58f2d73..f4ce26ca0b8 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group.md +++ b/docs/sources/alerting/alerting-rules/edit-mimir-loki-namespace-group.md @@ -3,6 +3,7 @@ title = "Grafana Mimir or Loki rule groups and namespaces" description = "Edit Grafana Mimir or Loki rule groups and namespaces" keywords = ["grafana", "alerting", "guide", "group", "namespace", "grafana mimir", "loki"] weight = 405 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-mimir-loki-namespace-group/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/edit-cortex-loki-namespace-group/"] +++ # Grafana Mimir or Loki rule groups and namespaces diff --git a/docs/sources/alerting/unified-alerting/alerting-rules/rule-list.md b/docs/sources/alerting/alerting-rules/rule-list.md similarity index 97% rename from docs/sources/alerting/unified-alerting/alerting-rules/rule-list.md rename to docs/sources/alerting/alerting-rules/rule-list.md index 3a4213c8298..e18858600b3 100644 --- a/docs/sources/alerting/unified-alerting/alerting-rules/rule-list.md +++ b/docs/sources/alerting/alerting-rules/rule-list.md @@ -3,6 +3,7 @@ title = "Manage alerting rules" description = "Manage alerting rules" keywords = ["grafana", "alerting", "guide", "rules", "view"] weight = 402 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/alerting-rules/rule-list/"] +++ # Manage alerting rules diff --git a/docs/sources/alerting/unified-alerting/contact-points.md b/docs/sources/alerting/contact-points.md similarity index 98% rename from docs/sources/alerting/unified-alerting/contact-points.md rename to docs/sources/alerting/contact-points.md index d1b53e98807..f955e8860ed 100644 --- a/docs/sources/alerting/unified-alerting/contact-points.md +++ b/docs/sources/alerting/contact-points.md @@ -3,13 +3,14 @@ title = "Contact points" description = "Create or edit contact point" keywords = ["grafana", "alerting", "guide", "contact point", "notification channel", "create"] weight = 430 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/contact-points/"] +++ # Contact points Use contact points to define how your contacts are notified when an alert fires. A contact point can have one or more contact point types, for example, email, slack, webhook, and so on. When an alert fires, a notification is sent to all contact point types listed for a contact point. Optionally, use [message templates]({{< relref "./message-templating/_index.md" >}}) to customize notification messages for the contact point types. -You can configure Grafana managed contact points as well as contact points for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "./fundamentals/alertmanager.md" >}}). +You can configure Grafana managed contact points as well as contact points for an [external Alertmanager data source]({{< relref "../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "./fundamentals/alertmanager.md" >}}). ## Add a contact point @@ -60,7 +61,7 @@ To edit global configuration options for an external Alertmanager, like SMTP ser 1. Add global configuration settings. 1. Click **Save global config** to save your changes. -> **Note** This option is available only for external Alertmanagers. You can configure some global options for Grafana contact types, like email settings, via [Grafana configuration]({{< relref "../../administration/configuration.md" >}}). +> **Note** This option is available only for external Alertmanagers. You can configure some global options for Grafana contact types, like email settings, via [Grafana configuration]({{< relref "../administration/configuration.md" >}}). ## List of notifiers supported by Grafana diff --git a/docs/sources/alerting/unified-alerting/difference-old-new.md b/docs/sources/alerting/difference-old-new.md similarity index 96% rename from docs/sources/alerting/unified-alerting/difference-old-new.md rename to docs/sources/alerting/difference-old-new.md index 05b00763ff0..3018f2e5df0 100644 --- a/docs/sources/alerting/unified-alerting/difference-old-new.md +++ b/docs/sources/alerting/difference-old-new.md @@ -2,7 +2,8 @@ title = "What's new in Grafana alerting" description = "What's New with Grafana alerts" keywords = ["grafana", "alerting", "guide"] -weight = 114 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/difference-old-new/"] +weight = 108 +++ # What's new in Grafana alerting diff --git a/docs/sources/alerting/unified-alerting/fundamentals/_index.md b/docs/sources/alerting/fundamentals/_index.md similarity index 73% rename from docs/sources/alerting/unified-alerting/fundamentals/_index.md rename to docs/sources/alerting/fundamentals/_index.md index 4b1cddeb243..f46be80b976 100644 --- a/docs/sources/alerting/unified-alerting/fundamentals/_index.md +++ b/docs/sources/alerting/fundamentals/_index.md @@ -1,7 +1,7 @@ +++ title = "Alerting fundamentals" -aliases = ["/docs/grafana/latest/alerting/metrics/"] -weight = 120 +weight = 110 +aliases = ["/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/"] +++ # Alerting fundamentals diff --git a/docs/sources/alerting/unified-alerting/fundamentals/alertmanager.md b/docs/sources/alerting/fundamentals/alertmanager.md similarity index 88% rename from docs/sources/alerting/unified-alerting/fundamentals/alertmanager.md rename to docs/sources/alerting/fundamentals/alertmanager.md index 1b8169c086c..8b7d1a21e3d 100644 --- a/docs/sources/alerting/unified-alerting/fundamentals/alertmanager.md +++ b/docs/sources/alerting/fundamentals/alertmanager.md @@ -1,6 +1,6 @@ +++ title = "Alertmanager" -aliases = ["/docs/grafana/latest/alerting/metrics/"] +aliases = ["/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/alertmanager/"] weight = 116 +++ @@ -12,7 +12,7 @@ Grafana includes built-in support for Prometheus Alertmanager. By default, notif > **Note:** Before v8.2, the configuration of the embedded Alertmanager was shared across organizations. If you are on an older Grafana version, we recommend that you use Grafana alerts only if you have one organization. Otherwise, your contact points are visible to all organizations. -Grafana alerting added support for external Alertmanager configuration. When you add an [Alertmanager data source]({{< relref "../../../datasources/alertmanager.md" >}}), the Alertmanager drop-down shows a list of available external Alertmanager data sources. Select a data source to create and manage alerting for standalone Grafana Mimir or Loki data sources. +Grafana alerting added support for external Alertmanager configuration. When you add an [Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}), the Alertmanager drop-down shows a list of available external Alertmanager data sources. Select a data source to create and manage alerting for standalone Grafana Mimir or Loki data sources. {{< figure max-width="40%" src="/static/img/docs/alerting/unified/contact-points-select-am-8-0.gif" max-width="250px" caption="Select Alertmanager" >}} diff --git a/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md similarity index 89% rename from docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md rename to docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md index 8509319f4d5..772260ed567 100644 --- a/docs/sources/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts.md +++ b/docs/sources/alerting/fundamentals/evaluate-grafana-alerts.md @@ -1,6 +1,6 @@ +++ title = "Alerting on numeric data" -aliases = ["/docs/grafana/latest/alerting/metrics/"] +aliases = ["/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/unified-alerting/fundamentals/evaluate-grafana-alerts/"] weight = 116 +++ @@ -8,8 +8,12 @@ weight = 116 This topic describes how Grafana managed alerts are evaluated by the backend engine as well as how Grafana handles alerting on numeric rather than time series data. -- [Alert evaluation](#alert-evaluation) - [Alerting on numeric data](#alerting-on-numeric-data) + - [Alert evaluation](#alert-evaluation) + - [Metrics from the alerting engine](#metrics-from-the-alerting-engine) + - [Alerting on numeric data](#alerting-on-numeric-data-1) + - [Tabular Data](#tabular-data) + - [Example](#example) ## Alert evaluation @@ -17,11 +21,11 @@ Grafana managed alerts query the following backend data sources that have alerti - built-in data sources or those developed and maintained by Grafana: `Graphite`, `Prometheus`, `Loki`, `InfluxDB`, `Elasticsearch`, `Google Cloud Monitoring`, `Cloudwatch`, `Azure Monitor`, `MySQL`, `PostgreSQL`, `MSSQL`, `OpenTSDB`, `Oracle`, and `Azure Monitor` -- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../../developers/plugins/metadata.md" >}})) +- community developed backend data sources with alerting enabled (`backend` and `alerting` properties are set in the [plugin.json]({{< relref "../../developers/plugins/metadata.md" >}})) ### Metrics from the alerting engine -The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../../administration/view-server/internal-metrics.md" >}}). See also, [View alert rules and their current state]({{< relref "../alerting-rules/rule-list.md" >}}). +The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../administration/view-server/internal-metrics.md" >}}). See also, [View alert rules and their current state]({{< relref "../alerting-rules/rule-list.md" >}}). | Metric Name | Type | Description | | ------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------- | diff --git a/docs/sources/alerting/unified-alerting/fundamentals/state-and-health.md b/docs/sources/alerting/fundamentals/state-and-health.md similarity index 100% rename from docs/sources/alerting/unified-alerting/fundamentals/state-and-health.md rename to docs/sources/alerting/fundamentals/state-and-health.md diff --git a/docs/sources/alerting/unified-alerting/high-availability/_index.md b/docs/sources/alerting/high-availability/_index.md similarity index 97% rename from docs/sources/alerting/unified-alerting/high-availability/_index.md rename to docs/sources/alerting/high-availability/_index.md index fc1a07a33ea..c0f7a667c7f 100644 --- a/docs/sources/alerting/unified-alerting/high-availability/_index.md +++ b/docs/sources/alerting/high-availability/_index.md @@ -1,8 +1,9 @@ +++ -title = " About alerting high availability" +title = " Alerting high availability" description = "High availability" keywords = ["grafana", "alerting", "tutorials", "ha", "high availability"] aliases = ["/docs/grafana/latest/alerting/unified-alerting/high-availability/"] + weight = 450 +++ diff --git a/docs/sources/alerting/unified-alerting/high-availability/enable-alerting-ha.md b/docs/sources/alerting/high-availability/enable-alerting-ha.md similarity index 100% rename from docs/sources/alerting/unified-alerting/high-availability/enable-alerting-ha.md rename to docs/sources/alerting/high-availability/enable-alerting-ha.md diff --git a/docs/sources/alerting/unified-alerting/message-templating/_index.md b/docs/sources/alerting/message-templating/_index.md similarity index 97% rename from docs/sources/alerting/unified-alerting/message-templating/_index.md rename to docs/sources/alerting/message-templating/_index.md index 10a97c30480..92f3a4da3b1 100644 --- a/docs/sources/alerting/unified-alerting/message-templating/_index.md +++ b/docs/sources/alerting/message-templating/_index.md @@ -1,8 +1,8 @@ +++ title = "Message templating" description = "Message templating" -aliases = ["/docs/grafana/latest/alerting/message-templating/"] keywords = ["grafana", "alerting", "guide", "contact point", "templating"] +aliases = ["/docs/grafana/latest/alerting/message-templating/", "/docs/grafana/latest/alerting/unified-alerting/message-templating/"] weight = 440 +++ diff --git a/docs/sources/alerting/unified-alerting/message-templating/template-data.md b/docs/sources/alerting/message-templating/template-data.md similarity index 98% rename from docs/sources/alerting/unified-alerting/message-templating/template-data.md rename to docs/sources/alerting/message-templating/template-data.md index 22423f59090..08cd2ed9517 100644 --- a/docs/sources/alerting/unified-alerting/message-templating/template-data.md +++ b/docs/sources/alerting/message-templating/template-data.md @@ -1,6 +1,7 @@ +++ title = "Template data" keywords = ["grafana", "alerting", "guide", "contact point", "templating"] +aliases = ["/docs/grafana/latest/alerting/unified-alerting/message-templating/template-data/"] +++ # Template data diff --git a/docs/sources/alerting/unified-alerting/message-templating/template-functions.md b/docs/sources/alerting/message-templating/template-functions.md similarity index 98% rename from docs/sources/alerting/unified-alerting/message-templating/template-functions.md rename to docs/sources/alerting/message-templating/template-functions.md index b018418b5fd..1b8d773d8a7 100644 --- a/docs/sources/alerting/unified-alerting/message-templating/template-functions.md +++ b/docs/sources/alerting/message-templating/template-functions.md @@ -1,6 +1,7 @@ +++ title = "Template functions" keywords = ["grafana", "alerting", "guide", "contact point", "templating"] +aliases = ["/docs/grafana/latest/alerting/unified-alerting/message-templating/template-functions/"] +++ # Template Functions diff --git a/docs/sources/alerting/unified-alerting/opt-in.md b/docs/sources/alerting/migrating-legacy-alerts.md similarity index 52% rename from docs/sources/alerting/unified-alerting/opt-in.md rename to docs/sources/alerting/migrating-legacy-alerts.md index 1618d8cdeb6..b33e8c58d77 100644 --- a/docs/sources/alerting/unified-alerting/opt-in.md +++ b/docs/sources/alerting/migrating-legacy-alerts.md @@ -1,35 +1,13 @@ +++ -title = "Opt-in to Grafana alerting" +title = "Migrating legacy alerts" description = "Enable Grafana alerts" -weight = 115 +weight = 114 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/opt-in/"] +++ -# Opt-in to Grafana alerting +# Migrating legacy alerts to Grafana alerting -Grafana alerting is enabled by default for new Cloud and OSS installations. - -**Note:** If you are an existing Grafana Cloud user and want to explore unified alerting, contact Grafana Support. They will enable unified alerting for your Cloud stack. - -For older OSS installations that use legacy dashboard alerts, unified alerting is still an opt-in feature. This topic describes how to opt-in to Grafana alerting if you have an existing Grafana installation and the rules and restrictions that govern the migration of existing dashboard alerts to the new alerting system. You can [disable Grafana alerts]({{< relref "./opt-in.md#disable-grafana-alerts" >}}) and use the legacy dashboard alerting if needed. - -Before you begin, we recommend that you backup Grafana's database. If you are using PostgreSQL as the backend database, then the minimum required version is 9.5. - -## Enable Grafana alerting - -To enable Grafana alerts: - -1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [unified alerts]({{< relref "../../administration/configuration.md#unified_alerting" >}}) section. -1. Set the `enabled` property to `true`. -1. Next, for [legacy dashboard alerting]({{< relref "../../administration/configuration.md#alerting" >}}), set the `enabled` flag to `false`. -1. Restart Grafana for the configuration changes to take effect. - -> **Note:** The `ngalert` toggle previously used to enable or disable Grafana alerting is no longer available. - -Before v8.2, notification logs and silences were stored on a disk. If you did not use persistent disks, you would have lost any configured silences and logs on a restart, resulting in unwanted or duplicate notifications. We no longer require the use of a persistent disk. Instead, the notification logs and silences are stored regularly (every 15 minutes). If you used the file-based approach, Grafana reads the existing file and persists it eventually. - -## Migrating legacy alerts to Grafana alerting system - -When Grafana alerting is enabled or Grafana is upgraded to version 8.3, existing legacy dashboard alerts migrate in a format compatible with the Grafana alerting. In the Alerting page of your Grafana instance, you can view the migrated alerts alongside new alerts. +When Grafana alerting is enabled or Grafana is upgraded to the latest version, existing legacy dashboard alerts migrate in a format compatible with the Grafana alerting. In the Alerting page of your Grafana instance, you can view the migrated alerts alongside new alerts. Read and write access to legacy dashboard alerts and Grafana alerts are governed by the permissions of the folders storing them. During migration, legacy dashboard alert permissions are matched to the new rules permissions as follows: @@ -52,9 +30,9 @@ Grafana alerting system can retrieve rules from all available Prometheus, Loki, To disable Grafana alerts and enable legacy dashboard alerts: -1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../../administration/configuration.md#unified_alerting" >}}) section. +1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. 1. Set the `enabled` property to `false`. -1. For [legacy dashboard alerting]({{< relref "../../administration/configuration.md#alerting" >}}), set the `enabled` flag to `true`. +1. For [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `true`. 1. Restart Grafana for the configuration changes to take effect. > **Note:** Switching from one flavor of alerting to another can result in data loss. This is applicable to the fresh installation as well as upgraded setups. diff --git a/docs/sources/alerting/unified-alerting/notifications/_index.md b/docs/sources/alerting/notifications/_index.md similarity index 97% rename from docs/sources/alerting/unified-alerting/notifications/_index.md rename to docs/sources/alerting/notifications/_index.md index 3a263fb8143..90ad217b90f 100644 --- a/docs/sources/alerting/unified-alerting/notifications/_index.md +++ b/docs/sources/alerting/notifications/_index.md @@ -3,13 +3,14 @@ title = "Notification policies" description = "Notification policies" keywords = ["grafana", "alerting", "guide", "notification policies", "routes"] weight = 450 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/notifications/"] +++ # Notification policies Notification policies determine how alerts are routed to contact points. Policies have a tree structure, where each policy can have one or more child policies. Each policy, except for the root policy, can also match specific alert labels. Each alert is evaluated by the root policy and subsequently by each child policy. If you enable the `Continue matching subsequent sibling nodes` option is enabled for a specific policy, then evaluation continues even after one or more matches. A parent policy’s configuration settings and contact point information govern the behavior of an alert that does not match any of the child policies. A root policy governs any alert that does not match a specific policy. -You can configure Grafana managed notification policies as well as notification policies for an [external Alertmanager data source]({{< relref "../../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed notification policies as well as notification policies for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). ## Grouping diff --git a/docs/sources/alerting/unified-alerting/notifications/mute-timings.md b/docs/sources/alerting/notifications/mute-timings.md similarity index 94% rename from docs/sources/alerting/unified-alerting/notifications/mute-timings.md rename to docs/sources/alerting/notifications/mute-timings.md index 411f9fdb479..73f4a5e9581 100644 --- a/docs/sources/alerting/unified-alerting/notifications/mute-timings.md +++ b/docs/sources/alerting/notifications/mute-timings.md @@ -3,6 +3,7 @@ title = "Mute timings" description = "Mute timings" keywords = ["grafana", "alerting", "guide", "mute", "mute timings", "mute time interval"] weight = 450 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/notifications/mute-timings/"] +++ # Mute timings @@ -11,7 +12,7 @@ A mute timing is a recurring interval of time when no new notifications for a po Similar to silences, mute timings do not prevent alert rules from being evaluated, nor do they stop alert instances from being shown in the user interface. They only prevent notifications from being created. -You can configure Grafana managed mute timings as well as mute timings for an [external Alertmanager data source]({{< relref "../../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "../fundamentals/alertmanager.md" >}}). +You can configure Grafana managed mute timings as well as mute timings for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager documentation]({{< relref "../fundamentals/alertmanager.md" >}}). ## Mute timings vs silences diff --git a/docs/sources/alerting/opt-in.md b/docs/sources/alerting/opt-in.md new file mode 100644 index 00000000000..e7484552a1d --- /dev/null +++ b/docs/sources/alerting/opt-in.md @@ -0,0 +1,41 @@ ++++ +title = "Opt-in to Grafana alerting" +description = "Enable Grafana alerts" +weight = 113 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/opt-in/"] ++++ + +# Opt-in to Grafana alerting in OSS + +Grafana alerting is enabled by default for new Cloud and OSS installations. + +- For existing OSS installations that use legacy dashboard alerts, unified alerting is still an opt-in feature. +- For existing Grafana Cloud users, contact customer support to enable Grafana alerting for your Cloud stack. + +## Before you begin + +We recommend that you backup Grafana's database. If you are using PostgreSQL as the backend database, then the minimum required version is 9.5. + +## Enable Grafana alerting + +To enable Grafana alerts: + +1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [unified alerts]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. +2. Set the `enabled` property to `true`. +3. Next, for [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `false`. +4. Restart Grafana for the configuration changes to take effect. + +> **Note:** The `ngalert` toggle previously used to enable or disable Grafana alerting is no longer available. + +Before v8.2, notification logs and silences were stored on a disk. If you did not use persistent disks, you would have lost any configured silences and logs on a restart, resulting in unwanted or duplicate notifications. We no longer require the use of a persistent disk. Instead, the notification logs and silences are stored regularly (every 15 minutes). If you used the file-based approach, Grafana reads the existing file and persists it eventually. + +## Disable Grafana alerts + +To disable Grafana alerts and roll back to legacy dashboard alerting: + +1. In your custom configuration file ($WORKING_DIR/conf/custom.ini), go to the [Grafana alerting]({{< relref "../administration/configuration.md#unified_alerting" >}}) section. +1. Set the `enabled` property to `false`. +1. For [legacy dashboard alerting]({{< relref "../administration/configuration.md#alerting" >}}), set the `enabled` flag to `true`. +1. Restart Grafana for the configuration changes to take effect. + +> **Note:** Switching from one flavor of alerting to another can result in data loss. This is applicable to the fresh installation as well as upgraded setups. diff --git a/docs/sources/alerting/unified-alerting/silences.md b/docs/sources/alerting/silences.md similarity index 91% rename from docs/sources/alerting/unified-alerting/silences.md rename to docs/sources/alerting/silences.md index 6804cd6fddc..fc090985204 100644 --- a/docs/sources/alerting/unified-alerting/silences.md +++ b/docs/sources/alerting/silences.md @@ -3,6 +3,7 @@ title = "Silences" description = "Silences alert notifications" keywords = ["grafana", "alerting", "silence", "mute"] weight = 400 +aliases = ["/docs/grafana/latest/alerting/unified-alerting/silences/"] +++ # Silences @@ -11,7 +12,7 @@ Use silences to stop notifications from one or more alerting rules. Silences do Silences do not prevent alert rules from being evaluated. They also do not stop alert instances being shown in the user interface. Silences only prevent notifications from being created. -You can configure Grafana managed silences as well as silences for an [external Alertmanager data source]({{< relref "../../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "./fundamentals/alertmanager.md" >}}). +You can configure Grafana managed silences as well as silences for an [external Alertmanager data source]({{< relref "../datasources/alertmanager.md" >}}). For more information, see [Alertmanager]({{< relref "./fundamentals/alertmanager.md" >}}). > **Note:** Before Grafana v8.2, the configuration of the embedded Alertmanager was shared across organisations. Users of Grafana 8.0 and 8.1 are advised to use the new Grafana 8 Alerts only if they have one organisation. Otherwise, silences for the Grafana managed alerts will be visible by all organizations. @@ -61,4 +62,4 @@ When linking to a silence form, provide the default matching labels and comment For example, to link to silence form with matching labels `severity=critical` & `cluster!~europe-.*` and comment `Silence critical EU alerts`, create a URL `https://mygrafana/alerting/silence/new?matchers=severity%3Dcritical%2Ccluster!~europe-*&comment=Silence%20critical%20EU%20alert`. -To link to a new silence page for an [external Alertmanager]({{< relref "../../datasources/alertmanager.md" >}}), add a `alertmanager` query parameter with the Alertmanager data source name. +To link to a new silence page for an [external Alertmanager]({{< relref "../datasources/alertmanager.md" >}}), add a `alertmanager` query parameter with the Alertmanager data source name. diff --git a/docs/sources/alerting/unified-alerting/_index.md b/docs/sources/alerting/unified-alerting/_index.md deleted file mode 100644 index 0dc5778ef3d..00000000000 --- a/docs/sources/alerting/unified-alerting/_index.md +++ /dev/null @@ -1,28 +0,0 @@ -+++ -title = "Grafana alerts" -aliases = ["/docs/grafana/latest/alerting/metrics/"] -weight = 113 -+++ - -# Overview of Grafana alerting - -Grafana 8.0 has new and improved alerting that centralizes alerting information in a single, searchable view. It is enabled by default for all new OSS instances, and is an [opt-in]({{< relref "./opt-in.md" >}}) feature for older installations that still use legacy dashboard alerting. We encourage you to create issues in the Grafana GitHub repository for bugs found while testing Grafana alerting. See also, [What's New with Grafana alerting]({{< relref "./difference-old-new.md" >}}). - -> Refer to [Fine-grained access control]({{< relref "../../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to learn more about controlling access to alerts using fine-grained permissions. - -When Grafana alerting is enabled, you can: - -- [Create Grafana managed alerting rules]({{< relref "alerting-rules/create-grafana-managed-rule.md" >}}) -- [Create Grafana Mimir or Loki managed alerting rules]({{< relref "alerting-rules/create-mimir-loki-managed-rule.md" >}}) -- [View existing alerting rules and manage their current state]({{< relref "alerting-rules/rule-list.md" >}}) -- [View the state and health of alerting rules]({{< relref "./fundamentals/state-and-health.md" >}}) -- [Add or edit an alert contact point]({{< relref "./contact-points.md" >}}) -- [Add or edit notification policies]({{< relref "./notifications/_index.md" >}}) -- [Add or edit silences]({{< relref "./silences.md" >}}) - -Before you begin using Grafana alerting, we recommend that you familiarize yourself with some [basic concepts]({{< relref "./fundamentals/_index.md" >}}) of Grafana alerting. - -## Limitations - -- The Grafana alerting system can retrieve rules from all available Prometheus, Loki, and Alertmanager data sources. It might not be able to fetch rules from other supported data sources. -- We aim to support the latest two minor versions of both Prometheus and Alertmanager. We cannot guarantee that older versions will work. As an example, if the current Prometheus version is `2.31.1`, we support >= `2.29.0`. diff --git a/docs/sources/basics/timeseries-dimensions.md b/docs/sources/basics/timeseries-dimensions.md index 1194915d04c..c1422122391 100644 --- a/docs/sources/basics/timeseries-dimensions.md +++ b/docs/sources/basics/timeseries-dimensions.md @@ -76,7 +76,7 @@ In this case the labels that represent the dimensions will have two keys based o > **Note:** More than one dimension is currently only supported in the Logs queries within the Azure Monitor service as of version 7.1. -> **Note:** Multiple dimensions are not supported in a way that maps to multiple alerts in Grafana, but rather they are treated as multiple conditions to a single alert. See the documentation on [creating alerts with multiple series]({{< relref "../alerting/old-alerting/create-alerts.md#multiple-series" >}}). +> **Note:** Multiple dimensions are not supported in a way that maps to multiple alerts in Grafana, but rather they are treated as multiple conditions to a single alert. For more information, see See the documentation on [creating alerts with multiple series]({{< relref "../alerting/alerting-rules/create-grafana-managed-rule.md#single-and-multi-dimensional-rule" >}}). ### Multiple values diff --git a/docs/sources/developers/plugins/backend/_index.md b/docs/sources/developers/plugins/backend/_index.md index 392f0047371..ee0bbed1e14 100644 --- a/docs/sources/developers/plugins/backend/_index.md +++ b/docs/sources/developers/plugins/backend/_index.md @@ -12,13 +12,13 @@ However, one limitation with these plugins are that they execute on the client-s We use the term _backend plugin_ to denote that a plugin has a backend component. Still, normally a backend plugin requires frontend components as well. This is for example true for backend data source plugins which normally need configuration and query editor components implemented for the frontend. -Data source plugins can be extended with a backend component. In the future we plan to support additional types and possibly new kinds of plugins, such as [notifiers for Grafana Alerting]({{< relref "../../../alerting/old-alerting/notifications.md" >}}) and custom authentication to name a few. +Data source plugins can be extended with a backend component. In the future we plan to support additional types and possibly new kinds of plugins, such as [notifiers for Grafana alerting]({{< relref "../../../alerting/notifications/_index.md" >}}) and custom authentication to name a few. ## Use cases for implementing a backend plugin The following examples gives you an idea of why you'd consider implementing a backend plugin: -- Enable [Grafana Alerting]({{< relref "../../../alerting" >}}) for data sources. +- Enable [Grafana alerting]({{< relref "../../../alerting" >}}) for data sources. - Connect to non-HTTP services that normally can't be connected to from a web browser, e.g. SQL database servers. - Keep state between users, e.g. query caching for data sources. - Use custom authentication methods and/or authorization checks that aren't supported in Grafana. diff --git a/docs/sources/enterprise/access-control/about-rbac.md b/docs/sources/enterprise/access-control/about-rbac.md index 46303b978b8..fec7532ee1a 100644 --- a/docs/sources/enterprise/access-control/about-rbac.md +++ b/docs/sources/enterprise/access-control/about-rbac.md @@ -55,13 +55,13 @@ Grafana Enterprise includes the ability for you to assign discrete fixed roles t Assign fixed roles when the basic roles do not meet your permission requirements. For example, you might want a user with the basic viewer role to also edit dashboards. Or, you might want anyone with the editor role to also add and manage users. Fixed roles provide users more granular access to create, view, and update the following Grafana resources: -- [Alerting]({{< relref "../../alerting/unified-alerting/_index.md">}}) +- [Alerting]({{< relref "../../alerting/_index.md">}}) - [Annotations]({{< relref "../../dashboards/annotations.md" >}}) - [API keys]({{< relref "../../administration/api-keys/_index.md" >}}) - [Dashboards and folders]({{< relref "../../dashboards/_index.md" >}}) - [Data sources]({{< relref "../../datasources/_index.md" >}}) - [Explore]({{< relref "../../explore/_index.md" >}}) -- [Folders]({{< relref "../../dashboards/dashboard_folders.md" >}}) +- [Folders]({{< relref "../../dashboards/dashboard-folders.md" >}}) - [LDAP]({{< relref "../../auth/ldap/_index.md" >}}) - [Licenses]({{< relref "../license/_index.md" >}}) - [Organizations]({{< relref "../../administration/manage-organizations/_index.md" >}}) diff --git a/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md b/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md index 3ff07b56894..4e16ec04569 100644 --- a/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md +++ b/docs/sources/enterprise/access-control/rbac-fixed-basic-role-definitions.md @@ -76,7 +76,7 @@ The following tables list permissions associated with basic and fixed roles. ### Alerting roles -If you [enable]({{< relref "../../alerting/unified-alerting/opt-in.md" >}}) Grafana Alerting, you can use predefined roles to manage user access to alert rules, alert instances, and alert notification settings and create custom roles to limit user access to alert rules in a folder. +If alerting is [enabled]({{< relref "../../alerting/opt-in.md" >}}), you can use predefined roles to manage user access to alert rules, alert instances, and alert notification settings and create custom roles to limit user access to alert rules in a folder. Access to Grafana alert rules is an intersection of many permissions: diff --git a/docs/sources/http_api/alerting.md b/docs/sources/http_api/alerting.md index 7cf58c95638..1ed7ae36663 100644 --- a/docs/sources/http_api/alerting.md +++ b/docs/sources/http_api/alerting.md @@ -7,9 +7,9 @@ aliases = ["/docs/grafana/latest/http_api/alerting/"] # Alerting API -> **Note:** This topic is relevant for the [legacy dashboard alerts]({{< relref "../alerting/old-alerting/_index.md" >}}) only. +> **Note:** This topic is relevant for the [legacy dashboard alerts](https://grafana.com/docs/grafana/latest/alerting/old-alerting/) only. -You can find Grafana 8 alerts API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana 8 alerts documentation]({{< relref "../alerting/unified-alerting/_index.md" >}}) for details on how to create and manage new alerts. +You can find Grafana alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana alerting alerts documentation]({{< relref "../alerting/_index.md" >}}) for details on how to create and manage new alerts. You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert. To create new alerts or modify them you need to update the dashboard JSON that contains the alerts. diff --git a/docs/sources/http_api/alerting_notification_channels.md b/docs/sources/http_api/alerting_notification_channels.md index 77edc08808c..380c60292cd 100644 --- a/docs/sources/http_api/alerting_notification_channels.md +++ b/docs/sources/http_api/alerting_notification_channels.md @@ -176,7 +176,7 @@ Content-Type: application/json ## Create notification channel -You can find the full list of [supported notifiers]({{< relref "../alerting/old-alerting/notifications/#list-of-supported-notifiers" >}}) on the alert notifiers page. +You can find the full list of [supported notifiers](https://grafana.com/docs/grafana/latest/alerting/old-alerting/notifications/) on the alert notifiers page. `POST /api/alert-notifications` diff --git a/docs/sources/http_api/folder.md b/docs/sources/http_api/folder.md index f6b5411030c..fc3071f1f9e 100644 --- a/docs/sources/http_api/folder.md +++ b/docs/sources/http_api/folder.md @@ -239,7 +239,7 @@ Content-Length: 97 Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted. -If [Grafana 8 Alerts]({{< relref "../alerting/unified-alerting/_index.md" >}}) are enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana 8 Alerts. However, if this parameter is set to `true` then it will delete any Grafana 8 Alerts under this folder. +If [Grafana alerting]({{< relref "../alerting/_index.md" >}}) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder. **Example Request**: diff --git a/docs/sources/image-rendering/_index.md b/docs/sources/image-rendering/_index.md index 93efc8bccde..43bf48a095c 100644 --- a/docs/sources/image-rendering/_index.md +++ b/docs/sources/image-rendering/_index.md @@ -8,7 +8,7 @@ weight = 55 # Image rendering -Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in [alert notifications]({{< relref "../alerting/old-alerting/notifications.md" >}}), [PDF export]({{< relref "../enterprise/export-pdf.md" >}}), and [Reporting]({{< relref "../enterprise/reporting.md" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../enterprise/" >}}). +Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in [alert notifications]({{< relref "../alerting/notifications/_index.md" >}}), [PDF export]({{< relref "../enterprise/export-pdf.md" >}}), and [Reporting]({{< relref "../enterprise/reporting.md" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../enterprise/" >}}). > **Note:** Image rendering of dashboards is not supported at this time. diff --git a/docs/sources/introduction/oss-details.md b/docs/sources/introduction/oss-details.md index fcea8cb3bc1..6e24d132225 100644 --- a/docs/sources/introduction/oss-details.md +++ b/docs/sources/introduction/oss-details.md @@ -18,9 +18,9 @@ Explore your data through ad-hoc queries and dynamic drilldown. Split view and c ## Alerts -If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/old-alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. +If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/contact-points.md#list-of-notifiers-supported-by-grafana" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. -Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/_index.md" >}}) for your most important metrics. +Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerting-rules/_index.md" >}}) for your most important metrics. ## Annotations diff --git a/docs/sources/alerting/old-alerting/_index.md b/docs/sources/old-alerting/_index.md similarity index 98% rename from docs/sources/alerting/old-alerting/_index.md rename to docs/sources/old-alerting/_index.md index 8d0cd673290..9a73cc89e57 100644 --- a/docs/sources/alerting/old-alerting/_index.md +++ b/docs/sources/old-alerting/_index.md @@ -1,6 +1,7 @@ +++ title = "Legacy Grafana Alerts" weight = 114 +draft = true +++ # Legacy Grafana alerts diff --git a/docs/sources/alerting/old-alerting/add-notification-template.md b/docs/sources/old-alerting/add-notification-template.md similarity index 99% rename from docs/sources/alerting/old-alerting/add-notification-template.md rename to docs/sources/old-alerting/add-notification-template.md index bafab9a4f9e..79d74e08fbf 100644 --- a/docs/sources/alerting/old-alerting/add-notification-template.md +++ b/docs/sources/old-alerting/add-notification-template.md @@ -3,6 +3,7 @@ title = "Alert notification templating" keywords = ["grafana", "documentation", "alerting", "alerts", "notification", "templating"] weight = 110 aliases = ["/docs/grafana/latest/alerting/add-notification-template/"] +draft = true +++ # Alert notification templating diff --git a/docs/sources/alerting/old-alerting/create-alerts.md b/docs/sources/old-alerting/create-alerts.md similarity index 99% rename from docs/sources/alerting/old-alerting/create-alerts.md rename to docs/sources/old-alerting/create-alerts.md index 49e9cfa4424..472ce16526c 100644 --- a/docs/sources/alerting/old-alerting/create-alerts.md +++ b/docs/sources/old-alerting/create-alerts.md @@ -4,6 +4,7 @@ description = "Configure alert rules" keywords = ["grafana", "alerting", "guide", "rules"] weight = 200 aliases = ["/docs/grafana/latest/alerting/create-alerts/"] +draft = true +++ # Create alerts diff --git a/docs/sources/alerting/old-alerting/notifications.md b/docs/sources/old-alerting/notifications.md similarity index 99% rename from docs/sources/alerting/old-alerting/notifications.md rename to docs/sources/old-alerting/notifications.md index 9bcf5bf025e..c4e95ee79ce 100644 --- a/docs/sources/alerting/old-alerting/notifications.md +++ b/docs/sources/old-alerting/notifications.md @@ -4,6 +4,7 @@ description = "Alerting notifications guide" keywords = ["Grafana", "alerting", "guide", "notifications"] weight = 100 aliases = ["/docs/grafana/latest/alerting/notifications/"] +draft = true +++ # Alert notifications diff --git a/docs/sources/alerting/old-alerting/pause-an-alert-rule.md b/docs/sources/old-alerting/pause-an-alert-rule.md similarity index 98% rename from docs/sources/alerting/old-alerting/pause-an-alert-rule.md rename to docs/sources/old-alerting/pause-an-alert-rule.md index b55c02bbab9..29e171606c2 100644 --- a/docs/sources/alerting/old-alerting/pause-an-alert-rule.md +++ b/docs/sources/old-alerting/pause-an-alert-rule.md @@ -4,6 +4,7 @@ description = "Pause an existing alert rule" keywords = ["grafana", "alerting", "guide", "rules", "view"] weight = 400 aliases = ["/docs/grafana/latest/alerting/pause-an-alert-rule/"] +draft = true +++ # Pause an alert rule diff --git a/docs/sources/alerting/old-alerting/troubleshoot-alerts.md b/docs/sources/old-alerting/troubleshoot-alerts.md similarity index 99% rename from docs/sources/alerting/old-alerting/troubleshoot-alerts.md rename to docs/sources/old-alerting/troubleshoot-alerts.md index ae15da619a1..d037faea0d7 100644 --- a/docs/sources/alerting/old-alerting/troubleshoot-alerts.md +++ b/docs/sources/old-alerting/troubleshoot-alerts.md @@ -4,6 +4,7 @@ description = "Troubleshoot alert rules" keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"] weight = 500 aliases = ["/docs/grafana/latest/alerting/troubleshoot-alerts/"] +draft = true +++ # Troubleshoot alerts diff --git a/docs/sources/alerting/old-alerting/view-alerts.md b/docs/sources/old-alerting/view-alerts.md similarity index 98% rename from docs/sources/alerting/old-alerting/view-alerts.md rename to docs/sources/old-alerting/view-alerts.md index 132b60b9110..af468d4b7be 100644 --- a/docs/sources/alerting/old-alerting/view-alerts.md +++ b/docs/sources/old-alerting/view-alerts.md @@ -4,6 +4,7 @@ description = "View existing alert rules" keywords = ["grafana", "alerting", "guide", "rules", "view"] weight = 400 aliases = ["/docs/grafana/latest/alerting/view-alerts/"] +draft = true +++ # View existing alert rules diff --git a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md index 9085d2a400e..91efea43f66 100644 --- a/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md +++ b/docs/sources/panels/query-a-data-source/use-expressions-to-manipulate-data/about-expressions.md @@ -12,7 +12,7 @@ Server-side expressions allow you to manipulate data returned from queries with ## Using expressions -Expressions are primarily used by the new [Grafana 8 alerts]({{< relref "../../../alerting/unified-alerting/_index.md" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization. +Expressions are primarily used by [Grafana alerting]({{< relref "../../../alerting/_index.md" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization. > **Note:** Expressions do not work with legacy dashboard alerts. diff --git a/docs/sources/panels/working-with-panels/navigate-panel-editor.md b/docs/sources/panels/working-with-panels/navigate-panel-editor.md index b39d212d71d..31ff4472764 100644 --- a/docs/sources/panels/working-with-panels/navigate-panel-editor.md +++ b/docs/sources/panels/working-with-panels/navigate-panel-editor.md @@ -27,7 +27,7 @@ This page describes the parts of the Grafana panel editor. - **Query tab -** Select your data source and enter queries here. For more information, refer to [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}). - **Transform tab -** Apply data transformations. For more information, refer to [Transform data]({{< relref "../transform-data/_index.md" >}}). - - **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../../alerting/unified-alerting/_index.md" >}}). + - **Alert tab -** Write alert rules. For more information, refer to [Overview of Grafana 8 alerting]({{< relref "../../alerting/_index.md" >}}). 4. Panel display options: The display options section contains tabs where you configure almost every aspect of your data visualization, including: diff --git a/docs/sources/whatsnew/whats-new-in-v7-4.md b/docs/sources/whatsnew/whats-new-in-v7-4.md index 267efa72fd4..2eecdc29f45 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-4.md +++ b/docs/sources/whatsnew/whats-new-in-v7-4.md @@ -107,7 +107,7 @@ You can now provide detailed information to alert notification recipients by inj {{< figure src="/static/img/docs/alerting/alert-notification-template-7-4.png" max-width="700px" caption="Variable support in alert notifications" >}} -For more information, refer to the [alert notification docs]({{< relref "../alerting/old-alerting/notifications.md#notification-templating" >}}). +For more information, refer to the [alert notification docs](https://grafana.com/docs/grafana/latest/alerting/old-alerting/add-notification-template/). ### Content security policy support diff --git a/docs/sources/whatsnew/whats-new-in-v8-0.md b/docs/sources/whatsnew/whats-new-in-v8-0.md index 568699193a0..97486fb05f6 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-0.md +++ b/docs/sources/whatsnew/whats-new-in-v8-0.md @@ -18,13 +18,13 @@ These features are included in the Grafana open source edition. ### Grafana v8.0 alerts -The new alerts in Grafana 8.0 are an opt-in feature that centralizes alerting information for Grafana managed alerts and alerts from Prometheus-compatible data sources in one UI and API. You can create and edit alerting rules for Grafana managed alerts, Cortex alerts, and Loki alerts as well as see alerting information from prometheus-compatible data sources in a single, searchable view. For more information, on how to create and edit alerts and notifications, refer to [Overview of Grafana 8.0 alerts]({{< relref "../alerting/unified-alerting/_index.md" >}}). +The new alerts in Grafana 8.0 are an opt-in feature that centralizes alerting information for Grafana managed alerts and alerts from Prometheus-compatible data sources in one UI and API. You can create and edit alerting rules for Grafana managed alerts, Cortex alerts, and Loki alerts as well as see alerting information from prometheus-compatible data sources in a single, searchable view. For more information, on how to create and edit alerts and notifications, refer to [Overview of Grafana 8.0 alerts]({{< relref "../alerting/_index.md" >}}). As part of the new alert changes, we have introduced a new data source, Alertmanager, which includes built-in support for Prometheus Alertmanager. It is presently in alpha and it not accessible unless alpha plugins are enabled in Grafana settings. For more information, refer to [Alertmanager data source]({{< relref "../datasources/alertmanager.md" >}}). > **Note:** Out of the box, Grafana still supports old Grafana alerts. They are legacy alerts at this time, and will be deprecated in a future release. -To learn more about the differences between new alerts and the legacy alerts, refer to [What's New with Grafana 8 Alerts]({{< relref "../alerting/unified-alerting/difference-old-new.md" >}}). +To learn more about the differences between new alerts and the legacy alerts, refer to [What's New with Grafana 8 Alerts]({{< relref "../alerting/difference-old-new.md" >}}). ### Library panels