Skip to content

Quickstart

By the end of this page you have:

  • an organization in SREInsights,
  • a runner that can run checks,
  • a monitor that checks a website every two minutes,
  • a channel and a route, so a failure reaches you.

You need a website to check, and either a host with Docker (for your own runner) or an instance that offers hosted runners. console.sreinsights.com is the hosted product; on your own instance, use its URL instead.

  1. Open SREInsights and choose to sign up.
  2. Enter Your name, Organization (your company or team), Email and Password.
  3. Submit. SREInsights creates the organization and signs you in as its Owner.

The Overview page opens with a Get started card. It tracks the same steps as this page, and each step opens the right form.

Every check runs on a runner. Pick one of these.

If your instance offers hosted runners, the Get started card says “Hosted runners are ready”, and the Runner group list in the monitor form shows them under their own heading. Hosted runners reach public addresses only. That is enough for a website. Skip to step 3.

Or install your own runner (about 3 minutes)

Section titled “Or install your own runner (about 3 minutes)”
  1. Go to Runners and select New runner group.

  2. Keep Runs on at Runners you host. Name the group, for example office or prod-eu. Use lower-case letters, digits, ., _ or -.

  3. Select Create group, then Add runner on the new group.

  4. Keep the defaults (one runner, valid for 24 hours) and select Create install command.

  5. Copy the command and run it on a host with Docker:

    Terminal window
    docker run -d --name sreinsights-runner --restart unless-stopped --stop-timeout 40 \
    -e SREINSIGHTS_URL=https://console.sreinsights.com \
    -e SREINSIGHTS_REGISTRATION_TOKEN=prt_… \
    -v sreinsights-runner:/var/lib/sreinsights-runner \
    ghcr.io/bintree-softwares/sreinsights-runner:latest
  6. Wait until the drawer says the runner registered and is online.

  1. Go to Monitors and select New monitor.
  2. Open the Templates tab and choose Website is up. It checks that the page answers 200 within 5 seconds, every 2 minutes, and records the TLS certificate.
  3. Change the URL to your website.
  4. Under Runner group, choose your group or a hosted location.
  5. Select Create monitor.

The monitor’s page opens. Select Run now to run it at once instead of waiting for the schedule. The run shows in the history with its status, duration and what it found.

A monitor with no alert rules raises a high alert called Check failing when a run fails, and resolves it when a run succeeds again. You can add alert rules later, for example “3 of the last 5 runs failed”.

Until a channel exists, alerts show only in SREInsights, on the Alerts page. Connect a channel. This example uses Telegram; Send alerts to your team covers Slack, email, SNS and the rest.

  1. Create a Telegram bot with @BotFather and copy its token. Add the bot to the chat that should get alerts.
  2. Go to Connections and select Connect on the Telegram card. Enter a name, the Bot token and, optionally, a Default chat id (group ids start with -100). Select Connect to save it.
  3. Go to Notifications and select New channel. Choose the Telegram connection, give the channel a Name such as Ops chat, and select Add channel.
  4. Under Routes, select Add route. Leave Severity and Labels empty to match every alert, and choose your channel under Send to.
  5. Select Save routes.

Use Try an alert next to the routes to see which route a critical alert would take before you save.

To test the whole path, make the check fail on purpose:

  1. Open the monitor, edit it, and change the URL to a page that does not exist on your site, such as https://www.example.com/this-page-does-not-exist.
  2. Save, then select Run now.
  3. The run fails. Within seconds, an alert opens on Alerts and a message reaches your chat.
  4. Change the URL back and select Run now again. The alert resolves, and the chat gets the resolve notice.

On the alert’s page you see its Timeline (every change and who made it) and Notifications (what each channel was sent, and whether it went through). Acknowledge tells your team someone is on it; the acknowledgement goes to every channel the alert reached.