Skip to content
My Beast
Cart
Developer docsMenu

Incidents · Getting started

Quickstart

From a project without Incidents to a resolved incident with a write-up, in five steps, all in the browser.

1. Add Incidents to a project

At id.my-beast.com/start, pick Incidents and a plan, name your project and pay. If you have a workspace already, its owners add Incidents to a project on the workspace's Subscription page at id instead. Plans and prices are on Incidents' page.

Then open Incidents in the project: services.my-beast.com/<workspace>/<project>/incidents, or choose it in the product menu of the top bar. Its Overview is where the project's incidents will be.

Everyone who runs incidents needs to be in the project. You add people on the project's People page at id, each with a role: Triage or Admin to declare and run incidents, Viewer to read them.

2. Say who is told

Until you change it, every notice goes by email to the project's people: everyone who opens the project in Incidents. To tell a team chat as well:

  1. Open the project's Settings → Notices, at services.my-beast.com/<workspace>/<project>/settings/notices.
  2. Under Destinations, add A Telegram chat (its chat id, and a bot token from @BotFather) or A Slack channel (an incoming webhook address).
  3. Under What goes where, choose Change beside Incidents, tick the new destination for each kind of notice and save.

Then check that it arrives: in Incidents, open Settings in the sidebar and choose Send a test under Notices. A test goes to every destination of the project and to your own email, and the page says how each one went. Tell your team has the details.

3. Declare an incident

On Incidents' Overview, choose Declare an incident. Fill in what is wrong, pick a severity, and choose Declare. You lead it unless you pick someone else.

The incident opens at Investigating with its reference, INC-1 for the project's first, and the project's people are told at once.

Trying it out

Every incident counts toward the month's, so for a first try declare a SEV3 with a title that says it is a test. When you are done, move it to Declined, which says it wasn't an incident after all.

4. Run it to Resolved

The head of the incident's page shows the way to Resolved, with the next step one click away:

  1. Write what you found in Post an update, at the end of the timeline, and choose Post and move to Identified. The update goes out with the notice.
  2. When the fix is out, post again and move it to Monitoring. Then Post and resolve.

Each change is a line on the timeline, and each move is a notice. Run an incident covers severity, the lead and internal notes.

5. Follow up and write it up

Once it is resolved, the incident's page has two more parts to fill in:

  • Follow-ups: what to do so it doesn't happen again, each with an owner and the day it is due.
  • Write-up: what happened, the cause and what you change. What happened starts from the timeline, so you edit it rather than start from nothing.

Next steps