pub struct RunbookEntry {
pub symptoms: &'static [&'static str],
pub diagnosis_steps: &'static [&'static str],
pub remediation_steps: &'static [&'static str],
pub verification_command: &'static str,
pub escalation: Option<&'static str>,
pub references: &'static [&'static str],
pub authored_at: &'static str,
}Expand description
Per-code operator runbook — symptoms, diagnosis, remediation, escalation.
Consumed by rch doctor --runbook <code> to render paste-ready Markdown
(or JSON) that an SRE can drop into a PagerDuty / Slack / wiki page when
the corresponding diagnostic fires. Generated from code so it can’t go
stale relative to the registry that produces the codes themselves.
Fields§
§symptoms: &'static [&'static str]Bulletized operator-visible signs: log lines, dashboard panels, the
rch doctor output the operator likely just saw before reaching for
the runbook. Used to confirm “this is the right runbook” before
running diagnosis.
diagnosis_steps: &'static [&'static str]Numbered procedure with exact commands. Each step is a single paste-ready command — no embedded prose. Diagnosis steps are READ-ONLY: they should never mutate state.
remediation_steps: &'static [&'static str]Numbered remediation procedure. Each step is paste-ready. Steps MAY mutate state (restart daemon, reset circuit, evict cache, etc.).
verification_command: &'static strFinal command to confirm the issue resolved. Typically
rch doctor --reliability --scope=<applicable> so the operator
can re-check the exact diagnostic without re-running the full
doctor suite.
escalation: Option<&'static str>Optional escalation guidance. None = use the generic default
(“open a GitHub issue with diagnostic output”). Set this for
codes that have a specific subject-matter-expert routing.
references: &'static [&'static str]External references: AGENTS.md sections, related git commits, RFC links. Rendered as a Markdown link list.
ISO 8601 date the runbook entry was authored. Used by
--runbook --since=<ts> (deferred) to surface newly-authored
runbooks. Hand-maintained on entry edits.