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>Krinkle
m (Krinkle moved page Incident documentation/-Lightweight Report Template to Incident response/Lightweight report template without leaving a redirect: Move to Incident response so that the "-" hack isn't needed, simplifying parsing of incident docs)
 
imported>Krinkle
No edit summary
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>{{Navigation Incidents}}
{{Note|
{{Note|To use this template:
This is the template for a lightweight incident report.
* Go to '''[[Incident status]]'''
* To use it: Submit the form at [[Incident documentation]], then replace the marked placeholders with your own text.
* Fill in the "Lightweight" form to auto-create a report page with today's date.
* You should '''name''' it in this style: "''$NameOfService''".
 
* Save early, save often.
(Do not edit or copy this page directly.)|type=warning}}
* It will automatically be saved as a subpage of [[Incident documentation]], with the "YYYYMMDD-" timestamp as a prefix like the others.
</noinclude>{{irdoc|status=<includeonly>draft</includeonly>}}
 
== Summary ==
{{Incident scorecard
| task =
| paged-num =
| responders-num =
| coordinators =
| start =
| end =
}}
}}
</noinclude>{{irdoc|status=<includeonly>draft</includeonly>}} <!--
<!-- Reminder: No private information on this page! -->
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 ==
<mark>What happened? Write one paragraph or at most two, including UTC timestamps for key events like the start and end of the outage. Briefly assess the impact: for user-facing outages, estimate how many queries were lost, how many users were affected, or which populations (editors? readers? particular geographies?), etc.</mark>
 
<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>
 
'''Documentation''':
* …
 
<mark>Link to relevant source code, graphs, or logs</mark>
 
==Actionables==


<mark>Avoid assuming deep knowledge of the systems here -- but if the incident is too complex to sum up in a couple of paragraphs, this lightweight format may be a bad fit.</mark><!-- Reminder: No private information on this page! -->
* …


== 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>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>To do #2 (TODO: Create task)</mark>
 
==Scorecard==


<mark>TODO: Add the [[phab:project/view/4758/|#Sustainability (Incident Followup)]] Phabricator tag to these tasks.</mark>
{| class="wikitable"
|+[[Incident Scorecard|Incident Engagement™  ScoreCard]]
!
!Question
!Answer
(yes/no)
!Notes
|-
! rowspan="5" |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.''
|
|
|-
! rowspan="5" |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?
|
|
|-
! 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.''
|
|
|-
|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?
|
|
|-
! colspan="2" align="right" |Total score (count of all “yes” answers above)
|
|
|}

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)