Open-source status page, incident response and uptime monitoring
TypeScript alertingincident-managementmcpmcp-servermonitoringmonitoring-as-codeobservabilityon-callopen-sourcesrestatus-pagestatuspagesynthetic-monitoringterraformtinybirdtursouptimeuptime-checkeruptime-monitor
π docs update (#782)
Thibault Le Ouayab261c51b405
diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdxindex 628dbafc9..cbfc99832 100644--- a/apps/docs/introduction.mdx+++ b/apps/docs/introduction.mdx@@ -2,25 +2,25 @@title: What is OpenStatus?----OpenStatus is an open-source website and API monitoring service with a beautiful-status page and incident management.+OpenStatus is an open-source synthetic and frontend performance monitoring+service.-We allow to monitor the uptime and performance of your websites and APIs from-multiple locations around the world and notify you when something goes wrong.+## Products-## Trying OpenStatus--The easiest way to quickly try the app is to signup on-[www.openstatus.dev](https://www.openstatus.dev)+OpenStatus is composed of two products:-The signup is free.+<CardGroup cols={2}>+ <Card title="Synthetic Monitoring" href="/synthetic">+ Monitor your website or API availability and+ performance from different locations around the world.+ </Card>+ <Card title="Real User Monitoring" href="/rum">+ Monitor your website performance from your users' browsers.+ </Card>-## Getting Started+</CardGroup>-There are three ways to get started with OpenStatus.+## Trying OpenStatus-- **Cloud**: the fastest and easiest way to try the app (it's free)-- **Local**: if you're a developer and would like to experiment or contribute to- the app-- **Self-hosting**: if you want greater control over your data and want to run- the app on your own server+The easiest way to quickly try the app is to signup on+[www.openstatus.dev](https://www.openstatus.dev)diff --git a/apps/docs/mint.json b/apps/docs/mint.jsonindex 7efd5fd57..4cc6e0ed5 100644--- a/apps/docs/mint.json+++ b/apps/docs/mint.json@@ -73,32 +73,42 @@"pages": ["introduction"]},{- "group": "Features",+ "group": "Synthetic Monitoring","pages": [- "features/incident",- "features/heartbeat",- "features/monitor",+ "synthetic/overview",{- "group": "Notifications",+ "group": "Features","pages": [- "features/notification",+ "synthetic/features/incident",+ "synthetic/features/heartbeat",+ "synthetic/features/monitor",{- "group": "Notification Channels",+ "group": "Notifications","pages": [- "features/notification/discord",- "features/notification/phone-call",- "features/notification/slack",- "features/notification/sms",- "features/notification/telegram"+ "synthetic/features/notification",+ {+ "group": "Notification Channels",+ "pages": [+ "synthetic/features/notification/discord",+ "synthetic/features/notification/phone-call",+ "synthetic/features/notification/slack",+ "synthetic/features/notification/sms",+ "synthetic/features/notification/telegram"+ ]+ }]- }+ },+ "synthetic/features/status-page",+ "synthetic/features/status-report",+ "synthetic/features/status-page-subscribers"]- },- "features/status-page",- "features/status-report",- "features/status-page-subscribers"+ }]},+ {+ "group": "Real User Monitoring",+ "pages": ["rum/overview"]+ },{"group": "Developer Tools","pages": [diff --git a/apps/docs/rum/overview.mdx b/apps/docs/rum/overview.mdxnew file mode 100644index 000000000..976bef7df--- /dev/null+++ b/apps/docs/rum/overview.mdx@@ -0,0 +1,20 @@+---+title: Overview+description: "How does OpenStatus' real user monitoring work?"+---++With our real user monitoring, you can track the performance of your website+from your users' browsers.++You install a small JavaScript snippet on your website, and we will record the+performance metrics of your website for each user.++## Metrics π++We are currently tracking the following metrics:++- **TTFB**: Time to First Byte+- **FCP**: First Contentful Paint+- **LCP**: Largest Contentful Paint+- **CLS**: Cumulative Layout Shift+- **INP**: Interaction to Next Paintdiff --git a/apps/docs/features/heartbeat.mdx b/apps/docs/synthetic/features/heartbeat.mdxsimilarity index 100%rename from apps/docs/features/heartbeat.mdxrename to apps/docs/synthetic/features/heartbeat.mdxdiff --git a/apps/docs/features/incident.mdx b/apps/docs/synthetic/features/incident.mdxsimilarity index 95%rename from apps/docs/features/incident.mdxrename to apps/docs/synthetic/features/incident.mdxindex c194dda88..594e2d930 100644--- a/apps/docs/features/incident.mdx+++ b/apps/docs/synthetic/features/incident.mdx@@ -17,7 +17,7 @@ Go to the incident page and click on the acknowledge button.Go to the incident page and click on the resolve button.-## Auto resolve an incident π+## Auto resolve an incidentWe automatically resolve an incident when the monitor is passing in more than50% of the locations.diff --git a/apps/docs/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdxsimilarity index 86%rename from apps/docs/features/monitor.mdxrename to apps/docs/synthetic/features/monitor.mdxindex 8d2d4bdcf..d343b6ce5 100644--- a/apps/docs/features/monitor.mdx+++ b/apps/docs/synthetic/features/monitor.mdx@@ -70,3 +70,15 @@ your monitor name.#### Timeout β³You can define a **timeout** for your request. The default value is `30s`.++#### Assertions π§ͺ++You can add **assertions** to your monitor. An assertion is a condition that+needs to be met for the monitor to be considered successful.++You can add multiple assertions to your monitor.++We currently support the following assertions on the following fields:++- **Status Code**+- **Response Body**diff --git a/apps/docs/features/notification.mdx b/apps/docs/synthetic/features/notification.mdxsimilarity index 67%rename from apps/docs/features/notification.mdxrename to apps/docs/synthetic/features/notification.mdxindex e61e0d8ec..194e8b2b7 100644--- a/apps/docs/features/notification.mdx+++ b/apps/docs/synthetic/features/notification.mdx@@ -17,16 +17,16 @@ created.## Notification channels<CardGroup cols={2}>- <Card title="Email βοΈ" href="/features/notification/email">+ <Card title="Email βοΈ" href="/synthetic/features/notification/email">Receive an email</Card>- <Card title="Slack π£" href="/features/notification/slack">+ <Card title="Slack π£" href="/synthetic/features/notification/slack">Get notified on Slack</Card>- <Card title="Discord π€" href="/features/notification/discord">+ <Card title="Discord π€" href="/synthetic/features/notification/discord">Get notified on Discord</Card>- <Card title="SMS π±" href="/features/notification/sms">+ <Card title="SMS π±" href="/synthetic/features/notification/sms">Receive a text message</Card></CardGroup>diff --git a/apps/docs/features/notification/discord.mdx b/apps/docs/synthetic/features/notification/discord.mdxsimilarity index 100%rename from apps/docs/features/notification/discord.mdxrename to apps/docs/synthetic/features/notification/discord.mdxdiff --git a/apps/docs/features/notification/email.mdx b/apps/docs/synthetic/features/notification/email.mdxsimilarity index 100%rename from apps/docs/features/notification/email.mdxrename to apps/docs/synthetic/features/notification/email.mdxdiff --git a/apps/docs/features/notification/phone-call.mdx b/apps/docs/synthetic/features/notification/phone-call.mdxsimilarity index 100%rename from apps/docs/features/notification/phone-call.mdxrename to apps/docs/synthetic/features/notification/phone-call.mdxdiff --git a/apps/docs/features/notification/slack.mdx b/apps/docs/synthetic/features/notification/slack.mdxsimilarity index 100%rename from apps/docs/features/notification/slack.mdxrename to apps/docs/synthetic/features/notification/slack.mdxdiff --git a/apps/docs/features/notification/sms.mdx b/apps/docs/synthetic/features/notification/sms.mdxsimilarity index 100%rename from apps/docs/features/notification/sms.mdxrename to apps/docs/synthetic/features/notification/sms.mdxdiff --git a/apps/docs/features/notification/telegram.mdx b/apps/docs/synthetic/features/notification/telegram.mdxsimilarity index 100%rename from apps/docs/features/notification/telegram.mdxrename to apps/docs/synthetic/features/notification/telegram.mdxdiff --git a/apps/docs/features/status-page-subscribers.mdx b/apps/docs/synthetic/features/status-page-subscribers.mdxsimilarity index 100%rename from apps/docs/features/status-page-subscribers.mdxrename to apps/docs/synthetic/features/status-page-subscribers.mdxdiff --git a/apps/docs/features/status-page.mdx b/apps/docs/synthetic/features/status-page.mdxsimilarity index 60%rename from apps/docs/features/status-page.mdxrename to apps/docs/synthetic/features/status-page.mdxindex acf2faa85..d770a3335 100644--- a/apps/docs/features/status-page.mdx+++ b/apps/docs/synthetic/features/status-page.mdx@@ -11,3 +11,9 @@ In order to create your status page, you need to create at least one monitor.alt="Create your status page"/></Frame>++## What is a status page π§βπ«++A status page is a public page that displays the status and performance of your+services. It shows the current status of your services and the history of+incidents.diff --git a/apps/docs/features/status-report.mdx b/apps/docs/synthetic/features/status-report.mdxsimilarity index 100%rename from apps/docs/features/status-report.mdxrename to apps/docs/synthetic/features/status-report.mdxdiff --git a/apps/docs/features/status-widget.mdx b/apps/docs/synthetic/features/status-widget.mdxsimilarity index 100%rename from apps/docs/features/status-widget.mdxrename to apps/docs/synthetic/features/status-widget.mdxdiff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdxnew file mode 100644index 000000000..5bd9dec7c--- /dev/null+++ b/apps/docs/synthetic/overview.mdx@@ -0,0 +1,30 @@+---+title: Overview+description: "How does OpenStatus' synthetic monitoring work?"+---++With our synthetic monitoring, you can track the availability and performance of+your website or API from various global locations.++We will monitor your website or API on a regular schedule and record the+responses.++## Locations π++We currently support 6 regions:++- `ams` - Amsterdam, Netherlands - π³π±+- `iad` - Ashburn, Virginia, USA - πΊπΈ+- `jnb` - Johannesburg, South Africa - πΏπ¦+- `gru` - SΓ£o Paulo, Brazil - π§π·+- `hkg` - Hong Kong, Hong Kong - ππ°+- `syd` - Sydney, Australia - π¦πΊ++## Status Page π++You can create a status page to display the availability and performance of your+monitor to your users.++## Alerting π¨++You can configure alerts to be notified when your monitor is down or slow.