← Recipes

阅读中文版本

Use a Blameless Postmortem Template for Incidents

Fill a structured template with timeline, root cause, impact, and action items so the postmortem focuses on systems not people.

~20 minobservabilityincidentpostmortem

Task

Instrument postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } so on-call engineers can diagnose an incident without guessing at log lines.

When to use this

An outage lasts 47 minutes because the team cannot correlate postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } across services without structured traces.

Prerequisites

  • An application with structured logging available
  • A metrics or tracing backend configured

Steps

1. Configure postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } in the project configuration file with the recommended defaults.

postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] }

Expected output: The configuration is accepted and postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } runs without errors on the first invocation.

2. Run the check locally to verify postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } produces the expected result before pushing.

act -j build  # or: pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } blocks merge on failure.

- name: Run add postmortem blameless template
  run: pnpm test

Expected output: Pull requests with failing postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Make the system observable

Start by measuring the problem. Fill a structured template with timeline, root cause, impact, and action items so the postmortem focuses on systems not people. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } against the current codebase and inspect the output before wiring it into CI.

postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] }

Correlate across services

Once the gate is in place, make failures actionable. A failing postmortem: { summary, timeline, root_cause, impact, actions: [], lessons: [] } should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.