alertmanager icon indicating copy to clipboard operation
alertmanager copied to clipboard

No documentation on how to setup a custom email template

Open talonx opened this issue 7 years ago • 7 comments

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.

talonx avatar Nov 02 '18 05:11 talonx

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.

mxinden avatar Nov 05 '18 12:11 mxinden

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

talonx avatar Nov 08 '18 09:11 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.

talonx avatar Nov 09 '18 09:11 talonx

@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

simonpasquier avatar Nov 09 '18 15:11 simonpasquier

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

talonx avatar Nov 19 '18 17:11 talonx

@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.

xuanyuanaosheng avatar Aug 07 '20 08:08 xuanyuanaosheng

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

simonpasquier avatar Aug 12 '20 15:08 simonpasquier