Alertmanager: No documentation on how to setup a custom email template

[talonx]

What did you do?
Trying to add a custom email template. This is not an usage related question, since the docs for adding a custom email template are missing. The only reference is https://prometheus.io/docs/alerting/notification_examples/ which is about Slack, not email.

I have searched the Prom Google Group too, but it's full of questions about this topic but not working answers.

[mxinden]

Thanks for raising this issue @talonx. I am sorry for the inconvenience. Please keep in mind that this is a community driven project.

Would you like to give this a shot and create a pull request adding more documentation on the topic? Of course we are happy to help.

[talonx]

I received a helpful response on the Slack channel pointing me to https://prometheus.io/docs/alerting/configuration/#%3Cemail_config%3E

[talonx]

However, the URL I mentioned in the Slack response above talks only about inline templates, and not about separate included HTML templates.

@mxinden I would love to contribute to the docs, but I have to figure out how to get it to work first :) It seems to be a trial-and-error driven process.

[simonpasquier]

@talonx are you referring to templates defined in separate files? If so they are described here:
https://prometheus.io/docs/alerting/notification_examples/#defining-reusable-templates

Otherwise the documentation for AlertManager is there (it should eventually move to this repository but this is another effort):
https://github.com/prometheus/docs/tree/master/content/docs/alerting

[talonx]

@simonpasquier Thanks for the link - I'll give it a try.

[xuanyuanaosheng]

@talonx Could you find some beautiful email template?
@simonpasquier @mxinden Can the official website provide some email alarm templates? I think the tables is more better.

[simonpasquier]

Contributions are welcome! The documentation is now located in this repository: https://github.com/prometheus/alertmanager/tree/master/docs