Skip to content

Open-source status page, incident response and uptime monitoring

πŸ“ docs update (#782)

Thibault Le Ouayab261c51b405
diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx
index 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.json
index 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.mdx
new file mode 100644
index 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 Paint
diff --git a/apps/docs/features/heartbeat.mdx b/apps/docs/synthetic/features/heartbeat.mdx
similarity index 100%
rename from apps/docs/features/heartbeat.mdx
rename to apps/docs/synthetic/features/heartbeat.mdx
diff --git a/apps/docs/features/incident.mdx b/apps/docs/synthetic/features/incident.mdx
similarity index 95%
rename from apps/docs/features/incident.mdx
rename to apps/docs/synthetic/features/incident.mdx
index 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 incident
We automatically resolve an incident when the monitor is passing in more than
50% of the locations.
diff --git a/apps/docs/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdx
similarity index 86%
rename from apps/docs/features/monitor.mdx
rename to apps/docs/synthetic/features/monitor.mdx
index 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.mdx
similarity index 67%
rename from apps/docs/features/notification.mdx
rename to apps/docs/synthetic/features/notification.mdx
index 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.mdx
similarity index 100%
rename from apps/docs/features/notification/discord.mdx
rename to apps/docs/synthetic/features/notification/discord.mdx
diff --git a/apps/docs/features/notification/email.mdx b/apps/docs/synthetic/features/notification/email.mdx
similarity index 100%
rename from apps/docs/features/notification/email.mdx
rename to apps/docs/synthetic/features/notification/email.mdx
diff --git a/apps/docs/features/notification/phone-call.mdx b/apps/docs/synthetic/features/notification/phone-call.mdx
similarity index 100%
rename from apps/docs/features/notification/phone-call.mdx
rename to apps/docs/synthetic/features/notification/phone-call.mdx
diff --git a/apps/docs/features/notification/slack.mdx b/apps/docs/synthetic/features/notification/slack.mdx
similarity index 100%
rename from apps/docs/features/notification/slack.mdx
rename to apps/docs/synthetic/features/notification/slack.mdx
diff --git a/apps/docs/features/notification/sms.mdx b/apps/docs/synthetic/features/notification/sms.mdx
similarity index 100%
rename from apps/docs/features/notification/sms.mdx
rename to apps/docs/synthetic/features/notification/sms.mdx
diff --git a/apps/docs/features/notification/telegram.mdx b/apps/docs/synthetic/features/notification/telegram.mdx
similarity index 100%
rename from apps/docs/features/notification/telegram.mdx
rename to apps/docs/synthetic/features/notification/telegram.mdx
diff --git a/apps/docs/features/status-page-subscribers.mdx b/apps/docs/synthetic/features/status-page-subscribers.mdx
similarity index 100%
rename from apps/docs/features/status-page-subscribers.mdx
rename to apps/docs/synthetic/features/status-page-subscribers.mdx
diff --git a/apps/docs/features/status-page.mdx b/apps/docs/synthetic/features/status-page.mdx
similarity index 60%
rename from apps/docs/features/status-page.mdx
rename to apps/docs/synthetic/features/status-page.mdx
index 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.mdx
similarity index 100%
rename from apps/docs/features/status-report.mdx
rename to apps/docs/synthetic/features/status-report.mdx
diff --git a/apps/docs/features/status-widget.mdx b/apps/docs/synthetic/features/status-widget.mdx
similarity index 100%
rename from apps/docs/features/status-widget.mdx
rename to apps/docs/synthetic/features/status-widget.mdx
diff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdx
new file mode 100644
index 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.