openstatus.dev
Openstatus
www.openstatus.dev
📝 more content (#1109)
* 📝 more content
* 📝 more content
authored by
Thibault Le Ouay
and committed by
GitHub
c1edd4b8
644b71d3
+108
-3
+4
apps/docs/astro.config.mjs
+4
apps/docs/astro.config.mjs
apps/docs/src/assets/monitor/http-monitor.png
apps/docs/src/assets/monitor/http-monitor.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/response-log-header.png
apps/docs/src/assets/monitor/response-log-header.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/response-log-timing.png
apps/docs/src/assets/monitor/response-log-timing.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/response-log.png
apps/docs/src/assets/monitor/response-log.png
This is a binary file and will not be displayed.
apps/docs/src/assets/monitor/tcp-monitor.png
apps/docs/src/assets/monitor/tcp-monitor.png
This is a binary file and will not be displayed.
+7
-1
apps/docs/src/components/Head.astro
+7
-1
apps/docs/src/components/Head.astro
···
1
1
---
2
2
import Default from "@astrojs/starlight/components/Head.astro";
3
3
import type { Props } from "@astrojs/starlight/props";
4
-
---
4
+
5
+
const { title } = Astro.props.entry.data;
6
+
const { siteTitle } = Astro.props;
5
7
8
+
const url = `https://openstatus.dev/api/og?title=${siteTitle}&description=${title}`;
9
+
---
6
10
<Default {...Astro.props}><slot /></Default>
11
+
12
+
<meta property="og:image" content={url} />
7
13
8
14
9
15
<script is:inline defer data-domain="docs.openstatus.dev" src="https://plausible.io/js/script.js" />
+1
-1
apps/docs/src/content/docs/index.mdx
+1
-1
apps/docs/src/content/docs/index.mdx
···
16
16
17
17
[OpenStatus](https://www.openstatus.dev) is an open-source synthetic monitoring tool that helps you monitor the availability and performance of your website, API, servers from various locations around the world.
18
18
19
-
We also provide beautiful status pages to keep your users informed about the status of your services.
19
+
We also provide beautiful [status pages](/status-page/overview) to keep your users informed about the status of your services.
20
20
21
21
### New to OpenStatus?
22
22
+62
apps/docs/src/content/docs/monitoring/monitor-data-collected.mdx
+62
apps/docs/src/content/docs/monitoring/monitor-data-collected.mdx
···
1
+
---
2
+
title: Monitor Data Points
3
+
description: "Monitor metrics are the data points that are collected by the monitor during the check."
4
+
---
5
+
6
+
import { Image } from 'astro:assets';
7
+
8
+
import ResponseLog from '../../../assets/monitor/response-log.png';
9
+
import ResponseLogHeader from '../../../assets/monitor/response-log-header.png';
10
+
import ResponseLogTiming from '../../../assets/monitor/response-log-timing.png';
11
+
12
+
13
+
## Access Monitor Data Points
14
+
15
+
To view your monitor data points, navigate to the monitor details page and click on the `Response` tab.
16
+
17
+
18
+
19
+
<Image
20
+
src={ResponseLog}
21
+
alt="OpenStatus response log"
22
+
/>
23
+
24
+
25
+
## Monitor Data Points
26
+
27
+
These are the data points that are collected by the monitor during the check.
28
+
29
+
30
+
31
+
32
+
### HTTP Monitor Metrics
33
+
34
+
<Image
35
+
src={ResponseLogHeader}
36
+
alt="OpenStatus response log"
37
+
/>
38
+
39
+
40
+
For an HTTP monitor, the following metrics are collected:
41
+
- **Status Code**: The HTTP status code returned by the server.
42
+
- **Response Time**: The time taken by the server to respond to the request.
43
+
- **Response Size**: The size of the response body.
44
+
- **Response Headers**: The headers returned by the server.
45
+
- **Response Body**: The body of the response in case of error
46
+
- **DNS timing**: The time taken to resolve the domain name.
47
+
- **TCP timing**: The time taken to establish a TCP connection.
48
+
- **TLS timing**: The time taken to establish a TLS connection.
49
+
- **TTFB timing**: Time to first byte, the time taken to receive the first byte of the response.
50
+
- **Transfer timing**: The time taken to download the response body.
51
+
52
+
53
+
<Image
54
+
src={ResponseLogTiming}
55
+
alt="OpenStatus response log timing"
56
+
/>
57
+
58
+
### TCP Monitor Metrics
59
+
60
+
For a TCP monitor, the following metrics are collected:
61
+
- **Response Time**: The time taken by the server to respond to the request.
62
+
- **TCP timing**: The time taken to establish a TCP connection.
+1
-1
apps/docs/src/content/docs/monitoring/overview.mdx
+1
-1
apps/docs/src/content/docs/monitoring/overview.mdx
···
6
6
import { CardGrid, LinkCard } from '@astrojs/starlight/components';
7
7
8
8
With synthetic monitoring, you can simulated requests to monitor the availability and performance of
9
-
your website or API from various locations around the world.
9
+
your website, API, or server from various locations around the world.
10
10
11
11
We will make a request to your website or API on a regular schedule and record the
12
12
responses.
+10
apps/docs/src/content/docs/monitoring/type/http.mdx
+10
apps/docs/src/content/docs/monitoring/type/http.mdx
···
2
2
title: HTTP
3
3
description: "How to monitor your HTTP services with OpenStatus.dev"
4
4
---
5
+
import { Image } from 'astro:assets';
6
+
7
+
import HttpMonitor from '../../../../assets/monitor/http-monitor.png';
8
+
9
+
<Image
10
+
src={HttpMonitor}
11
+
alt="Http Monitor"
12
+
/>
13
+
14
+
5
15
6
16
### URL
7
17
+12
apps/docs/src/content/docs/monitoring/type/tcp.mdx
+12
apps/docs/src/content/docs/monitoring/type/tcp.mdx
···
3
3
description: "How to monitor your TCP services with OpenStatus.dev"
4
4
---
5
5
6
+
import { Image } from 'astro:assets';
7
+
8
+
import TCPMonitor from '../../../../assets/monitor/tcp-monitor.png';
9
+
10
+
<Image
11
+
src={TCPMonitor}
12
+
alt="TCP Monitor"
13
+
/>
14
+
15
+
16
+
17
+
### URI (Host:Port)
6
18
Provide your Host and Port to monitor your TCP service. Could be a domain or IPv4/IPv6 address.
+11
apps/docs/src/content/docs/status-page/work/color-status-bar.mdx
+11
apps/docs/src/content/docs/status-page/work/color-status-bar.mdx
···
1
+
---
2
+
title: Understand the color of the status bar
3
+
---
4
+
5
+
On your status page, each status bar can have a different color based on the status of the service.
6
+
7
+
- **Green**: The service is up and running.
8
+
- **Orange**: The service is slow or degraded.
9
+
- **Red**: The service is down or unreachable.
10
+
- **Gray**: The service is paused or disabled or there is no data.
11
+
- **Blue**: The service is in maintenance or scheduled downtime.