Skip to main content

RunbookEntry

Struct RunbookEntry 

Source
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 str

Final 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.

§authored_at: &'static str

ISO 8601 date the runbook entry was authored. Used by --runbook --since=<ts> (deferred) to surface newly-authored runbooks. Hand-maintained on entry edits.

Trait Implementations§

Source§

impl Clone for RunbookEntry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for RunbookEntry

Source§

impl Debug for RunbookEntry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more