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

Incident response/Lightweight report template: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>LMata
(Updated formatting)
imported>Krinkle
No edit summary
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>{{Navigation Incidents}}
{{Note|To use this template:
{{Note|To use this template:
* Go to '''[[Incident status]]'''
* Go to '''[[Incident status]]'''
Line 5: Line 5:


(Do not edit or copy this page directly.)|type=warning}}
(Do not edit or copy this page directly.)|type=warning}}
</noinclude>{{irdoc|status=<includeonly>draft</includeonly>}} <!--
</noinclude>{{irdoc|status=<includeonly>draft</includeonly>}}
The status field should be one of:
* {{irdoc|status=draft}} - Initial status. When you're happy with the state of your draft, change it to status=review.
* {{irdoc|status=review}} - The incident review working group will contact you then to finalise the report. See also the steps on [[Incident documentation]].
* {{irdoc|status=final}}
-->


== Summary and Metadata ==
== Summary ==
The metadata is aimed at helping provide a quick snapshot of context around what happened during the incident.
{{Incident scorecard
{| class="wikitable"
| task =
|'''Incident ID'''
| paged-num =
|datestamp + brief component format
| responders-num =
|'''UTC Start Timestamp:'''
| coordinators =
|YYYY-MM-DD hh:mm:ss
| start =
|-
| end =
|'''Incident Task'''
}}
|Phabricator Link
<!-- Reminder: No private information on this page! -->
|'''UTC End Timestamp'''
 
|YYYY-MM-DD hh:mm:ss
|-
 
|'''People Paged'''
<mark>Summary of what happened, in one or two paragraphs. Avoid assuming deep knowledge of the systems here, and try to differentiate between proximate causes and root causes.</mark>
|<amount of people>
 
|'''Responder Count'''
'''Documentation''':
|<amount of people>
* …
|-
 
|'''Coordinator(s)'''
<mark>Link to relevant source code, graphs, or logs</mark>
|Names - Emails
 
|'''Relevant Metrics / SLO(s) affected'''
==Actionables==
|Relevant metrics
 
* …
 
<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>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>


% error budget
==Scorecard==
|-
|'''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>
|}'''Documentation''':
* <mark>Todo (Link to relevant source code, graphs, or logs)</mark>


= Scorecard =
{| class="wikitable"
{| class="wikitable"
| colspan="2" |'''Incident Engagement™  ScoreCard'''
|+[[Incident Scorecard|Incident Engagement™  ScoreCard]]
|'''Score'''
!
!Question
!Answer
(yes/no)
!Notes
|-
|-
| 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 five incidents?
|
|
|
|-
|-
|Were the people who responded prepared enough to respond effectively (0/5pt)
|Were the people who responded prepared enough to respond effectively  
|
|
|
|-
|-
|Did fewer than 5 people get paged (0/5pt)?
|Were fewer than five people paged?
|
|
|
|-
|-
|Were pages routed to the correct sub-team(s)?
| 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)
|Were pages routed to online (business hours) engineers? ''Answer “no” if engineers were paged after business hours.''
|
|
|
|-
|-
| rowspan="6" |'''Process'''
! rowspan="5" |Process
|Was the incident status section actively updated during the incident? (0/1pt)
|Was the incident status section actively updated during the incident?
|
|
|
|-
|-
|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)
|Was the public status page updated?
|
|
|
|-
|-
|Is there a phabricator task for the incident? (0/1pt)
|Is there a phabricator task for the incident?
|
|
|
|-
|-
|Are the documented action items assigned?  (0/1pt)
|Are the documented action items assigned?
|
|
|
|-
|-
|Is this a repeat of an earlier incident (-1 per prev occurrence)
|Is this incident sufficiently different from earlier incidents so as not to be a repeat occurrence?
|
|
|
|-
|-
|Is there an open task that would prevent this incident / make mitigation easier if implemented? (0/-1p per task)
! rowspan="5" |Tooling
|To the best of your knowledge was the open task queue free of any tasks that would have prevented this incident? ''Answer “no” if there are''
''open tasks that would prevent this incident or make mitigation easier if implemented.''
|
|
|
|-
|-
| rowspan="4" |'''Tooling'''
|Were the people responding able to communicate effectively during the incident with the existing 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)
|Did existing monitoring notify the initial responders?
|
|
|
|-
|-
|Were all engineering tools required available and in service? (0/5pt)
|Were the engineering tools that were to be used during the incident, available and in service?  
|
|
|
|-
|-
|Was there a runbook for all known issues present? (0/5pt)
|Were the steps taken to mitigate guided by an existing runbook?
|
|
|
|-
|-
| colspan="2" |'''Total Score'''
! colspan="2" align="right" |Total score (count of all “yes” answers above)
|
|
|
|}
|}
== 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>To do #1 (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>

Revision as of 21:14, 17 June 2022

document status: draft

Summary

Incident metadata (see Incident Scorecard)
Incident ID Lightweight 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.

Summary of what happened, in one or two paragraphs. Avoid assuming deep knowledge of the systems here, and try to differentiate between proximate causes and root causes.

Documentation:

Link to relevant source code, graphs, or logs

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.

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

Scorecard

Incident Engagement™ ScoreCard
Question Answer

(yes/no)

Notes
People Were the people responding to this incident sufficiently different than the previous five incidents?
Were the people who responded prepared enough to respond effectively
Were fewer than five people paged?
Were pages routed to the correct sub-team(s)?
Were pages routed to online (business hours) engineers? Answer “no” if engineers were paged after business hours.
Process Was the incident status section actively updated during the incident?
Was the public status page updated?
Is there a phabricator task for the incident?
Are the documented action items assigned?
Is this incident sufficiently different from earlier incidents so as not to be a repeat occurrence?
Tooling To the best of your knowledge was the open task queue free of any tasks that would have prevented this incident? Answer “no” if there are

open tasks that would prevent this incident or make mitigation easier if implemented.

Were the people responding able to communicate effectively during the incident with the existing tooling?
Did existing monitoring notify the initial responders?
Were the engineering tools that were to be used during the incident, available and in service?
Were the steps taken to mitigate guided by an existing runbook?
Total score (count of all “yes” answers above)