Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide Runbook PrometheusRules #1556

Open
eumel8 opened this issue Oct 24, 2023 · 0 comments
Open

Provide Runbook PrometheusRules #1556

eumel8 opened this issue Oct 24, 2023 · 0 comments
Labels
good first issue Good for newcomers pinned
Milestone

Comments

@eumel8
Copy link
Collaborator

eumel8 commented Oct 24, 2023

Is your feature request related to a problem? Please describe.

The Kube Logging Operator has already a lot of well documented PrometheusRules included, which have a good readable AlertName, a short summary and description. On a daily work it's easy to spot an error and start working on the root cause.
For the unskilled stuff like OnCall team or 1st level support it's a bit overwhelmed without any deeper knowledge in the architecture which alert is related or what are to do to investigate or solve the issue.

Describe the solution you'd like

The typical use case for the Operations team is to use the Runbook feature of PrometheusRule/Annotation. Best reference is the Runbook of Prometheus project itself.
Basically in the PrometheusRule is a link to an web service with additionally instruction to the related alert. This is easy to manage, everybody can contribute to the documentation and improve the working steps.

I started a proposal here

Describe alternatives you've considered

Alternative you can put all this information in the PrometheusRule itself. But that's more static and needs more cluster resources.

Additional context

https://en.wikipedia.org/wiki/Runbook

@stale stale bot added the wontfix This will not be worked on label Dec 23, 2023
@aslafy-z aslafy-z added pinned and removed wontfix This will not be worked on labels Dec 24, 2023
@kube-logging kube-logging deleted a comment from stale bot Nov 22, 2024
@csatib02 csatib02 added the good first issue Good for newcomers label Nov 27, 2024
@csatib02 csatib02 added this to the Misc/Other milestone Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers pinned
Projects
None yet
Development

No branches or pull requests

3 participants