Update runbook.md #208
Open
Update runbook.md #208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix a speling. (yes, I know) Mention that specifying a dashboard link would be particularly useful in determining the immediate significance of an individual alert.
metalmatze
requested changes
Jun 6, 2019
| @@ -3,7 +3,7 @@ | |||
| As Rob Ewaschuk [puts it](https://docs.google.com/document/d/199PqyG3UsyXlwieHaqbGiWVa8eMWi8zzAn0YfcApr8Q/edit#): | |||
| > Playbooks (or runbooks) are an important part of an alerting system; it's best to have an entry for each alert or family of alerts that catch a symptom, which can further explain what the alert means and how it might be addressed. | |||
|
|
|||
| It is a recommended practice that you add an annotation of "runbook" to every prometheus alert with a link to a clear description of it's meaning and suggested remediation or mitigation. While some problems will require private and custom solutions, most common problems have common solutions. In practice, you'll want to automate many of the procedures (rather than leaving them in a wiki), but even a self-correcting problem should provide an explanation as to what happened and why to observers. | |||
| It is a recommended practice that you add an annotation of "runbook" to every prometheus alert with a link to a clear description of its meaning and suggested remediation or mitigation. While some problems will require private and custom solutions, most common problems have common solutions. In practice, you'll want to automate many of the procedures (rather than leaving them in a wiki), but even a self-correcting problem should provide an explanation as to what happened and why to observers. In addition, it would be useful to include a URL to a dashboard that includes the relevant information; distributed systems being what they are, the more you know. the more you might be able to determ,ine just how significant an individual alert might be. | |||
There was a problem hiding this comment.
Now you've introduced another typo. Thanks for the fix though! 😊
Suggested change
| It is a recommended practice that you add an annotation of "runbook" to every prometheus alert with a link to a clear description of its meaning and suggested remediation or mitigation. While some problems will require private and custom solutions, most common problems have common solutions. In practice, you'll want to automate many of the procedures (rather than leaving them in a wiki), but even a self-correcting problem should provide an explanation as to what happened and why to observers. In addition, it would be useful to include a URL to a dashboard that includes the relevant information; distributed systems being what they are, the more you know. the more you might be able to determ,ine just how significant an individual alert might be. | |
| It is a recommended practice that you add an annotation of "runbook" to every prometheus alert with a link to a clear description of its meaning and suggested remediation or mitigation. While some problems will require private and custom solutions, most common problems have common solutions. In practice, you'll want to automate many of the procedures (rather than leaving them in a wiki), but even a self-correcting problem should provide an explanation as to what happened and why to observers. In addition, it would be useful to include a URL to a dashboard that includes the relevant information; distributed systems being what they are, the more you know. the more you might be able to determine just how significant an individual alert might be. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix a speling. (yes, I know)
Mention that specifying a dashboard link would be particularly useful in determining the immediate significance of an individual alert.