Thanks for the response By generating automatic documentation I meant automatically creating developer documentation of the existing alerts and their descriptions from the yml files rather than runtime information. which means the labels will not be replaced, so the less labels the more readable the result.
I am considering the addition of an extra annotation field for that purpose I think it is better to separate the concerns here. On Monday, March 27, 2023 at 3:46:11 PM UTC+2 Stuart Clark wrote: > On 2023-03-27 14:43, sayf.eddi...@gmail.com wrote: > > Hello, I have looked online and I cant find any best practices for > > filling up the description and the summary. from the examples I see > > that Summary should be the shortest (plus the minimum usage of > > labels). But maybe it is an observation bias. > > > > I am trying to generate some automatic documentation around alerting > > and having a lot of labels makes it as user friendly as reading the > > yaml file directly > > > > It really depends how you are wanting to use those. If you are wanting > to use the summary in an email's subject line then you probably want it > to be fairly short for example. You can have as many labels/annotations > as you like, so you don't even have to have one called "summary" if you > don't want to, and there's nothing stopping you from having much more > specific labels (e.g. severity, service, environment) which you can then > include in email/ticket subjects. > > -- > Stuart Clark > -- You received this message because you are subscribed to the Google Groups "Prometheus Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to prometheus-users+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/prometheus-users/8e2f11b4-547f-4647-9cf0-ad6e39088dccn%40googlegroups.com.
