openstatus.dev
Openstatus
www.openstatus.dev
📝 docs (#852)
authored by
Thibault Le Ouay
and committed by
GitHub
16e85345
3ef0a271
+77
-39
+1
-1
apps/docs/mint.json
+1
-1
apps/docs/mint.json
+46
apps/docs/rum/get-started.mdx
+46
apps/docs/rum/get-started.mdx
···
1
+
---
2
+
title: Get Started
3
+
description: "How to start using OpenStatus' real user monitoring"
4
+
---
5
+
## Get Started 🚀
6
+
7
+
In order to start using OpenStatus' real user monitoring, you need to create an new application in your dashboard.
8
+
9
+
It will generate a unique Data Source Name (DSN) that you will use to initialize the monitoring in your application.
10
+
11
+
12
+
## Setup 🔧
13
+
14
+
We currently only support NextJS applications, other frameworks are coming soon.
15
+
16
+
To get started, you need to install our package in your application.
17
+
18
+
```bash
19
+
pnpm add @openstatus/next-monitoring -E
20
+
```
21
+
22
+
Then, you need to add the following snippet to your `layout.tsx` file:
23
+
24
+
```tsx
25
+
import { OpenStatusProvider } from "@openstatus/next-monitoring";
26
+
27
+
export default function RootLayout({
28
+
children,
29
+
}: Readonly<{
30
+
children: React.ReactNode;
31
+
}>) {
32
+
return (
33
+
<html lang="en">
34
+
<body className={inter.className}>
35
+
<OpenStatusProvider dsn="YOUR_DSN" />
36
+
{children}
37
+
</body>
38
+
</html>
39
+
);
40
+
}
41
+
```
42
+
43
+
44
+
What is `YOUR_DSN`? It's your unique Data Source Name that you can find in your OpenStatus dashboard.
45
+
46
+
-30
apps/docs/rum/overview.mdx
-30
apps/docs/rum/overview.mdx
···
19
19
- **CLS**: Cumulative Layout Shift
20
20
- **INP**: Interaction to Next Paint
21
21
22
-
## Get started 🚀
23
-
24
-
We currently only support NextJS applications, other frameworks are coming soon.
25
-
26
-
To get started, you need to install our package in your application.
27
-
28
-
```bash
29
-
pnpm add @openstatus/next-monitoring -E
30
-
```
31
-
32
-
Then, you need to add the following snippet to your `layout.tsx` file:
33
-
34
-
```tsx
35
-
import { OpenStatusProvider } from "@openstatus/next-monitoring";
36
-
37
-
export default function RootLayout({
38
-
children,
39
-
}: Readonly<{
40
-
children: React.ReactNode;
41
-
}>) {
42
-
return (
43
-
<html lang="en">
44
-
<body className={inter.className}>
45
-
<OpenStatusProvider dsn="YOUR_DSN" />
46
-
{children}
47
-
</body>
48
-
</html>
49
-
);
50
-
}
51
-
```
+3
apps/docs/synthetic/features/monitor.mdx
+3
apps/docs/synthetic/features/monitor.mdx
···
8
8
A monitor is a job that runs periodically and checks the status of a service. It
9
9
can be a website, an API, or anything else that can be checked automatically.
10
10
11
+
We will make a request to your endpoint on a regular schedule and record.
12
+
13
+
11
14
## Configure your monitor 🛠
12
15
13
16
Your endpoint check requires:
+13
-2
apps/docs/synthetic/features/status-page-subscribers.mdx
+13
-2
apps/docs/synthetic/features/status-page-subscribers.mdx
···
2
2
title: Status Page Subscribers
3
3
---
4
4
5
-
If you are on a paid plan. Your status page will have a subscribers section.
6
-
This section will allow your users to subscribe to your status page update.
5
+
<Note>This is a paid feature only</Note>
6
+
7
+
## What does it mean to subscribe to a status page?
8
+
9
+
Your subscribers will receive an email notification when you update your status page. Each time you create a new status report or update an existing one, your subscribers will receive an email.
10
+
11
+
As a status page owner you will be able to see the list of subscribers.
12
+
13
+
## How to subscribe to a status page?
14
+
15
+
To subscribe to a status page, you need to click on the `Subscribe` button on the status page.
16
+
17
+
You will be asked to enter your email address. You will receive a confirmation email to validate your subscription.
+14
-6
apps/docs/synthetic/overview.mdx
+14
-6
apps/docs/synthetic/overview.mdx
···
3
3
description: "How does OpenStatus' synthetic monitoring work?"
4
4
---
5
5
6
-
With our synthetic monitoring, you can monitor the availability and performance of
7
-
your website or API from various global locations.
6
+
With synthetic monitoring, you can simulated requests to monitor the availability and performance of
7
+
your website or API from various locations around the world.
8
8
9
-
We will monitor your website or API on a regular schedule and record the
9
+
We will make a request to your website or API on a regular schedule and record the
10
10
responses.
11
+
12
+
We will alert you if your website or API is down, slow or does not return the expected response.
13
+
14
+
You can create monitors in our dashboard, with the API or with Terraform.
11
15
12
16
## Locations 🌍
13
17
···
22
26
23
27
## Status Page 📃
24
28
25
-
You can create a status page to display the availability and performance of your
26
-
monitor to your users.
29
+
Status page are a great way to communicate with your users when your website or API is down.
30
+
31
+
You can create a status page to display the availability and the performance of your
32
+
monitors to your users.
27
33
28
34
## Alerting 🚨
29
35
30
-
You can configure alerts to be notified when your monitor is down or slow.
36
+
Don't wait for your users to tell you that your website or API is down.
37
+
38
+
You can configure alerts to be notified when your monitor is down or slow, or does not return the expected response.