Docs: Expand ruler recommended alerting docs #1719
Merged
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
Signed-off-by: Ian Billett <[email protected]>
FUSAKLA
reviewed
Nov 8, 2019
There was a problem hiding this comment.
Hi, thanks for the contribution!
I'm not completely sure about stating the Query explicitly. Depending on the strategy this could be also caused by failing any of the StoreAPI called by the Query. Maybe at least state that it is "most probably" caused by it but tbh first thing you should probably do is to check the logs which will tell you what was the issue?
bwplotka
reviewed
Nov 9, 2019
Co-Authored-By: Bartlomiej Plotka <[email protected]> Signed-off-by: Ian Billett <[email protected]>
squat
requested changes
Nov 11, 2019
docs/components/rule.md
Outdated
| @@ -81,7 +81,9 @@ The most important metrics to alert on are: | |||
| indicate connection, incompatibility or misconfiguration problems. | |||
|
|
|||
| * `prometheus_rule_evaluation_failures_total`. If greater than 0, it means that that rule failed to be evaluated, which results in | |||
| either gap in rule or potentially ignored alert. Alert heavily on this if this happens for longer than your alert thresholds. | |||
| either gap in rule or potentially ignored alert. This metric might indicate problems on the queryAPI endpoint you use. | |||
|
|
|||
There was a problem hiding this comment.
This new line here breaks the formatting of the list. This makes the line “alert heavily...” appear out of the list, and then the list continues.
Signed-off-by: Ian Billett <[email protected]>
|
@squat good spot - updated to remove the newline |
squat
approved these changes
Nov 12, 2019
|
Thanks :) |
IKSIN
pushed a commit
to monitoring-tools/thanos
that referenced
this pull request
Nov 26, 2019
* updates ruler docs Signed-off-by: Ian Billett <[email protected]> * Update docs/components/rule.md Co-Authored-By: Bartlomiej Plotka <[email protected]> Signed-off-by: Ian Billett <[email protected]> * removes newline Signed-off-by: Ian Billett <[email protected]> Signed-off-by: Aleksey Sin <[email protected]>
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.
Changes
This addition to the documentation would have answered this question that I raised on slack.
Added sentence to the documentation for
Rulercomponent.Verification
Not applicable.