Docs
What each part of StatOSS does, and how to set it up.
Northwind is up.
All 2 monitors are responding, 2 failed checks in the last 24 hours.
Website
Up for 23 h 57 min100% passed
1,436 checks, median 139 ms, all passed
95% under 202 ms
API
Up for 15 h99.86% passed
1,436 checks, median 205 ms, 2 timeouts
95% under 304 ms
- Timed out2 min, 2 checks
What StatOSS is
StatOSS hosts status pages and runs the checks behind them. It requests each monitor every minute (every 5 minutes on Free) from four regions (Europe, North America, Asia and Oceania) and shows every failed check on the page with its time and reason. When a monitor goes down you are alerted, an incident opens on the page, and subscribers hear about it.
A page can be private or served from your own domain, and a Pro team can run pages together. The API and the MCP server do what the dashboard does, including setting up an account. The core is open source under the MIT license and runs on your own server; Plans, billing and data says how.
First steps
A status page
- 1Create an account and name the page. The name goes in the headline, as in "Northwind is up."
- 2Add each thing to check, or import what another service has. A URL is the default; the other types are in the type picker.
- 3Choose where alerts go, then share the address. The page is public from the start and the first check runs within a minute.
On-call alerts
- 1Add a source under a page's Alerts, Sources, and point PagerDuty, Opsgenie or Sentry senders at it.
- 2Choose where alerts go and when they repeat until someone acknowledges.
- 3On Pro, add escalation policies and schedules.
Errors from an app
- 1Make an app under Apps and copy its DSN.
- 2Put the DSN in any Sentry SDK, in @statoss/sdk or in the Python statoss package, as Send errors shows.
- 3Read the issues and set alert rules.
Logs from an app
- 1Make an app under Apps and copy its key.
- 2Send lines from an SDK, OpenTelemetry, a drain or plain JSON, as Send logs shows.
- 3Search them, follow them live, and set log alerts.
All pages
Start
- Importing
- Moving in from UptimeRobot, Better Stack, Statuspage or a CSV, and subscribers from a CSV.
- Teams
- Inviting people, roles, what seats cost on Pro, working in several teams.
- Plans, billing and data
- What each plan holds, how billing works, your data, self-hosting.
Status pages
- The status page
- Reading the strips, the headline and the error budget. Logo, colours, time zone, and the password.
- Incidents and maintenance
- Opening, updating and resolving. Maintenance windows, templates, and what subscribers hear.
- Subscribers
- The subscribe box, per-monitor subscriptions, webhook subscribers and the signed payload.
- Feeds and embeds
- status.json, the badge, RSS and Atom, the widget, llms.txt. Embedding a locked page.
- Addresses and domains
- Assigned addresses, your own domain, one-click DNS.
Monitoring
- Checks
- HTTP, TCP, DNS, ping, certificate, domain expiry, heartbeat and components. The second opinion, the slow state, groups.
- Alerts
- Email, Slack, Discord, Microsoft Teams, Telegram, PagerDuty, Opsgenie, Pushover, ntfy and your own webhook, with its signature.
- Deploy markers
- Marking releases on the response-time chart from CI.
On-call
- On-call
- Sources for PagerDuty, Opsgenie and Sentry senders, issue alerts, repeats until acknowledged, escalation, schedules, the import.
Errors
- Errors
- Issues and grouping, alert rules, releases and source maps, an app's own levels, categories and fields, limits.
- Send errors
- The DSN, @statoss/sdk, the Python statoss package, any Sentry SDK, and moving from Sentry.
Logs
API and reference
- API
- Keys and scopes, every endpoint with its fields and examples, errors and limits.
- MCP and agents
- The MCP endpoint next to every page, the keyed ones over the account, signing in with OAuth, Connected apps.
- Search language
- One search language in Issues, Explore and Logs: words, regular expressions, fields, wildcards, lists, comparisons and Sentry's terms.
Help
The help center searches these docs and takes a message; a person reads it. Our own status page is at statoss.statoss.com, and the changelog says what changed and when.