Skip to content
My Beast
Cart
Developer docsMenu

Status · Getting started

Quickstart

From a new project to a monitor that is up, an alert you have received and a public page, in four steps. All of it happens in the browser.

1. Choose a plan

On Status's page, pick a plan. At id.my-beast.com, name your project and pay. The project is then yours to open in Status, and you're its admin.

To open it, go to your project's page at id.my-beast.com and choose Status under Products. Its address has your workspace and project in it:

Address
https://services.my-beast.com/<workspace>/<project>/status

Until Status has checked something, the project opens on its setup guide, Start watching and the project's name. Its five steps are ticked as Status sees each one done; the first three are the ones below.

2. Add a monitor

On the setup guide, under Watch an address, choose Add HTTP check and fill in:

  • Name: as your team says it, such as "Website".
  • Address: the page to call, such as https://example.com/, or your Laravel app's /up.
  • Environment: picked from the address and the name as you type. Change it if the guess is wrong.
  • Check every: set to the shortest your plan allows. Shorter ones are shown, but can't be chosen.

Leave the rest as it is and choose Add HTTP check. Its first check runs within 15 seconds. When it comes back, the setup guide turns into the project's overview, and the check shows as Up under HTTP checks.

A public address

Status calls addresses on the internet only, never localhost or a private network. A site behind a firewall needs to let Status in: see Addresses Status calls.

To watch a job instead, choose Add heartbeat: give it a name, how often the job runs and a grace, then add it. Its page shows its ping address. Call it once from a terminal, and the heartbeat is up:

Terminal
curl -fsS -m 10 https://services.my-beast.com/status/ping/abc123def456ghi789jkl012

The answer is OK. Copy your own address from the heartbeat's page: the one above is an example. Watch a cron job has the lines for a crontab and for Laravel's scheduler.

3. Say who is told

Everyone who may open the project gets an email when a monitor goes down and when it's back, with nothing to set up. The people are the project's at id.my-beast.com.

To add a Telegram chat or a Slack channel, open the project's Settings, find Who gets told, and choose Set up on its row. Choose who's told explains each one, and webhooks for your own code.

Then choose Send a test alert, in Settings or on the setup guide. Each channel gets "Test: your project's alerts reach you", and the page says which ones took it.

To see a real down and its recovery without breaking anything, use a heartbeat. Ping it, then say its job failed: it's down at once, and the alert goes out within 15 seconds. Ping it again and it's up, and that is told too.

Terminal
curl -fsS -m 10 https://services.my-beast.com/status/ping/abc123def456ghi789jkl012
curl -fsS -m 10 https://services.my-beast.com/status/ping/abc123def456ghi789jkl012/fail
curl -fsS -m 10 https://services.my-beast.com/status/ping/abc123def456ghi789jkl012

4. Share the status page

Open the monitor and choose Change. Under Public status page, tick Show on the public page. You can give it another name and a group there, such as "API" in "Services". Choose Save.

Every page of the project now has a Public status page button, and step 5 of the setup guide gives the page's address, its feed and a badge. The page shows names, states and the last 90 days, never an address, and needs no sign-in.

Next steps