openstatus.dev
Openstatus
www.openstatus.dev
📝 more content (#1110)
* 📝 more content
* ci: apply automated fixes
* 📝 more content
* 📝 more content
---------
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
authored by
Thibault Le Ouay
autofix-ci[bot]
and committed by
GitHub
80379c8c
c1edd4b8
+135
-8
+13
-2
apps/docs/astro.config.mjs
+13
-2
apps/docs/astro.config.mjs
···
20
20
social: {
21
21
github: "https://github.com/openstatusHQ/openstatus",
22
22
blueSky: "https://bsky.app/profile/openstatus.dev",
23
+
discord: "https://www.openstatus.dev/discord",
23
24
},
24
25
components: {
25
26
SiteTitle: "./src/components/SiteTitle.astro",
26
27
Head: "./src/components/Head.astro",
27
28
Hero: "./src/components/Hero.astro",
29
+
Footer: "./src/components/Footer.astro",
28
30
},
29
31
editLink: {
30
32
baseUrl: "https://github.com/openstatusHQ/openstatus/app/docs",
···
38
40
starlightSidebarTopics([
39
41
{
40
42
label: "Documentation",
41
-
link: "/getting-started/introduction",
43
+
link: "/",
42
44
id: "docs",
43
45
icon: "open-book",
44
46
items: [
···
62
64
{
63
65
label: "View your monitor data",
64
66
slug: "monitoring/monitor-data-collected",
67
+
},
68
+
{
69
+
label: "Group your monitors",
70
+
slug: "monitoring/group-monitor-tag",
65
71
},
66
72
{
67
73
label: "Monitor Types",
···
108
114
},
109
115
{
110
116
label: "Status Page",
117
+
collapsed: true,
111
118
112
119
items: [
113
120
{ label: "Overview", slug: "status-page/overview" },
···
130
137
},
131
138
{
132
139
label: "Incidents",
140
+
collapsed: true,
133
141
items: [
134
142
{ label: "Overview", slug: "incident/overview" },
135
143
{
···
145
153
},
146
154
{
147
155
label: "Alerting",
156
+
collapsed: true,
148
157
items: [
149
158
{ label: "Overview", slug: "alerting/overview" },
150
159
{
···
157
166
],
158
167
},
159
168
{
160
-
label: "Tools",
169
+
label: "Developer Tools",
170
+
collapsed: true,
161
171
autogenerate: { directory: "tools" },
162
172
},
163
173
{
164
174
label: "Support",
175
+
collapsed: true,
165
176
items: [
166
177
{
167
178
label: "Help",
apps/docs/src/assets/monitor/assertions.png
apps/docs/src/assets/monitor/assertions.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/create-tag.png
apps/docs/src/assets/monitor/create-tag.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/filter-tag.png
apps/docs/src/assets/monitor/filter-tag.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/notifications.png
apps/docs/src/assets/monitor/notifications.png
This is a binary file and will not be displayed.
+4
-1
apps/docs/src/components/Head.astro
+4
-1
apps/docs/src/components/Head.astro
···
15
15
<script is:inline defer data-domain="docs.openstatus.dev" src="https://plausible.io/js/script.js" />
16
16
17
17
<!-- REMINDER: prevent unexpected font flashes for our 'OpenStatus' logo on each page load -->
18
-
<link rel="preload" href="/fonts/CalSans-SemiBold.ttf" as="font" type="font/ttf" crossorigin>
18
+
<link rel="preload" href="/fonts/CalSans-SemiBold.ttf" as="font" type="font/ttf" crossorigin>
19
+
<script defer async src="https://buttons.github.io/buttons.js" />
20
+
21
+
+1
-1
apps/docs/src/content/docs/getting-started/introduction.mdx
+1
-1
apps/docs/src/content/docs/getting-started/introduction.mdx
···
15
15
16
16
### Cloud version
17
17
18
-
You can [sign up](https://www.openstatus.dev/app/login?ref=docs) for a free account and start monitoring your services in seconds.
18
+
You can [sign up](https://www.openstatus.dev/app/login?ref=docs) for a free account and begin monitoring your services in seconds.
19
19
20
20
### Self Hosted version
21
21
+1
-1
apps/docs/src/content/docs/help/support.mdx
+1
-1
apps/docs/src/content/docs/help/support.mdx
+1
-1
apps/docs/src/content/docs/index.mdx
+1
-1
apps/docs/src/content/docs/index.mdx
···
6
6
next: false
7
7
hero:
8
8
title: Welcome to OpenStatus
9
-
tagline: Explore our documentation to get started with OpenStatus
9
+
tagline: Explore our documentation to get started with OpenStatus and start monitoring your services.
10
10
---
11
11
12
12
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
+12
apps/docs/src/content/docs/monitoring/customization/assertions.mdx
+12
apps/docs/src/content/docs/monitoring/customization/assertions.mdx
···
3
3
description: "How to monitor your HTTP services with OpenStatus.dev"
4
4
---
5
5
6
+
7
+
import { Image } from 'astro:assets';
8
+
9
+
import Assertions from '../../../../assets/monitor/assertions.png';
10
+
11
+
<Image
12
+
src={Assertions}
13
+
alt="Monitor assertions"
14
+
/>
15
+
16
+
17
+
6
18
By default we expect the endpoint to return a `200` status code. If you want to check for a different status code you can go to to the `Assertions` tab and add a new assertion.
7
19
8
20
We support **status code**, **header** and **body string** assertions.
+21
-1
apps/docs/src/content/docs/monitoring/customization/notification.mdx
+21
-1
apps/docs/src/content/docs/monitoring/customization/notification.mdx
···
1
1
---
2
-
title: Notification
2
+
title: Notifications
3
3
---
4
+
import { Image } from 'astro:assets';
5
+
import { Aside} from '@astrojs/starlight/components';
6
+
7
+
import Notification from '../../../../assets/monitor/notifications.png';
8
+
9
+
<Image
10
+
src={Notification}
11
+
alt="Monitor notifications"
12
+
/>
4
13
14
+
15
+
If you want to receive notifications when your monitor fails, you can connect it to a notification channel.
16
+
17
+
To connect your monitor to a notification channel, _Select a monitor → Settings → Notifications_.
18
+
19
+
You will have the list of available notification channels. You can connect your monitor to one or multiple notification channels.
20
+
21
+
You need to create a notification channel before connecting your monitor to it.
22
+
23
+
<Aside>
5
24
By default your monitor won't send any notification on failure. You can enable notifications for your monitor by connecting it to a notification channel.
25
+
</Aside>
+29
apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
+29
apps/docs/src/content/docs/monitoring/group-monitor-tag.mdx
···
1
+
---
2
+
title: How to group your monitors
3
+
---
4
+
5
+
import { Image } from 'astro:assets';
6
+
7
+
import createTag from '../../../assets/monitor/create-tag.png'
8
+
import filterTag from '../../../assets/monitor/filter-tag.png'
9
+
10
+
If you have multiple monitors that you want to group together, you can do so by creating a tag. Tags help you organize your monitors and manage them more efficiently.
11
+
12
+
### Create a tag
13
+
14
+
You can create a tag by going to settings tab of your monitor and adding a new tag.
15
+
16
+
<Image
17
+
src={createTag}
18
+
alt="OpenStatus create monitor tag"
19
+
/>
20
+
21
+
22
+
### Filter monitors by Tags
23
+
24
+
Once you have created tags, you can filter your monitors by tags. This helps you to quickly find the monitors you are looking for.
25
+
26
+
<Image
27
+
src={filterTag}
28
+
alt="OpenStatus filter by tag"
29
+
/>
+1
-1
apps/server/src/v1/index.ts
+1
-1
apps/server/src/v1/index.ts
···
44
44
url: "https://www.openstatus.dev",
45
45
},
46
46
description:
47
-
"OpenStatus is a open-source synthetic monitoring tool that allows you to monitor your website and API's uptime, latency, and more. \n\n The OpenStatus API allows you to interact with the OpenStatus platform programmatically. ",
47
+
"OpenStatus is a open-source synthetic monitoring tool that allows you to monitor your website and API's uptime, latency, and more. \n\n The OpenStatus API allows you to interact with the OpenStatus platform programmatically. \n\n To get started you need to create an account on https://www.openstatus.dev/ and create an api token in your settings.",
48
48
},
49
49
});
50
50