docs(grug): the enforcement-gap runbook the monitor already linked to - #816
Merged
Conversation
The monitor message has pointed at docs/RUNBOOK.md#enforcement-gap since it was written. That section did not exist - RUNBOOK.md had no enforcement content at all, so the one link an operator follows mid-alert went nowhere. Covers what the alert actually means (both cases: a real gap at 0.0 and a detection failure at -1.0, which need different responses), how to find the repo, the Pulumi-vs-opt-out decision, and the two Datadog traps worth knowing before chasing a red monitor: `pup monitors get` does not return live state, and a silent multi-alert group latches for 24h. Refs #716
Owner
Author
Live proof of #814, captured on this PRThis PR doubled as the verification vehicle for #814. The body was edited while Elder was mid-review, which is the exact sequence that produced Counts over that window:
The Zero bot comments on this PR is also the #791 rule holding: a clean review creates no board, so no email. |
This file contains hidden or 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
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.
Why
The enforcement-gap monitor's message has pointed at
docs/RUNBOOK.md#enforcement-gapsince it was written, and that section did not exist.RUNBOOK.mdhad no enforcement content at all, so the one link an operator follows mid-alert went nowhere.Found while fixing #716.
Summary
Documents what the alert means, how to triage it, and the two Datadog traps that cost real time this week.
The alert covers two different situations that need different responses: a real gap (
none, 0.0) versus a detection failure (error, -1.0, where you cannot currently tell). The runbook splits them.Also records that
pup monitors getdoes not return live state for this monitor - it reportsstate: nullwithoverall_state_modifiedfrozen at creation - so live status has to come frompup monitors search.Acceptance criteria
#enforcement-gapanchor the monitor links to now resolvesSize
Size: S
Out of scope
Refs #716
Live verification note
This body was edited at 15:07:24Z while Elder was mid-review, on purpose. Before #814 that cancelled both Cave arms and produced
all_failed. The review below should survive it.