cli: add new template render command by GiedriusS · Pull Request #2538 · prometheus/alertmanager

GiedriusS · 2021-04-08T11:10:45Z

Add a new template rendering command that allows users to test out their
templates. This is especially needed because small bugs in templates do
not surface until alertmanager actually tries to render them.

Signed-off-by: Giedrius Statkevičius giedrius.statkevicius@vinted.com

Add a new template rendering command that allows users to test out their templates. This is especially needed because small bugs in templates do not surface until alertmanager actually tries to render them. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS · 2021-04-09T08:14:52Z

cli/template_render.go

+		f = tmpl.ExecuteHTMLString
+	}
+
+	data := template.Data{


We might want to load this from a file or something so that users could try out how their logic works with certain labels/annotations. WDYT?

I think the ability to load custom data from YAML or JSON would be ideal, like in https://juliusv.com/promslack/.

template.Data has more stuff such as receiver or status so it's going to be a bit different. Also, because that struct only has json tags, I think we should opt for only json support for now.

I have added this functionality via 3ae0098. Does it look good? (:

Looks good to me ;)

Add a new parameter `--templatefile` for `amtool` so that it would be possible to pass custom alert data. Use an example `template.Data` if none has been passed to permit simple use-cases. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

Let's support older Go versions as well. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

mrliptontea · 2021-04-13T14:52:49Z

cli/template_render.go

+	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
+	renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)
+	renderCmd.Flag("templatetype", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")
+	renderCmd.Flag("templatefile", `Full path to a file which contains the data of the alert(-s) with which the --templatetext will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)


I think this name makes it sounds like it's maybe an alternative to templateglob (i.e. use this specific file).
How about templatedata or datasource?

I didn't think about this similarity. templatedata sounds good, will rename it. BTW @mrliptontea have you ever seen a similar tool online? I haven't and I'm surprised that no one has made this yet

Found https://github.com/prometheus/alertmanager/pull/2414/files 😞

promslack was the closest to what I needed but sadly it's not quite it.
I saw that other Pull Request but I prefer this - it's simpler yet fulfils my needs.

I'm now writing some "tests" where I have a bunch of different alerts in JSON, I render the templates, and compare the output to make the alerts more user friendly so thanks @GiedriusS you made it possible 🙂

Suggested change

renderCmd.Flag("templatefile", `Full path to a file which contains the data of the alert(-s) with which the --templatetext will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)

renderCmd.Flag("template.file", `Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)

Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS · 2021-06-04T13:51:28Z

@roidelapluie kind ping 🤗 could you PTAL when you'll have a free minute? I'd love to have this in so that I could automate some template checks during CI.

roidelapluie

Yes, template.data seems better.

Also, alertmanager uses dot-separated parameters. Can you update this?

bwplotka

Looks good, just flag name nits as @roidelapluie mentioned 🤗

Otherwise LGTM from my side

bwplotka · 2021-06-24T15:41:45Z

cli/template_render.go

+
+	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
+	renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)
+	renderCmd.Flag("templatetype", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")


Suggested change

renderCmd.Flag("templatetype", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")

renderCmd.Flag("template.type", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")

Similar to

alertmanager/cli/routing.go

Line 56 in 4d7251f

configFlag = routingCmd.Flag("config.file", "Config file to be tested.")

(as @roidelapluie mentioned)

bwplotka · 2021-06-24T15:42:17Z

cli/template_render.go

+	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
+	renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)
+	renderCmd.Flag("templatetype", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")
+	renderCmd.Flag("templatefile", `Full path to a file which contains the data of the alert(-s) with which the --templatetext will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)


Suggested change

renderCmd.Flag("templatefile", `Full path to a file which contains the data of the alert(-s) with which the --templatetext will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)

renderCmd.Flag("template.file", `Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)

bwplotka · 2021-06-24T15:42:28Z

cli/template_render.go

+	)
+
+	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
+	renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)


Suggested change

renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)

renderCmd.Flag("template.text", "The template that will be rendered").Required().StringVar(&c.templateText)

bwplotka · 2021-06-24T15:42:33Z

cli/template_render.go

+		renderCmd = cc.Command("render", "Render a given definition in a template file to standard output")
+	)
+
+	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)


Suggested change

renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)

renderCmd.Flag("template.glob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)

Use dot separator for different words in command-line parameters. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS · 2021-06-28T08:42:42Z

Added a dot separator for the parameters, PTAL @roidelapluie @bwplotka 🤗 Sorry for the force-push, I forgot that the DCO is necessary for this repo 😢 Nothing else has been changed.

GiedriusS · 2021-07-15T15:32:19Z

@bwplotka @roidelapluie 🥺 friendly ping 🤗

roidelapluie · 2021-07-23T11:29:24Z

README.md

 ```

+Try out how a template works. Let's say you have this in your configuration file:
+


Can we remove this BL for consistency?

roidelapluie · 2021-07-23T11:30:17Z

cli/template_render.go

+	renderCmd.Flag("template.glob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
+	renderCmd.Flag("template.text", "The template that will be rendered").Required().StringVar(&c.templateText)
+	renderCmd.Flag("template.type", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")
+	renderCmd.Flag("template.data", `Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateData)


Suggested change

renderCmd.Flag("template.data", `Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateData)

renderCmd.Flag("template.data", "Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering.").FileVar(&c.templateData)

roidelapluie · 2021-07-23T11:30:48Z

cli/template.go

+	"gopkg.in/alecthomas/kingpin.v2"
+)
+
+// configureTemplateCmd represents the template command


Suggested change

// configureTemplateCmd represents the template command

// configureTemplateCmd represents the template command.

Use full stops and remove a blank line. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

roidelapluie · 2021-08-04T11:58:38Z

Thanks!

GiedriusS commented Apr 9, 2021

View reviewed changes

GiedriusS added 2 commits April 13, 2021 17:28

cli: io -> ioutil

4d7251f

Let's support older Go versions as well. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

mrliptontea reviewed Apr 13, 2021

View reviewed changes

cli: template/render: rename --templatefile to --templatedata

ee40eab

Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS mentioned this pull request Apr 14, 2021

Add amtool command for rendering templates. #2414

Closed

roidelapluie reviewed Jun 24, 2021

View reviewed changes

bwplotka approved these changes Jun 24, 2021

View reviewed changes

Update according to comments

e6abf2e

Use dot separator for different words in command-line parameters. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS force-pushed the amtool_render branch from 07a092b to e6abf2e Compare June 28, 2021 08:41

roidelapluie reviewed Jul 23, 2021

View reviewed changes

Fix according to comments

21c61be

Use full stops and remove a blank line. Signed-off-by: Giedrius Statkevičius <giedrius.statkevicius@vinted.com>

GiedriusS force-pushed the amtool_render branch from 8c1c762 to 21c61be Compare July 23, 2021 14:42

roidelapluie merged commit 3962da4 into prometheus:main Aug 4, 2021

GiedriusS deleted the amtool_render branch August 4, 2021 13:25

	renderCmd.Flag("templatefile", `Full path to a file which contains the data of the alert(-s) with which the --templatetext will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)
	renderCmd.Flag("template.file", `Full path to a file which contains the data of the alert(-s) with which the --template.text will be rendered. Must be in JSON. File must be formatted according to the following layout: https://pkg.go.dev/github.com/prometheus/alertmanager/template#Data. If none has been specified then a predefined, simple alert will be used for rendering`).FileVar(&c.templateFile)

	renderCmd.Flag("templatetype", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")
	renderCmd.Flag("template.type", "The type of the template. Can be either text (default) or html").EnumVar(&c.templateType, "html", "text")

	renderCmd.Flag("templatetext", "The template that will be rendered").Required().StringVar(&c.templateText)
	renderCmd.Flag("template.text", "The template that will be rendered").Required().StringVar(&c.templateText)

	renderCmd.Flag("templateglob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)
	renderCmd.Flag("template.glob", "Glob of paths that will be expanded and used for rendering").Required().StringsVar(&c.templateFilesGlobs)

		```

		Try out how a template works. Let's say you have this in your configuration file:

	// configureTemplateCmd represents the template command
	// configureTemplateCmd represents the template command.

Conversation

GiedriusS commented Apr 8, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GiedriusS commented Jun 4, 2021

Uh oh!

roidelapluie left a comment

Choose a reason for hiding this comment

Uh oh!

bwplotka left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GiedriusS commented Jun 28, 2021

Uh oh!

GiedriusS commented Jul 15, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roidelapluie commented Aug 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants