Service: Checkmate - EyevinnOSC/community GitHub Wiki

Checkmate

Checkmate (serviceId bluewave-labs-checkmate, catalog page) is an open source uptime and infrastructure monitoring tool. It is a long-running service instance. License: AGPL-3.0.

What it can do

  • Monitor HTTP/HTTPS endpoints (status code or response body), ping targets and TCP ports.
  • Show uptime percentage and response time history on a dashboard.
  • Send alerts when a monitor changes state (up to down, down to up) through channels such as email, Slack webhook or PagerDuty.
  • Invite additional users from the web UI.

Creating an instance

Call create-service-instance with serviceId: "bluewave-labs-checkmate". Only name is required (alphanumeric, at most 20 characters). No other OSC service is needed.

{ "name": "mycheckmate" }

With email notifications through your own SMTP server:

{
  "name": "mycheckmate",
  "SystemEmailHost": "smtp.example.com",
  "SystemEmailPort": "587",
  "SystemEmailAddress": "[email protected]",
  "SystemEmailPassword": "{{secrets.smtppwd}}"
}

Verify with wait-for-service-ready or get-instance-status, then use describe-service-instance for the URL. Open it: Checkmate has no default credentials and shows a registration form on first launch; the first account you create is the admin account.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
SystemEmailHost No string Hostname of the SMTP server Checkmate uses to send system emails. Catalog gives no description; meaning inferred from the name.
SystemEmailPort No string Port of that SMTP server.
SystemEmailAddress No string Email address (SMTP account) used as sender.
SystemEmailPassword No string, sensitive Password for that SMTP account. Store as a secret and pass {{secrets.NAME}}.

{{secrets.NAME}} must be the entire field value. Overwriting a secret does not restart a running instance.

Using the instance

  1. In the web UI choose Add Monitor and pick a type: HTTP/HTTPS, Ping or Port.
  2. Set the check interval and optional alert thresholds and save; checks start immediately.
  3. Add alert channels under Settings, Notifications. Invite users under Settings, Team.

Example with the OSC CLI:

npx @osaas/cli create bluewave-labs-checkmate mycheckmate

Resources