mirror of https://github.com/grafana/grafana
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 prettierpull/48704/head
achatterjee-grafana
4 years ago
committed by
GitHub
parent
f00ffb190c
commit
082cfbdb06
@ -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. |
||||
|
||||
| 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 | |
||||
|
||||
> **Note:** New installs include existing installs which do not have any alerts configured. |
||||
For new installations or existing installs without alerting configured, Grafana alerting is enabled by default. |
||||
|
||||
Grafana alerting has four key components: |
||||
| Release | Cloud | Enterprise | OSS | |
||||
| ----------- | ------------- | ------------- | ------------- | |
||||
| Grafana 9.0 | On by default | On by default | On by default | |
||||
|
||||
- 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. |
||||
- 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. |
||||
|
||||
To learn more, see [What's New with Grafana alerting]({{< relref "../alerting/unified-alerting/difference-old-new.md" >}}). |
||||
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. |
||||
|
||||
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" >}}) |
||||
|
||||
@ -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`. |
||||
@ -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 |
||||
+++ |
||||
|
||||
@ -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 |
||||
@ -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 |
||||
+++ |
||||
|
||||
@ -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 |
||||
+++ |
||||
|
||||
@ -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 |
||||
@ -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 |
||||
@ -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. |
||||
@ -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`. |
||||
@ -1,6 +1,7 @@ |
||||
+++ |
||||
title = "Legacy Grafana Alerts" |
||||
weight = 114 |
||||
draft = true |
||||
+++ |
||||
|
||||
# Legacy Grafana alerts |
||||
Loading…
Reference in new issue