Alertmanager: Fix custom Grafana templates not defined #9438
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
stevesg
reviewed
Sep 27, 2024
| @@ -95,7 +96,7 @@ func WithCustomFunctions(userID string) template.Option { | |||
|
|
|||
| // loadTemplates produces a template.Template from several in-memory template files. | |||
| // It is adapted from FromGlobs in prometheus/alertmanager: https://github.com/prometheus/alertmanager/blob/9de8ef36755298a68b6ab20244d4369d38bdea99/template/template.go#L67-L95 | |||
| func loadTemplates(tmpls []io.Reader, options ...template.Option) (*template.Template, error) { | |||
| func loadTemplates(tmpls []alertingTemplates.TemplateDefinition, options ...template.Option) (*template.Template, error) { | |||
There was a problem hiding this comment.
[nit] I don't think the grafana/alerting types need to leak in here, I think this is cleaner.
Suggested change
| func loadTemplates(tmpls []alertingTemplates.TemplateDefinition, options ...template.Option) (*template.Template, error) { | |
| func loadTemplates(tmpls []string, options ...template.Option) (*template.Template, error) { |
santihernandezc
force-pushed
the
santihernandezc/fix_custom_grafana_templates_not_defined
branch
from
f36c7f4 to
a9a6969
Compare
titolins
reviewed
Sep 30, 2024
| @@ -433,9 +432,9 @@ func clusterWait(position func() int, timeout time.Duration) func() time.Duratio | |||
|
|
|||
| // ApplyConfig applies a new configuration to an Alertmanager. | |||
| func (am *Alertmanager) ApplyConfig(conf *definition.PostableApiAlertingConfig, tmpls []alertingTemplates.TemplateDefinition, rawCfg string, tmplExternalURL *url.URL, staticHeaders map[string]string) error { | |||
| templates := make([]io.Reader, 0, len(tmpls)) | |||
There was a problem hiding this comment.
The problem is not really the io.Reader, that's just an interface. You could also keep the type signature and create a wrapper that implements Reader - e.g.:
type unlimitedStringReader struct {
s string
}
func (r *unlimitedStringReader) Read(p []byte) (n int, err error) {
return strings.NewReader(r.s).Read(p)
}There was a problem hiding this comment.
Yes, but we don't need this level of abstraction.
We're currently using readers just because we need to pass readers down the pipeline, it's a relic from reading templates from disk. We can do perfectly fine using plain strings.
There was a problem hiding this comment.
it's a relic from reading templates from disk
Ahh, tks for the context. It does make more sense that we'd like to get rid of it.
I'm testing it now and should approve in a bit 👍
titolins
approved these changes
Sep 30, 2024
rwwiv
approved these changes
Sep 30, 2024
santihernandezc
force-pushed
the
santihernandezc/fix_custom_grafana_templates_not_defined
branch
from
d288f39 to
a75e0dc
Compare
santihernandezc
force-pushed
the
santihernandezc/fix_custom_grafana_templates_not_defined
branch
from
629ff41 to
71d22dd
Compare
santihernandezc
deleted the
santihernandezc/fix_custom_grafana_templates_not_defined
branch
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.
As we're using
[]io.Readerfor templates, we can read them only once. This is a problem because we use different structs to execute templates for Mimir and Grafana integrations, and both need the same templates. When we create the Grafana template struct, the templates have already been read, resulting in "template not defined" errors when trying to send notifications with custom templates.Since we stopped reading templates from disk, there's no advantage in using an
io.Readerbesides using the interfacegithub.com/prometheus/alertmanager/templateexpects intemplate.Parse().This PR replaces
[]io.Readerfor templates in favor of[]TemplateDefinition, converting them into anio.Readerwhen callingtemplate.Parse().Fixes https://github.com/grafana/alerting-squad/issues/929