Add style guide for alert naming, labels, annotations #10
Conversation
README.md
Outdated
| - `runbook_url` (optional): A link to a runbook for the alert. (TODO: Flesh out | ||
| details. Also see [kubernetes-mixin issue | ||
| #312](https://github.com/kubernetes-monitoring/kubernetes-mixin/issues/312).) | ||
| - `dashboard_url` (optional): A link to a meaningful Grafana dashboard. (TODO: |
There was a problem hiding this comment.
I am in favor of this annotation field, but it greatly complicates a generic usage of mixins. This is the only field that always needs to be configured by end-user, which is not the case for any other mixin.
Additionally, it does not show up in any of the currently used ones. I would prefer to do a spike on at least one mixin before making this into a general guideline.
README.md
Outdated
| $labels.instance }} has only {{ printf "%.2f" $value }}% available inodes | ||
| left.`, `Alert notification queue of Prometheus %(prometheusName)s is running | ||
| full.`. | ||
| - `runbook_url` (optional): A link to a runbook for the alert. (TODO: Flesh out |
There was a problem hiding this comment.
I like runbook url and dashboard url, but as you already noted, these haven't really been fleshed out enough, I think we should skip them for now
|
cc @metalmatze |
|
Sure, let's remove |
|
Yeah I'm happy with that. |
Signed-off-by: beorn7 <[email protected]>
|
Amazing stuff! |
This is obviously very opinionated as I just put down what I'm evangelizing myself. But I wanted to get started with a suggestion. Let's take it from here. @brancz @paulfantom