Incident methods: acknowledge, open, resolve

Reference for Incident, one group of Incident methods.

Incident.acknowledge

Acknowledge records that an on-call Worker owns an open Incident and stops its escalation. Verb page.

TypeScript

interface IncidentVerbs {
  acknowledge(input: IncidentAcknowledgeInput, options?: SB.CallOptions): SB.Call<Incident>
}

Inputs

Input	Type	Required	Description
`incident`	Incident	required	The open Incident.

Returns

Output	Type	Required	Description
`incident`	Incident	required	The acknowledged Incident.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const incident = await $.Incident.acknowledge({ incident: 'incident_2XOYkIEno0' })

Open starts an Incident from a failing Monitor, an error spike or a Metric past its threshold, and pages the on-call Worker. Verb page.

TypeScript

interface IncidentVerbs {
  open(input: IncidentOpenInput, options?: SB.CallOptions): SB.Call<Incident>
}

Inputs

Input	Type	Required	Description
`severity`	`string`	required	`sev1` stops Customers, `sev2` degrades a core path, `sev3` degrades one feature.
`cause`	`string`	required	The Monitor, error group or Metric that tripped it.

Returns

Output	Type	Required	Description
`incident`	Incident	required	The open Incident.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const incident = await $.Incident.open({ severity: 'sev1', cause: 'Example cause' })

Resolve closes an Incident once its Monitors pass, posts the resolution to the status page and opens the review Task. Verb page.

TypeScript

interface IncidentVerbs {
  resolve(input: IncidentResolveInput, options?: SB.CallOptions): SB.Call<Incident>
}

Inputs

Input	Type	Required	Description
`incident`	Incident	required	The Incident to close.
`summary`	`text`	required	What failed and what fixed it.

Returns

Output	Type	Required	Description
`incident`	Incident	required	The resolved Incident.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const incident = await $.Incident.resolve({ incident: 'incident_2XOYkIEno0', summary: 'Example summary' })