From 9aa440d7d45f08012fd62a9926df7d6f3ece3208 Mon Sep 17 00:00:00 2001 From: Armand Grillet <2117580+armandgrillet@users.noreply.github.com> Date: Tue, 21 Jun 2022 10:33:58 +0200 Subject: [PATCH] Clarify alerting opt-out docs (#51144) * Clarify alerting opt-out docs * Update docs/sources/alerting/migrating-alerts/opt-out.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/migrating-alerts/opt-out.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/migrating-alerts/opt-out.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/migrating-alerts/opt-out.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> --- .../alerting/migrating-alerts/opt-out.md | 50 ++++++++++--------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/docs/sources/alerting/migrating-alerts/opt-out.md b/docs/sources/alerting/migrating-alerts/opt-out.md index 49cf9e64fb7..685464bf766 100644 --- a/docs/sources/alerting/migrating-alerts/opt-out.md +++ b/docs/sources/alerting/migrating-alerts/opt-out.md @@ -10,12 +10,35 @@ weight: 102 # Opt out of Grafana Alerting -If you have an existing installation, you can opt out of alerting in its entirety or opt out of Grafana Alerting in favor of using legacy alerting. +You can opt out of Grafana Alerting at any time and switch to using legacy alerting. Alternatively, you can opt out of using alerting in its entirety. -Existing installations that do not use legacy alerting will have Grafana Alerting enabled by default unless alerting is disabled in the configuration. To keep alerting disabled: +## Staying on legacy alerting + +When upgrading to Grafana > 9.0, existing installations that use legacy alerting are automatically upgraded to Grafana Alerting unless you have opted-out of Grafana Alerting before migration takes place. During the upgrade, legacy alerts are migrated to the new alerts type and no alerts or alerting data are lost. To keep using legacy alerting and disable Grafana Alerting: 1. Go to your custom configuration file ($WORKING_DIR/conf/custom.ini). -1. Enter the following in your configuration: +2. Enter the following in your configuration: + +``` +[alerting] +enabled = true + +[unified_alerting] +enabled = false +``` + +Installations that have been migrated to Grafana Alerting can [roll back]({{< relref "roll-back/" >}}) to legacy alerting at any time. + +> **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. + +The `ngalert` toggle previously used to enable or disable Grafana Alerting is no longer available. + +## Disable alerting + +You can disable both Grafana Alerting and legacy alerting in Grafana. + +1. Go to your custom configuration file ($WORKING_DIR/conf/custom.ini). +2. Enter the following in your configuration: ``` [alerting] @@ -27,23 +50,4 @@ enabled = false 3. Restart Grafana for the configuration changes to take effect. -If at any time you want to turn alerting back on, you can do so. - -Existing installations that use legacy alerting will automatically be upgraded to Grafana Alerting unless you have opted-out of Grafana Alerting before migration takes place. During the upgrade, legacy alerts are migrated to the new alerts type and no alerts or alerting data are lost. To keep using legacy alerting and disable Grafana Alerting: - -1. Go to your custom configuration file ($WORKING_DIR/conf/custom.ini). -2. Enter the following in your configuration: - -``` -[alerting] -enabled = false - -[unified_alerting] -enabled = true -``` - -Installations that have been migrated to Grafana Alerting can [roll back]({{< relref "roll-back/" >}}) to legacy alerting at any time. - -> **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. - -The `ngalert` toggle previously used to enable or disable Grafana Alerting is no longer available. +If you want to turn alerting back on, you can remove both flags to enable Grafana Alerting.