Alerting: Disable legacy alerting for ever #83651
Conversation
yuri-tceretian
added
area/alerting
yuri-tceretian
requested review from
undef1nd,
suntala and
idafurjes
and removed request for
a team
|
FOREVER! |
yuri-tceretian
requested review from
torkelo,
imatwawana and
chri2547
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
yuri-tceretian
force-pushed
the
yuri-tceretian/disable-legacy-alerting
branch
from
ee7e23b
to
0b5877c
Compare
yuri-tceretian
force-pushed
the
yuri-tceretian/disable-legacy-alerting
branch
from
0b5877c
to
f226389
Compare
yuri-tceretian
force-pushed
the
yuri-tceretian/disable-legacy-alerting
branch
from
aae5e0c
to
ec98eca
Compare
keep annotations related to reduce possibility of data loss
yuri-tceretian
force-pushed
the
yuri-tceretian/disable-legacy-alerting
branch
from
ec98eca
to
9b96d3e
Compare
yuri-tceretian
requested review from
rwwiv,
JacobsonMT,
grobinson-grafana and
imatwawana
and removed request for
a team
| alerting := mg.Cfg.Raw.Section("alerting") | ||
| enabled, err := alerting.Key("enabled").Bool() | ||
| if err == nil && enabled { | ||
| mg.Logger.Error("Option [alerting].enabled cannot be true. Legacy alerting is no longer supported. Delete the option and use configuration '[unified_alerting].enabled' to enable Grafana Alerting and start from the scratch. Refer to documentation about migration to the new alerting (https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts)") |
There was a problem hiding this comment.
@brendamuir can you review the text here? It will be shown in the logs for users who upgrade to Grafana 11 but are still using legacy alerting in their configuration file.
yuri-tceretian
force-pushed
the
yuri-tceretian/disable-legacy-alerting
branch
from
e1d97cc
to
9b96d3e
Compare
pkg/setting/setting.go
Outdated
| if err == nil { | ||
| cfg.AlertingEnabled = &enabled | ||
| if err == nil && enabled { | ||
| cfg.Logger.Error("Option [alerting].enabled cannot be true. Legacy alerting is no longer supported. Delete the option and use configuration '[unified_alerting].enabled' to enable Grafana Alerting and start from the scratch. Refer to documentation about migration to the new alerting (https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts)") |
There was a problem hiding this comment.
@brendamuir can you please check if this message is informative enough?
There was a problem hiding this comment.
cfg.Logger.Error("Option [alerting].enabled cannot be true. Legacy Alerting is removed. It is no longer deployed, enhanced, or supported. Delete [alerting].enabled and use '[unified_alerting].enabled' to enable Grafana Alerting. For more information, refer to the documentation on upgrading to Grafana Alerting. (https://grafana.com/docs/grafana/latest/alerting/set-up/migrating-alerts)")
There was a problem hiding this comment.
- not sure about the first bit starting cfg.Logger - cannot be true. is that to appear in the message on the UI? do we need that bit?
- do we want to say delete xxx and use xxx to enable GA or would we rather say to upgrade to GA? not sure.
- We use "upgrade" in the docs-so would prob stick to using that rather than migrating?
There was a problem hiding this comment.
This will appear in the Grafana logs at start up, it won't be shown in the UI.
There was a problem hiding this comment.
ok reckon the above is ok then
There was a problem hiding this comment.
Brenda , thanks for the recommendation! One thing I would like to change. I am not sure that the article will exist in G11 because migration from legacy to UA will not be supported. I will put link https://grafana.com/docs/grafana/v10.4/alerting/set-up/migrating-alerts/ which does not exist yet but that will be the last verstion that offers migration.
There was a problem hiding this comment.
yes, ok. the plan is to still have a short one pager available just in case in the OSS docs - but add this one for now.
What is this feature?
This PR removes the ability to keep the legacy alerting enabled. If setting
[alerting].enabledis set to true, Grafana will refuse to start.It emits the error suggesting enabling Unified Alerting and performing migration if it's not yet.
Also, it removes the section
[alerting]from thedefault.ini,sample.ini, and documentation. These are not final changes for documentationWhy do we need this feature?
The first step is to remove legacy alerting.
Fixes #81268
Special notes for your reviewer:
Release notice breaking change
In Grafana 11 the legacy alerting reaches the end-of-life. Users cannot enable it and Grafana will refuse to start if the settings are not updated to run the new Grafana Alerting. Migration from legacy alerting is not available as well. Grafana 10.4.x is the last version that offers the migration.
If the setting
[alerting].enableis set totrueGrafana will not start and emit the log message with recommendations to change the configurationSetting
[alerting].max_annotation_ageis replaced by[unified_alerting.state_history.annotations].max_ageSetting
[alerting].max_annotations_to_keepis replaced by[unified_alerting.state_history.annotations].max_annotations_to_keepsetting
[unified_alerting].execute_alertsdoes not fall back to the legacy[alerting].execute_alertsanymore. Instead, the default valuetrueis used.setting
[unified_alerting].evaluation_timeoutdoes not fall back to the legacy setting[alerting].evaluation_timeout_secondsin the case when it is either invalid or has the default value. Now, if the setting is invalid, it will cause Grafana to exit.setting
[unified_alerting].min_intervaldoes not fall back to the legacy setting[alerting].min_interval_secondsin the case when it is either invalid or has the default value. Now, if the setting is invalid, it will cause Grafana to exit.