Skip to main content

Runbooks Overview

Purpose

This page provides a quick index for operational runbooks used during common production incidents and high-risk operational tasks.

Runbooks are not a replacement for engineering judgment. They provide a safe first response path, evidence expectations, and escalation rules.

Runbook Rules

  • Do not run destructive commands without approval.
  • Do not expose secrets, tokens, passwords, or private keys in screenshots.
  • Capture timestamps, affected service, impact, owner, and evidence.
  • Escalate SEV-1 and financial or data exposure risks immediately.
  • Record the incident in the incident response process if user impact exists.

Runbook Index

RunbookWhen To UseSeverity Default
Application DownWebsite, dashboard, or app unavailableSEV-1
API DownAPI health or protected endpoints failingSEV-1 / SEV-2
Database IssueDatabase unreachable, slow, or erroringSEV-1 / SEV-2
Payment FailurePayment, wallet, webhook, or duplicate transaction issueSEV-1
Backup RestoreRestore test or production restore workflowSEV-1 / Operational
Sentry Critical ErrorCritical application exception detectedSEV-2
Forge DisconnectedLaravel Forge cannot connect to serversSEV-3 unless service impact exists

Evidence Standard

Evidence TypeExamples
ScreenshotCloudflare, Forge, Sentry, monitoring, status page
Log excerptSanitized Laravel log, Nginx log, queue log
Command outputHealth check, deployment status, queue status
Decision recordOwner approval, rollback approval, incident commander note
Recovery proofHealth endpoint, login, protected API, payment status