mirror of https://github.com/grafana/grafana
Docs: Created separate section for migration under alerting (#49616)
* Lots of changes, including new topic, also fixed all alerting relrefs * Push stashed change. * Updated content to reflect that Grafana alerting is enabled during upgrade. * Fix typo * Update docs/sources/alerting/migrating-alerts/_index.md Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> * Checkin changes. * Updates from Chris's review. Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>pull/49657/head
JitaC
3 years ago
committed by
GitHub
parent
df90393057
commit
b5d48d217a
@ -0,0 +1,26 @@ |
||||
+++ |
||||
aliases = ["/docs/grafana/latest/alerting/migrating-alerts/"] |
||||
description = "Migrate Grafana alerts" |
||||
title = "Migrate to Grafana alerting" |
||||
weight = 113 |
||||
+++ |
||||
|
||||
# Migrate to Grafana alerting |
||||
|
||||
Grafana alerting is the default for new Cloud, Enterprise, and OSS installations. The new installations will only show the Grafana alerting icon in the left navigation panel. |
||||
|
||||
Existing installations that upgrade to v9.0 will have Grafana alerting enabled by default. |
||||
|
||||
| Grafana instance upgraded to v 90 | | |
||||
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
||||
| Cloud | Existing Cloud installations with legacy dashboard alerting will have two alerting icons in the left navigation panel - the old alerting plugin icon and the new Grafana alerting icon. During upgrade, existing alerts from the Cloud alerting plugin are migrated to Grafana alerting. Once migration is complete, you can access aman manage the older alerts from the new alerting Grafana alerting icon in the navigation panel. The (older) Cloud alerting plugin is uninstalled from your cloud instance. Contact customer support if you **do not wish** to migrate to Grafana alerting for your Cloud stack. If you choose to use legacy alerting, use the You will see the new Grafana alerting icon as well as the old Cloud alerting plugin in the left navigation panel. | |
||||
| Enterprise | Existing Enterprise instances using legacy alerting will have both the old (marked as legacy) and the new alerting icons in the navigation panel. During upgrade, existing legacy alerts are migrated to Grafana alerting. If you wish, you can [opt-out]({{< relref "./opt-out.md" >}}) of Grafana alerting and roll back to legacy alerting. In that case, you can manage your legacy alerts from the alerting icon marked as legacy. | |
||||
| OSS | Existing OSS installations with legacy dashboard alerting will have two alerting icons in the left navigation panel - the old alerting icon (marked as legacy) and the new Grafana alerting icon. During upgrade, existing legacy alerts are migrated to Grafana alerting. If you wish, you can [opt-out]({{< relref "./opt-out.md" >}}) of Grafana alerting and roll back to legacy alerting. In that case, you can manage your legacy alerts from the alerting icon marked as legacy. | |
||||
|
||||
During migration from legacy alerting to unified alerting, the legacy alerts are updated to the new alerts type, as a result, the user does not lose alerts or alerting data. However, if a user rolls back to legacy alerting after having migrated to unified alerting, they will only get the legacy alerts they had right before migration. |
||||
|
||||
## Roll back to legacy alerting |
||||
|
||||
Although we encourage you to use Grafana alerting, roll back to legacy alerting is supported in Grafana 9. Rolling back can result in data loss (you will loose all alerts that you created using Grafana alerting). This is applicable to the fresh installation as well as upgraded setups. |
||||
|
||||
> **Note:** Legacy alerting will be deprecated in a future release (v10). |
||||
@ -0,0 +1,40 @@ |
||||
+++ |
||||
aliases = ["/docs/grafana/latest/alerting/opt-in/", "/docs/grafana/latest/alerting/unified-alerting/opt-in/"] |
||||
description = "Disable Grafana alerts" |
||||
title = "Opt-out of Grafana alerting" |
||||
weight = 113 |
||||
+++ |
||||
|
||||
# Opt-out to Grafana alerting in OSS |
||||
|
||||
This topic discusses how to disable Grafana alerting and migrate to legacy dashboard alerting. It also provides guidance on how to enable Grafana alerting once you are ready to migrate to Grafana alerting. |
||||
|
||||
> **Note:** This topic is only relevant for OSS and Enterprise customers. Contact customer support to enable or disable Grafana alerting for your Grafana 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. |
||||
|
||||
## Opt-out of Grafana alerts |
||||
|
||||
To opt-out of 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:** Rolling back from Grafana to legacy alerting can result in data loss. This is applicable to the fresh installation as well as upgraded setups. |
||||
|
||||
## Opt-in to Grafana alerting |
||||
|
||||
When you are ready to make the switch, the following procedure will help you migrate to Grafana alerting. |
||||
|
||||
To opt-in 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. |
||||
@ -1,41 +0,0 @@ |
||||
+++ |
||||
aliases = ["/docs/grafana/latest/alerting/opt-in/", "/docs/grafana/latest/alerting/unified-alerting/opt-in/"] |
||||
description = "Enable Grafana alerts" |
||||
title = "Opt-in to Grafana alerting" |
||||
weight = 113 |
||||
+++ |
||||
|
||||
# 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. |
||||
Loading…
Reference in new issue