Re: [prometheus-users] Alerts Description and Summary

2023-03-28 Thread sayf.eddi...@gmail.com
well yeah but I cant guarantee they understand the alerting format. also product operator can access the documentation too. On Tuesday, March 28, 2023 at 2:14:29 PM UTC+2 Brian Candler wrote: > If it's only for consumption by developers reading the rules files, then > would YAML comments be suf

Re: [prometheus-users] Alerts Description and Summary

2023-03-28 Thread Brian Candler
If it's only for consumption by developers reading the rules files, then would YAML comments be sufficient? On Monday, 27 March 2023 at 15:00:47 UTC+1 sayf.eddi...@gmail.com wrote: > Thanks for the response > > By generating automatic documentation I meant automatically creating > developer doc

Re: [prometheus-users] Alerts Description and Summary

2023-03-27 Thread sayf.eddi...@gmail.com
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 readabl

Re: [prometheus-users] Alerts Description and Summary

2023-03-27 Thread Stuart Clark
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

[prometheus-users] Alerts Description and Summary

2023-03-27 Thread sayf.eddi...@gmail.com
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 documentati