Jump to content

Template:Incident scorecard

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

Incident metadata table.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Incident IDid

Date in ISO format followed by a a subject e.g. "appserver latency" or "codfw networking". On Wikitech this will automatically default to the page title. It does not need to be set.

Default
(Automatic based on page title)
Stringoptional
Phabricator tasktask

If one does not exist, create it. It could just be a parent task for the actionables. Title of task can be "Incident: <Incident ID>", The task ID will be linked automatically.

Example
T00000
Stringsuggested
Paged peoplepaged-num

The number of people that were paged.

Example
0 or more
Auto value
Numberrequired
Respondersresponders-num

How many people were responding or helping with the incident.

Example
1 or more
Auto value
Numberrequired
Coordinator(s)coordinators

Names of ICs (incident coordinators). Remember to parse the timeline for IC role handovers.

Example
Names
Stringrequired
Start (UTC)start

Start of the incident impact

Example
YYYY-MM-DD hh:mm:ss
Daterequired
End (UTC)end

End of the incident impact

Example
YYYY-MM-DD hh:mm:ss
Daterequired
Affected SLOs or metricsmetrics

If an SLO exists, mention it. Otherwise mention "No relevant SLOs exist", followed by relevant metrics that help quantify the incident’s impact.

Contentsuggested
Impactimpact

Impact in one or two sentences. 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.

Example
For 5 minutes, service .. was .., which affected ..
Stringsuggested