liveBook · Manning

Runbook

As explained in Build High Value Software Systems

A runbook is a documented set of operational procedures for diagnosing, mitigating, or recovering from known system conditions.

A runbook documents procedures for routine operations or known incidents. It is useful only when it reflects how the service actually works: stale instructions can create the illusion of preparedness without providing reliable guidance. section 12.4

The service-owning team maintains its runbooks. Prefer executable checks that automate diagnostics and leave decisions requiring human judgment to people; update the procedure whenever operations change. section 12.4

Listing 12.4 Example executable runbook for payment processing outage
def payment_outage_runbook():
    """Executable runbook: payment processing outage."""
    print("Step 1: Checking payment gateway status...")
    gw_status = check_gateway_health("stripe")
    print(f"  Gateway status: {gw_status}")
 
    print("Step 2: Checking payment-service error rate...")
    error_rate = get_service_error_rate("payment-service", window="5m")
    print(f"  Error rate: {error_rate:.2%}")
 
    print("Step 3: Checking database connection pool...")
    pool_usage = get_db_pool_usage("payments-db")
    print(f"  Pool usage: {pool_usage:.0%}")
 
    if pool_usage > 0.90:
        print("  ACTION: Pool near capacity. Kill idle connections.")
        kill_idle_connections("payments-db", older_than_minutes=10)
 
    print("Step 4: Checking queue depth...")
    depth = get_queue_depth("payment-processing-queue")
    print(f"  Queue depth: {depth} (normal < 100)")
 
    if depth > 500:
        print("  ESCALATE: Queue backing up. Page payments team lead.")
        page_oncall("payments-team-lead", "Queue depth critical: {depth}")

A payment-outage example checks gateway health, service errors, database-pool usage, and queue depth, and takes action when the pool nears capacity. section 12.4

How Build High Value Software Systems covers it

How deep it goes
Defines runbooks and contrasts stale eight-step prose with automated checks and human decision points.
Examples
Uses an outdated payment-outage procedure and executable payment diagnostics to contrast stale and actionable guidance.
What you can do after
Operate known outages by automating diagnostic checks and reserving judgment-dependent decisions for people.
How it connects
Connects operational runbooks to incident response, production readiness, and deployment-pipeline constraints.

Also explained in

Compare how 4 books explain runbook →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Build High Value Software Systems. The section links point to the parts of the book it draws on.