Octri

monitoring incidents

Lists the incidents on your status page, newest first, with each one's status, impact, when it started and how many updates it has. What you post is public as soon as it's written: there's no draft and no publish.

bash
octri monitoring incidents [list | show | create | post | resolve | update | delete]

Flags

--openboolean

Leaves out resolved incidents.

octri monitoring incidents show <id>

Prints one incident and its timeline, oldest update first.

Arguments

<id>stringrequired

The incident.

octri monitoring incidents create <title>

Opens an incident.

Arguments

<title>stringrequired

What readers see as the headline.

Flags

--message <text>stringrequired

The first update readers see.

--status <status>string

investigating, identified, monitoring or resolved.

--impact <impact>string

minor, major, critical or maintenance.

--checks <ids>list

The IDs of the checks it affects.

octri monitoring incidents post <id>

Adds an update to the timeline.

Arguments

<id>stringrequired

The incident.

Flags

--message <text>stringrequired

The update's text. The words after the ID work too.

--status <status>string

Moves the incident on, such as to identified.

octri monitoring incidents resolve <id>

Posts the closing update and marks the incident resolved.

Arguments

<id>stringrequired

The incident.

Flags

--message <text>stringdefault: This incident has been resolved.

The closing update.

octri monitoring incidents update <id>

Changes the incident itself rather than its timeline.

Arguments

<id>stringrequired

The incident.

Flags

--title <text>string

A new headline.

--impact <impact>string

A new impact.

--checks <ids>list

Replaces the affected checks.

octri monitoring incidents delete <id> --yes

Deletes the incident and every update on it. Resolve it instead to keep the record.

Arguments

<id>stringrequired

The incident.

Flags

--yesbooleanrequired

Confirms the delete.

Examples

Open an incident

bash
octri monitoring incidents create "Elevated checkout errors" --message "We are seeing failed payments and are looking into it." --impact major
Output
✔ Opening the incident
✔ Incident Elevated checkout errors is on the status page (7fbbea1a-b853-4e71-83a6-8d3ce75fd940)
  octri monitoring incidents post 7fbbea1a-b853-4e71-83a6-8d3ce75fd940 --status identified --message "…"

Post an update

bash
octri monitoring incidents post 7fbbea1a-b853-4e71-83a6-8d3ce75fd940 --status identified --message "A bad deploy. Rolling back now."
Output
✔ Posting the update
✔ Posted to Elevated checkout errors: now identified

Resolve it

bash
octri monitoring incidents resolve 7fbbea1a-b853-4e71-83a6-8d3ce75fd940
Output
✔ Resolving
✔ Elevated checkout errors is resolved.

Read the timeline

bash
octri monitoring incidents show 7fbbea1a-b853-4e71-83a6-8d3ce75fd940
Output
✔ Loading incident

Elevated checkout errors
  status    resolved
  impact    major
  started   1s ago
  resolved  0s ago

  investigating 1s ago · Dana Reyes-Park
    We are seeing failed payments and are looking into it.

  identified 1s ago · Dana Reyes-Park
    A bad deploy. Rolling back now.

  resolved 0s ago · Dana Reyes-Park
    This incident has been resolved.