docs(patterns): backfill #14 walkthrough + document #6/#15 gaps#524
Merged
Conversation
Signed-off-by: Tri Lam <tree@lumalabs.ai>
Signed-off-by: Tri Lam <tree@lumalabs.ai>
Contributor
Author
|
Adversarial review (independent pass): grade A. Findings:
Grade A: doc-only PR with one load-bearing fix applied. Auto-merge armed. |
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.
Summary
Closes the missing-pattern-docs gap in
docs/patterns/for the twonumerically-missing IDs (#6, #14) against NORTHSTARS Appendix A's
15-pattern roster.
Investigation
Surveyed
module/pkg/patterns/, NORTHSTARS Appendix A, andMILESTONES M18/M19 to pin actual detector state per ID:
☑ in-tree detectorstraggler*.go, nodata_timeaggregation, no replay fixture. Onlyfailure-inject cpu-stealchaos hook (M4b) lands the symptom. MILESTONES line 237 acknowledges M18 is at-risk and build-time-coupled to M17'scross_rank.go. The Appendix A mark is aspirational, not current state.☑ in-tree detectorpatterns.PodEvictedDetectorinmodule/pkg/patterns/pod_evicted.go, processor wiring inmodule/processor/patterndetectorprocessor/, canonical replay fixture atmodule/pkg/replay/pod_evicted/canonical/.14-pod-evicted-walkthrough.mdfollowing the02-ib-link-flap-walkthrough.mdtemplate (Symptom → Signal → Query → Alert → Escalation → Replay → Detector status → Verdict shape → Integration recipe).Also surfaced #15 (Image pull /
FailedMounton restart) — presentin Appendix A but absent from this directory. Added to the same
"Reserved / unfilled" table for completeness so every Appendix A
ID is accounted for somewhere in
docs/patterns/.Changes
docs/patterns/14-pod-evicted-walkthrough.md(new, ~210 lines) —full operator walkthrough sourced from
module/pkg/patterns/pod_evicted.gogodoc,verdict.goPodEvictedVerdictstruct, processor config knobs(
join_window,emit_partial_verdicts), thek8sobjectsreceiverintegration recipe, and the canonical replayfixture's headline regex contract.
docs/patterns/README.md— adds the [docs] FOLLOWUPS: close squash-merge-trailer item with observation #14 row to the Operatorwalkthroughs (shipped) table; rewrites the coverage prose
(5 → 7 patterns walkthrough'd); adds a new "Reserved / unfilled"
section documenting Make RFC process optional, not gated #6 and [telemetry] Add SelfTelemetry interface + agent infra scaffolding #15 explicitly so the numeric gaps in
the existing tables are no longer silent.
Test plan
make doc-checkgreen — all markdown links + anchors resolve,banned-phrase lint clean, walkthrough renders.
golangci-lint,go vet,go mod verify,attribute-namespace-check,deprecation-check).real on-disk file (
pod_evicted.go,pod_evicted_test.go,pod_evicted_bench_test.go,replay/pod_evicted/canonical/,k8sobjects-events.md,ATTRIBUTES.md,example_config.yaml).