search

prometheus-operator / runbooks

https://runbooks.prometheus-operator.dev
Apache License 2.0
88 stars 164 forks source link

Join forces with robusta-dev/alert-explanations/wiki #27

Open nvtkaszpir opened 2 years ago

nvtkaszpir commented 2 years ago

Found out https://github.com/robusta-dev/alert-explanations/wiki which is using only github wiki, but they also use kube-prometheus-stack (with their opinionated configuration, though). Right now there are only 3 pages there, mainly focused on CPUThrottlingHigh explanations.

Wondering if they would be eager to participate in making PR in this repo? WDYT @aantn ?

aantn commented 2 years ago

Hi, thanks for tagging me.

We were planning to move from GitHub wikis to a proper wiki and add substantially more content. We have time and resources to work on this.

We're trying to cover in each wiki page not only what to do, but also how you can automate that troubleshooting process using AlertManager webhooks and the Robusta open source. (E.g. if you would run two kubectl commands to see why an alert is firing we can run them directly and send the output along with the alert. If you would use some decision tree to troubleshoot, we do that in code.)

So the wiki pages are both documentation on what to do, but also what Robusta automates for you.

Would that type of content related to Robusta be welcome in this runbooks wiki? It's all open source, MIT licensed, and can be used standalone without our cloud platform.

paulfantom commented 2 years ago

I am all for joining forces. However, runbooks here need to be unopinionated in regards to 3rd party tooling as we would like to keep a neutral ground and focus on tools we ship in kube-prometheus.

Side note: we used wiki in the past (as can be seen in https://github.com/prometheus-operator/kube-prometheus/wiki/Runbooks) but decided to deprecate it due to high friction when it came to contributions.

aantn commented 2 years ago

Understood. Not going to open a PR for our content at present (as it's intentionally opinionated) but happy to explore other ideas in the future.