Skip to content

Commit a1f152b

Browse files
committed
[update] - add help for how to write an incident report
1 parent ecebff8 commit a1f152b

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

common/help_incident.sh

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
function lamhaison_help_incident_report() {
2+
echo "
3+
Reference - https://sysadmincasts.com/episodes/20-how-to-write-an-incident-report-postmortem
4+
Reference - https://blog.tolleiv.de/2015/01/post-mortem-documentations-or-how-to-build-knowledge-during-failures/
5+
Google API infrastructure outage incident report - https://developers.googleblog.com/2013/05/google-api-infrastructure-outage_3.html
6+
Issue Summary
7+
short summary (5 sentences)
8+
list the duration along with start and end times (include timezone)
9+
state the impact (most user requests resulted in 500 errors, at peak 100%)
10+
close with root cause
11+
Timeline
12+
list the timezone
13+
covers the outage duration
14+
when outage began
15+
when staff was notified
16+
actions, events, …
17+
when service was restored
18+
Root Cause
19+
give a detailed explanation of event
20+
do not sugarcoat
21+
Resolution and recovery
22+
give detailed explanation of actions taken (includes times)
23+
Corrective and Preventative Measures
24+
itemized list of ways to prevent it from happening again
25+
what can we do better next time?
26+
"
27+
}

0 commit comments

Comments
 (0)