Add style guide for alert naming, labels, annotations

monitoring-mixins / docs

Prometheus Monitoring Mixins: Using Jsonnet to Package Together Dashboards, Rules and Alerts.

197 stars 9 forks source link

Add style guide for alert naming, labels, annotations #10

Closed beorn7 closed 4 years ago

beorn7 commented 4 years ago

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

brancz commented 4 years ago

cc @metalmatze

beorn7 commented 4 years ago

Sure, let's remove dashboard_url and runbook_url. But perhaps add a note that we intend to add a guideline for those once we have fleshed out the details? That would help users that like those annotation and might assume we haven't even thought about those…

brancz commented 4 years ago

Yeah I'm happy with that.

metalmatze commented 4 years ago

Amazing stuff! Sorry for lag, still catching up from everything after 2 offline weeks.