robbond/pedwfrontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(runbook): add relay PR evidence template and summary draft

Browse Source
This commit is contained in:
robbond
2026-03-24 12:41:30 +00:00
parent ad0d2bf285
commit 7903944223
2 changed files with 61 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
context/runbook.md
+25
View File
@@ -110,6 +110,31 @@ Recommended starting posture:
3. Full rollback path: revert relay hardening commit set and redeploy.
4. Record incident + mitigation outcome in `memory-bank/change-log.md` and `memory-bank/pitfalls.md`.
### PR Evidence Snapshot Template (copy into PR description)
Use this template when shipping relay policy updates:
```
Relay policy smoke evidence (non-prod)
- [ ] 401/403 deterministic auth failures -> no retries observed
- [ ] 400/404 deterministic validation failures -> no retries observed
- [ ] 429/503 transient failures -> bounded retries/backoff observed
- [ ] timeout path -> bounded failure path, no retry storm
- [ ] structured redacted logs emitted (`relay_request_retrying` / `relay_request_failed`)
- [ ] duplicate endpoint-layer error logging suppressed for already-logged relay failures
Runtime knobs used during validation:
- RELAY_TIMEOUT_MS=
- RELAY_RETRY_MAX=
- RELAY_RETRY_BASE_DELAY_MS=
- RELAY_RETRY_MAX_DELAY_MS=
Rollback readiness:
- [ ] quick mitigation validated: RELAY_RETRY_MAX=0
- [ ] commit-revert path identified and documented
```
## Definition of Ready for AI-Assisted Tasks
- Clear acceptance criteria