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

Template:Incident scorecard

From Wikitech-static
Jump to navigation Jump to search
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.

<templatedata> { "params": { "id": { "label": "Incident ID", "description": "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.", "type": "string", "default": "(Automatic based on page title)" }, "start": { "label": "Start (UTC)", "description": "Start of the incident impact", "example": "YYYY-MM-DD hh:mm:ss", "type": "date", "required": true }, "task": { "label": "Phabricator task", "example": "T00000", "type": "string", "description": "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.", "suggested": true }, "end": { "label": "End (UTC)", "description": "End of the incident impact", "example": "YYYY-MM-DD hh:mm:ss", "type": "date", "required": true }, "paged-num": { "type": "number", "required": true, "example": "0 or more", "autovalue": "", "label": "Paged people", "description": "The number of people that were paged." }, "responders-num": { "label": "Responders", "description": "How many people were responding or helping with the incident.", "example": "1 or more", "type": "number", "autovalue": "", "required": true }, "coordinators": { "description": "Names of ICs (incident coordinators). Remember to parse the timeline for IC role handovers.", "example": "Names", "type": "string", "label": "Coordinator(s)", "required": true }, "metrics": { "label": "Affected SLOs or metrics", "description": "If an SLO exists, mention it. Otherwise mention \"No relevant SLOs exist\", followed by relevant metrics that help quantify the incident’s impact.", "type": "content", "suggested": true }, "impact": { "label": "Impact", "description": "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 ..", "type": "string", "suggested": true } }, "paramOrder": [ "id", "task", "paged-num", "responders-num", "coordinators", "start", "end", "metrics", "impact" ], "format": "block", "description": "Incident metadata table." } </templatedata>