You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Incident response/Full report template: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>LMata
(updated category title)
imported>Krinkle
No edit summary
Line 12: Line 12:
-->
-->


== Summary and Metadata ==
== Summary ==
{| class="wikitable"
{{Incident scorecard
|'''Incident ID'''
| task =
|datestamp + brief component format
| paged-num =
|'''UTC Start Timestamp:'''
| responders-num =
|YYYY-MM-DD hh:mm:ss
| coordinators =
|-
| start =
|'''Incident Task'''
| end =
|Phabricator Link
}}
|'''UTC End Timestamp'''
<!-- Reminder: No private information on this page! -->
|YYYY-MM-DD hh:mm:ss
|-
|'''People Paged'''
|<amount of people>
|'''Responder Count'''
|<amount of people>
|-
|'''Coordinator(s)'''
|Names - Emails
|'''Relevant Metrics / SLO(s) affected'''
|Relevant metrics


% error budget
{{TOC|align=right}}
|-
|'''Summary:'''
| colspan="3" |<mark>What happened, in one paragraph or less. Avoid assuming deep knowledge of the systems here, and try to differentiate between proximate causes and root causes.</mark><!-- Reminder: No private information on this page! -->
 
'''Impact''': <mark>Who was affected and how? In one paragraph or less.  For user-facing outages: Estimate how many queries were lost, which regions were affected, or which types of clients (editors? readers? bots?), etc.  Do not assume the reader knows what your service is or who uses it.</mark>
|}{{TOC|align=right}}


== Timeline ==
==Timeline==
<mark>Write a step by step outline of what happened to cause the incident, and how it was remedied.  Include the lead-up to the incident, and any epilogue.</mark>
<mark>Write a step by step outline of what happened to cause the incident, and how it was remedied.  Include the lead-up to the incident, and any epilogue.</mark>


Line 51: Line 34:
'''All times in UTC.'''
'''All times in UTC.'''


* 00:00 (TODO) '''OUTAGE BEGINS'''
*00:00 (TODO) '''OUTAGE BEGINS'''
* 00:04 (Something something)
*00:04 (Something something)
* 00:06 (Voila) '''OUTAGE ENDS'''
*00:06 (Voila) '''OUTAGE ENDS'''
* 00:15 (post-outage cleanup finished)
*00:15 (post-outage cleanup finished)


<!-- Reminder: No private information on this page! -->
<!-- Reminder: No private information on this page! -->
<mark>TODO: Clearly indicate when the user-visible outage began and ended.</mark>
<mark>TODO: Clearly indicate when the user-visible outage began and ended.</mark>


== Detection ==
==Detection==
<mark>Write how the issue was first detected.  Was automated monitoring first to detect it? Or a human reporting an error?</mark>
<mark>Write how the issue was first detected.  Was automated monitoring first to detect it? Or a human reporting an error?</mark>


Line 68: Line 51:
<mark>TODO: If human only, an actionable should probably be to "add alerting".</mark>
<mark>TODO: If human only, an actionable should probably be to "add alerting".</mark>


== Conclusions ==
==Conclusions ==
<mark>What weaknesses did we learn about and how can we address them?</mark>
<mark>What weaknesses did we learn about and how can we address them?</mark>


=== What went well? ===
===What went well?===
* <mark>(Use bullet points) for example: automated monitoring detected the incident, outage was root-caused quickly, etc</mark>
*<mark>(Use bullet points) for example: automated monitoring detected the incident, outage was root-caused quickly, etc</mark>


=== What went poorly? ===
===What went poorly?===
* <mark>(Use bullet points) for example: documentation on the affected service was unhelpful, communication difficulties, etc</mark>
* <mark>(Use bullet points) for example: documentation on the affected service was unhelpful, communication difficulties, etc</mark>


=== Where did we get lucky? ===
===Where did we get lucky?===
* <mark>(Use bullet points) for example: user's error report was exceptionally detailed, incident occurred when the most people were online to assist, etc</mark>
*<mark>(Use bullet points) for example: user's error report was exceptionally detailed, incident occurred when the most people were online to assist, etc</mark>


=== How many people were involved in the remediation? ===
===How many people were involved in the remediation?===
* <mark>(Use bullet points) for example: 2 SREs and 1 software engineer troubleshooting the issue plus 1 incident commander</mark>
*<mark>(Use bullet points) for example: 2 SREs and 1 software engineer troubleshooting the issue plus 1 incident commander</mark>


== Links to relevant documentation ==
==Links to relevant documentation==
<mark>Add links to information that someone responding to this alert should have (runbook, plus supporting docs). If that documentation does not exist, add an action item to create it.</mark>
<mark>Add links to information that someone responding to this alert should have (runbook, plus supporting docs). If that documentation does not exist, add an action item to create it.</mark>


== Actionables ==
==Actionables==
<mark>Create a list of action items that will help prevent this from happening again as much as possible. Link to or create a Phabricator task for every step.</mark>
<mark>Create a list of action items that will help prevent this from happening again as much as possible. Link to or create a Phabricator task for every step.</mark>


* <mark>To do #1 (TODO: Create task)</mark>
*<mark>To do #1 (TODO: Create task)</mark>
* <mark>To do #2 (TODO: Create task)</mark>
*<mark>To do #2 (TODO: Create task)</mark>


<mark>TODO: Add the [[phab:project/view/4758/|#Sustainability (Incident Followup)]] and the [[phab:project/profile/4626/|#SRE-OnFIRE (Pending Review & Scorecard)]]  Phabricator tag to these tasks.</mark>
<mark>TODO: Add the [[phab:project/view/4758/|#Sustainability (Incident Followup)]] and the [[phab:project/profile/4626/|#SRE-OnFIRE (Pending Review & Scorecard)]]  Phabricator tag to these tasks.</mark>


= Scorecard =
==Scorecard==
Read more about [[Incident Scorecard]].
 
 
{| class="wikitable"
{| class="wikitable"
| colspan="2" |'''Incident Engagement™  ScoreCard'''
|+[[Incident Scorecard|Incident Engagement™  ScoreCard]]
|'''Score'''
!Rubric
!Question
!Score
|-
|-
| rowspan="5" |'''People'''
! rowspan="5" |People
|Were the people responding to this incident sufficiently different than the previous N incidents? (0/5pt)
|Were the people responding to this incident sufficiently different than the previous N incidents? (0/5pt)  
|
|
|-
|-
Line 113: Line 99:
|
|
|-
|-
|Were pages routed to online (working hours) engineers (0/5pt)? (score 0 if people were paged after-hours)
|Were pages routed to online (working hours) engineers (0/5pt)? (score 0 if people were paged after-hours)  
|
|
|-
|-
| rowspan="6" |'''Process'''
! rowspan="6" |Process
|Was the incident status section actively updated during the incident? (0/1pt)
|Was the incident status section actively updated during the incident? (0/1pt)
|
|
|-
|-
|If this was a major outage noticed by the community, was the public status page updated? If the issue was internal, was the rest of the organization updated with relevant incident statuses? (0/1pt)
| If this was a major outage noticed by the community, was the public status page updated? If the issue was internal, was the rest of the organization updated with relevant incident statuses? (0/1pt)  
|
|
|-
|-
Line 126: Line 112:
|
|
|-
|-
|Are the documented action items assigned?  (0/1pt)
|Are the documented action items assigned? (0/1pt)
|
|
|-
|-
|Is this a repeat of an earlier incident (-1 per prev occurrence)
|Is this a repeat of an earlier incident (-1 per prev occurrence)  
|
|
|-
|-
Line 135: Line 121:
|
|
|-
|-
| rowspan="4" |'''Tooling'''
! rowspan="4" | Tooling
|Did the people responding have trouble communicating effectively during the incident due to the existing or lack of tooling? (0/5pt)
| Did the people responding have trouble communicating effectively during the incident due to the existing or lack of tooling? (0/5pt)
|
|
|-
|-
Line 148: Line 134:
|
|
|-
|-
| colspan="2" |'''Total Score'''
! colspan="2" align="right" |Total score
|
|
|}
|}

Revision as of 00:08, 4 February 2022

document status: draft

Summary

Incident metadata (see Incident Scorecard)
Incident ID Full report template Start YYYY-MM-DD hh:mm:ss
Task End YYYY-MM-DD hh:mm:ss
People paged Responder count
Coordinators Affected metrics/SLOs
Impact Who was affected and how? For user-facing outages: Estimate how many queries were lost, which regions were affected, or which types of clients (editors? readers? bots?), etc. Do not assume the reader knows what your service is or who uses it.

Timeline

Write a step by step outline of what happened to cause the incident, and how it was remedied. Include the lead-up to the incident, and any epilogue.

Consider including a graphs of the error rate or other surrogate.

Link to a specific offset in SAL using the SAL tool at https://sal.toolforge.org/ (example)

All times in UTC.

  • 00:00 (TODO) OUTAGE BEGINS
  • 00:04 (Something something)
  • 00:06 (Voila) OUTAGE ENDS
  • 00:15 (post-outage cleanup finished)

TODO: Clearly indicate when the user-visible outage began and ended.

Detection

Write how the issue was first detected. Was automated monitoring first to detect it? Or a human reporting an error?

Copy the relevant alerts that fired in this section.

Did the appropriate alert(s) fire? Was the alert volume manageable? Did they point to the problem with as much accuracy as possible?

TODO: If human only, an actionable should probably be to "add alerting".

Conclusions

What weaknesses did we learn about and how can we address them?

What went well?

  • (Use bullet points) for example: automated monitoring detected the incident, outage was root-caused quickly, etc

What went poorly?

  • (Use bullet points) for example: documentation on the affected service was unhelpful, communication difficulties, etc

Where did we get lucky?

  • (Use bullet points) for example: user's error report was exceptionally detailed, incident occurred when the most people were online to assist, etc

How many people were involved in the remediation?

  • (Use bullet points) for example: 2 SREs and 1 software engineer troubleshooting the issue plus 1 incident commander

Links to relevant documentation

Add links to information that someone responding to this alert should have (runbook, plus supporting docs). If that documentation does not exist, add an action item to create it.

Actionables

Create a list of action items that will help prevent this from happening again as much as possible. Link to or create a Phabricator task for every step.

  • To do #1 (TODO: Create task)
  • To do #2 (TODO: Create task)

TODO: Add the #Sustainability (Incident Followup) and the #SRE-OnFIRE (Pending Review & Scorecard) Phabricator tag to these tasks.

Scorecard

Incident Engagement™ ScoreCard
Rubric Question Score
People Were the people responding to this incident sufficiently different than the previous N incidents? (0/5pt)
Were the people who responded prepared enough to respond effectively (0/5pt)
Did fewer than 5 people get paged (0/5pt)?
Were pages routed to the correct sub-team(s)?
Were pages routed to online (working hours) engineers (0/5pt)? (score 0 if people were paged after-hours)
Process Was the incident status section actively updated during the incident? (0/1pt)
If this was a major outage noticed by the community, was the public status page updated? If the issue was internal, was the rest of the organization updated with relevant incident statuses? (0/1pt)
Is there a phabricator task for the incident? (0/1pt)
Are the documented action items assigned? (0/1pt)
Is this a repeat of an earlier incident (-1 per prev occurrence)
Is there an open task that would prevent this incident / make mitigation easier if implemented? (0/-1p per task)
Tooling Did the people responding have trouble communicating effectively during the incident due to the existing or lack of tooling? (0/5pt)
Did existing monitoring notify the initial responders? (1pt)
Were all engineering tools required available and in service? (0/5pt)
Was there a runbook for all known issues present? (0/5pt)
Total score