-
Notifications
You must be signed in to change notification settings - Fork 461
Post Mortem Template
Whenever something (a deployment, a system update, a configuration change etc.) on the reference server goes horribly wrong and affects our users by producing downtime, slowness, data loss or other noticeable things, basically every time we cause a situation where our users would ask themselves
"WTF???"
we developers will write, as part of our Site-Reliability strategy, a post mortem report to institutionalize improvement. We do this to assure we...
- investigate the root cause of the failure
- determine follow-up actions
- create a continuous, transparent feedback loop for our fellow OBS team mates, our users and devops people in the wider community
We publish these reports on https://openbuildservice.org/categories/deployments/
To write up these reports we use the following template. We usually start with building the timeline, then derive the rest from this conversation. Check out the already published reports for inspiration.
< TEMPLATE >
A brief summary of what happened
Date: When did this problem happen?
Impact: What was the result of the problem?
Root Causes: Why did this problem happen?
Trigger: What caused this problem to happen?
Resolution: How did you resolve this problem?
Detection: How did you get alerted that the problem happened?
| Action Item | Owner |
|---|---|
What went well?
What went wrong?
Where we got lucky?
- 11:15 We got an alert about...
< /TEMPLATE >
- Development Environment Overview
- Development Environment Tips & Tricks
- Spec-Tips
- Code Style
- Rubocop
- Testing with VCR
- Test in kanku
- Authentication
- Authorization
- Autocomplete
- BS Requests
- Events
- ProjectLog
- Notifications
- Feature Toggles
- Build Results
- Attrib classes
- Flags
- The BackendPackage Cache
- Maintenance classes
- Cloud uploader
- Delayed Jobs
- Staging Workflow
- StatusHistory
- OBS API
- Owner Search
- Search
- Links
- Distributions
- Repository
- Data Migrations
- Package Versions
- next_rails
- Ruby Update
- Rails Profiling
- Remote Pairing Setup Guide
- Factory Dashboard
- osc
- Setup an OBS Development Environment on macOS
- Run OpenQA smoketest locally
- Responsive Guidelines
- Importing database dumps
- Problem Statement & Solution
- Kickoff New Stuff
- New Swagger API doc
- Documentation and Communication
- GitHub Actions
- Brakeman
- How to Introduce Software Design Patterns
- Query Objects
- Services
- View Components
- RFC: Core Components
- RFC: Decorator Pattern
- RFC: Backend models
- RFC: Hotwire Turbo Frames Pattern