Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
docs: update private location limitations (#2521)
Max3fa0e17d57d5
diff --git a/apps/web/src/content/pages/docs/concept/private-locations.mdx b/apps/web/src/content/pages/docs/concept/private-locations.mdxindex a1f955ace..7dba255d9 100644--- a/apps/web/src/content/pages/docs/concept/private-locations.mdx+++ b/apps/web/src/content/pages/docs/concept/private-locations.mdx@@ -39,8 +39,8 @@ The consequence is that you only need **outbound** network access from the probe| Network reach | Public internet only | Whatever the probe host can reach || IPs to allowlist | [Documented per region](/docs/reference/location) | Yours || Cost model | Included with monitor checks | You pay for the host/container |-| Auto-incident & alerts | Yes | Not yet (see limitations below) |-| Use on public status pages | Yes | Not yet (see limitations below) |+| Auto-incident & alerts | Yes | Yes |+| Use on public status pages | Yes | Yes |A monitor can be assigned to public locations, private locations, or both. Public-and-private hybrids are useful when you want a public probe for SLA reporting and a private probe for in-network diagnostics on the same endpoint.@@ -52,13 +52,6 @@ Running a private location moves operational responsibility to you. Plan for:- **Token handling.** The probe's token authenticates it as your workspace. Inject it as an environment variable, store it the same way you store other secrets, and rotate it if a host is decommissioned.- **Egress only.** Because the connection is outbound, an egress firewall that blocks `api.openstatus.dev:443` will silently stop the probe from running checks. The probe will appear "connected" briefly and then go quiet.-## Current limitations--- **No automatic incidents.** A failing check from a private location does not currently open an incident or fire notifications. If you need alerting today, keep at least one public location on the monitor.-- **Not displayed on public status pages.** Monitors assigned only to private locations won't appear on a public status page as a monitor-linked component.--Both are tracked and expected to land — when they do, the [private location reference](/docs/reference/private-location) will reflect the change.-## Next steps- **[Set up a private location](/docs/guides/how-to-create-private-location)** — step-by-step deployment of the Docker probe.diff --git a/apps/web/src/content/pages/docs/reference/private-location.mdx b/apps/web/src/content/pages/docs/reference/private-location.mdxindex 46a21438c..44219f33e 100644--- a/apps/web/src/content/pages/docs/reference/private-location.mdx+++ b/apps/web/src/content/pages/docs/reference/private-location.mdx@@ -12,6 +12,7 @@ A private location in openstatus lets you deploy monitoring probes within your o- **Security** — keep sensitive internal endpoints protected from public exposure.- **Compliance** — meet specific regulatory or security compliance requirements by controlling data paths.- **Reduced latency** — conduct checks closer to your services for more accurate performance metrics.+- **Full feature parity** — automatic incident creation, notifications, and status page display work the same as public locations.## How it works@@ -36,10 +37,10 @@ Detailed steps for setting up a private location involve:Private locations can currently be created, listed, updated, and deleted from the authenticated dashboard API. The supported private location fields are:- `name` — the display name shown in the dashboard.-- `token` — the probe authentication token. Generated by the server on creation and returned by create and get; list responses omit it.+- `token` — the probe authentication token. Generated by the server on creation. Returned by create, get, and update endpoints; list responses omit it for security.- `status` — read-only probe health, `active` or `error`, derived from the agent heartbeat.- `metadata` — up to 20 user-defined key/value labels (keys 1–64 characters, values up to 256 characters), for example `{"city": "Frankfurt", "provider": "Hetzner"}`.-- `monitors` — the monitor IDs attached to the private location.+- `monitors` — the IDs of monitors attached to the private location.- `lastSeenAt` — the last time the private location probe connected.**Example use cases:**