Alerting: Fix provisioned templates being ignored by alertmanager #69485
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Template provisioning sets the template in cfg.TemplateFiles while a recent change made it so that alertmanager reads cfg.AlertmanagerConfig.Templates instead. This change fixes the issue on both ends, by having provisioning set boths fields and reverts the change on the alertmanager side so that it uses cfg.TemplateFiles.
| @@ -53,6 +53,7 @@ func (t *TemplateService) SetTemplate(ctx context.Context, orgID int64, tmpl def | |||
| revision.cfg.TemplateFiles = map[string]string{} | |||
| } | |||
| revision.cfg.TemplateFiles[tmpl.Name] = tmpl.Template | |||
| revision.cfg.AlertmanagerConfig.Templates = append(revision.cfg.AlertmanagerConfig.Templates, tmpl.Name) | |||
There was a problem hiding this comment.
This will also append each time a provisioned template is updated:
curl -H "Content-Type: application/json" -u admin:admin http://127.0.0.1:3000/api/v1/provisioning/templates/test -X PUT -d '{"name":"test","template":"hello1"}'
curl -H "Content-Type: application/json" -u admin:admin http://127.0.0.1:3000/api/v1/provisioning/templates/test -X PUT -d '{"name":"test","template":"hello2"}'
"templates": [
"test",
"test"
],
There was a problem hiding this comment.
I guess we might as well overwrite cfg.AlertmanagerConfig.Templates here with the current state of TemplateFiles since we'll do it during applyConfig anyways, WDYT?
There was a problem hiding this comment.
Yes I think so! I've noticed that sometimes deleted templates are removed from template_files and not templates, so it should fix both!
There was a problem hiding this comment.
What's the relationship between this and cfg.AlertmanagerConfig.Templates = paths on Line 269 of pkg/services/ngalert/notifier/alertmanager.go.
There was a problem hiding this comment.
This change is not technically required since we now do the same thing in pkg/services/ngalert/notifier/alertmanager.go, figured we might preempt future issues by just making this do both anyways. I can remove it if that's the preference.
grobinson-grafana
approved these changes
Jun 2, 2023
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-69485-to-v10.0.x origin/v10.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x c16f1f5e99def9e0136170605368ab33e31e80a1
# Push it to GitHub
git push --set-upstream origin backport-69485-to-v10.0.x
git switch main
# Remove the local backport branch
git branch -D backport-69485-to-v10.0.xThen, create a pull request where the |
grafanabot
added
the
backport-failed
JacobsonMT
added a commit
that referenced
this pull request
Jun 2, 2023
…9485) * Alerting: Fix provisioned templates being ignored by alertmanager Template provisioning sets the template in cfg.TemplateFiles while a recent change made it so that alertmanager reads cfg.AlertmanagerConfig.Templates instead. This change fixes the issue on both ends, by having provisioning set boths fields and reverts the change on the alertmanager side so that it uses cfg.TemplateFiles. (cherry picked from commit c16f1f5)
JacobsonMT
added a commit
that referenced
this pull request
Jun 2, 2023
…anager (#69488) Alerting: Fix provisioned templates being ignored by alertmanager (#69485) * Alerting: Fix provisioned templates being ignored by alertmanager Template provisioning sets the template in cfg.TemplateFiles while a recent change made it so that alertmanager reads cfg.AlertmanagerConfig.Templates instead. This change fixes the issue on both ends, by having provisioning set boths fields and reverts the change on the alertmanager side so that it uses cfg.TemplateFiles. (cherry picked from commit c16f1f5)
zerok
pushed a commit
that referenced
this pull request
Jun 22, 2023
…anager (#69488) Alerting: Fix provisioned templates being ignored by alertmanager (#69485) * Alerting: Fix provisioned templates being ignored by alertmanager Template provisioning sets the template in cfg.TemplateFiles while a recent change made it so that alertmanager reads cfg.AlertmanagerConfig.Templates instead. This change fixes the issue on both ends, by having provisioning set boths fields and reverts the change on the alertmanager side so that it uses cfg.TemplateFiles. (cherry picked from commit c16f1f5) (cherry picked from commit 0a6e80c)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Template provisioning sets the template in cfg.TemplateFiles while a recent change made it so that alertmanager reads cfg.AlertmanagerConfig.Templates instead.
This change fixes the issue on both ends, by having provisioning set boths fields and reverts the change on the alertmanager side so that it uses cfg.TemplateFiles.
Fixes: #69486