openstatus.dev
Openstatus
www.openstatus.dev
🚀 more content (#1105)
* 🚀 more content
* ci: apply automated fixes
* 🚀 more content
* 🚀 more content
* ci: apply automated fixes
---------
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
cadbbc2f
1b7ac9ec
+47
-24
+1
-1
apps/docs/src/content/docs/guides/introduction.mdx
+1
-1
apps/docs/src/content/docs/guides/introduction.mdx
···
7
7
8
8
Here's some content for the getting started with OpenStatus.
9
9
10
-
- [How to use OpenStatus to test latency in GitHub Actions](/guides/test-latency-cf-workers-in-github-actions)
10
+
- [How to deploy your own probe to Koyeb](/guides/how-deploy-checker-koyeb/)
11
11
12
12
- [Deploy your own Status Page to Cloudflare Pages](/guides/how-deploy-status-page-cf-pages)
+12
-2
apps/docs/src/content/docs/index.mdx
+12
-2
apps/docs/src/content/docs/index.mdx
···
9
9
tagline: Explore our documentation to get started with OpenStatus
10
10
---
11
11
12
-
import { Card, CardGrid } from '@astrojs/starlight/components';
12
+
import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components';
13
13
import "../../custom.css"
14
14
15
15
<CardGrid >
···
20
20
Read our <a href="guides/introduction/">guides</a> to discover what you can do with OpenStatus
21
21
</Card>
22
22
<Card title="CLI" icon="seti:shell">
23
-
Learn more about our [CLI](/cli) to manage and run your synthetic check.
23
+
Learn more about our [CLI](/cli/getting-started) to manage and run your synthetic check.
24
24
</Card>
25
25
<Card title="API Reference" icon="puzzle">
26
26
Use our <a href="https://api.openstatus.dev/v1">API</a> to build amazing things on top of OpenStatus
···
29
29
Checkout our [GitHub repository](https://www.github.com/openstatushq/openstatus) to contribute or report issues.
30
30
</Card>
31
31
</CardGrid>
32
+
33
+
34
+
## Join the community
35
+
36
+
Join the commmunity to get help, share your ideas or just to say hi.
37
+
38
+
<CardGrid>
39
+
<LinkCard href="https://www.openstatus.dev/discord" title="Discord"/>
40
+
<LinkCard href="https://bsky.app/profile/openstatus.dev" title="Bluesky" />
41
+
</CardGrid>
+9
-9
apps/docs/src/content/docs/monitoring/overview.mdx
+9
-9
apps/docs/src/content/docs/monitoring/overview.mdx
···
21
21
A monitor is a job that runs periodically or on-demand and checks the status of a service. It
22
22
can be a website, an API, or anything else that can be checked automatically.
23
23
24
-
We will make a request to your endpoint on a regular schedule and record the results.
24
+
We will make a request to your endpoint on a regular schedule, or on-demand and record the results.
25
25
26
26
### Quick Links
27
27
28
28
<CardGrid>
29
-
<LinkCard
30
-
title="Assertions"
29
+
<LinkCard
30
+
title="Assertions"
31
31
href="/monitoring/customization/assertions"
32
32
/>
33
-
<LinkCard
34
-
title="Frequency"
33
+
<LinkCard
34
+
title="Frequency"
35
35
href="/monitoring/customization/frequency"
36
36
/>
37
-
<LinkCard
38
-
title="Regions"
37
+
<LinkCard
38
+
title="Regions"
39
39
href="/monitoring/customization/regions"
40
40
/>
41
-
<LinkCard
42
-
title="Timing"
41
+
<LinkCard
42
+
title="Timing"
43
43
href="/monitoring/customization/timing"
44
44
/>
45
45
</CardGrid>
+8
-1
apps/docs/src/content/docs/status-page/customization/monitors.mdx
+8
-1
apps/docs/src/content/docs/status-page/customization/monitors.mdx
···
11
11
By default, we share the number of total requests and the number of failed request with the total uptime of the last 45 days. If you want to hide the values, you can do so by toggeling the setting.
12
12
13
13
{/* TODO: update after OPE-427 */}
14
-
To change the visibility of the values: _Select a status page → Settings → Advanced_.
14
+
To change the visibility of the values: _Select a status page → Settings → Advanced_.
15
+
16
+
17
+
### Public monitors
18
+
19
+
If you want to share all your monitor metrics with your users, you can make your monitor public. This will allow you to display the metrics on your status page.
20
+
21
+
To make a monitor public: _Select a monitor → Settings → Danger → Toggle Public monitor.
+1
-1
apps/docs/src/content/docs/status-page/overview.mdx
+1
-1
apps/docs/src/content/docs/status-page/overview.mdx
···
57
57
58
58
## Add monitors metrics 📊
59
59
60
-
If you make your <a href="/synthetic/features/monitor#public-monitor">monitor public</a>, you can display the metrics on your status page.
60
+
If you make your <a href="/status-page/customization/monitors">monitor public</a>, you can display the metrics on your status page.
+6
apps/server/src/v1/index.ts
+6
apps/server/src/v1/index.ts
···
39
39
info: {
40
40
version: "1.0.0",
41
41
title: "OpenStatus API",
42
+
contact: {
43
+
email: "ping@openstatus.dev",
44
+
url: "https://www.openstatus.dev",
45
+
},
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. ",
42
48
},
43
49
});
44
50
+1
-1
apps/web/src/app/(content)/features/monitoring/page.tsx
+1
-1
apps/web/src/app/(content)/features/monitoring/page.tsx
···
138
138
action={
139
139
<div className="mt-2">
140
140
<Button variant="outline" className="rounded-full" asChild>
141
-
<Link href="https://docs.openstatus.dev/guides/test-latency-cf-workers-in-github-actions">
141
+
<Link href="https://docs.openstatus.dev/cli/getting-started">
142
142
How-to
143
143
</Link>
144
144
</Button>
+1
-1
apps/web/src/components/layout/status-widget-suspense.tsx
+1
-1
apps/web/src/components/layout/status-widget-suspense.tsx
+1
-1
apps/web/src/content/changelog/check-run-api.mdx
+1
-1
apps/web/src/content/changelog/check-run-api.mdx
···
9
9
10
10
It's useful if you want to integrate OpenStatus with your CI/CD pipeline.
11
11
12
-
You can read the [API documentation](https://docs.openstatus.dev/api-reference/check/post-check) or our guide to integrate it in [GitHub Actions](https://docs.openstatus.dev/guides/test-latency-cf-workers-in-github-actions) to get started.
12
+
You can read the [API documentation](https://api.openstatus.dev/v1#tag/monitor/POST/monitor/:id/trigger).
13
13
+1
-1
apps/web/src/content/changelog/checker-playground.mdx
+1
-1
apps/web/src/content/changelog/checker-playground.mdx
+1
-1
apps/web/src/content/changelog/golang-monitor-checker.mdx
+1
-1
apps/web/src/content/changelog/golang-monitor-checker.mdx
···
13
13
easily distinguish between internal incidents and external reports.
14
14
15
15
> The API endpoint has also moved from `/v1/incidents` to `/v1/status_reports`.
16
-
> Read more in the [docs](https://docs.openstatus.dev/getting-started/incident).
16
+
> Read more in the [docs](https://docs.openstatus.dev/incident/overview).
+1
-1
apps/web/src/content/changelog/status-widget.mdx
+1
-1
apps/web/src/content/changelog/status-widget.mdx
+1
-1
apps/web/src/content/posts/migration-backend-from-vercel-to-fly.mdx
+1
-1
apps/web/src/content/posts/migration-backend-from-vercel-to-fly.mdx
···
128
128
129
129
We are still using it for our frontend.
130
130
131
-
Create an account on [OpenStatus](https://www.openstatus.dev/sign-up?ref=blog3)
131
+
Create an account on [OpenStatus](https://www.openstatus.dev/app/login?ref=blog3)
132
132
to start monitoring our website and managing your incidents for free.
+2
-2
apps/web/src/content/posts/pricing-update-july-2024.mdx
+2
-2
apps/web/src/content/posts/pricing-update-july-2024.mdx
···
11
11
12
12
It's been six months since our last pricing update, and a lot has changed. We've shipped a lot of new features since January significantly improving our product, e.g :
13
13
- [35 regions available](/changelog/more-regions),
14
-
- [Password protected status page](changelog/password-protected-status-page),
14
+
- [Password protected status page](/changelog/password-protected-status-page),
15
15
- [PagerDuty integrations](/changelog/pagerduty-integration)
16
16
17
17
···
35
35
36
36
Our main competitor, Datadog, only covers `29 regions`. They also charge per request `$7.20 per 10k requests`, which can quickly add up if you're monitoring multiple services.
37
37
38
-
We took a completly different approach we are charging per monitors instead of requests. You can still run some checks via our [API](https://docs.openstatus.dev/api-reference/check/post-check) if you need to.
38
+
We took a completly different approach we are charging per monitors instead of requests. You can still run some checks via our [API](https://api.openstatus.dev/v1#tag/monitor/POST/monitor/:id/trigger) if you need to.
39
39
40
40
This means you can set a fixed number of monitors without worrying about the number of requests our price is fixed.
41
41
+1
-1
apps/web/src/content/posts/secure-api-with-unkey.mdx
+1
-1
apps/web/src/content/posts/secure-api-with-unkey.mdx
···
192
192
> [`@hono/zod-openapi`](https://github.com/honojs/middleware/tree/main/packages/zod-openapi)
193
193
> plugin to generate an OpenAPI spec out of the box. Read more about the
194
194
> supported endpoints in our
195
-
> [docs](https://docs.openstatus.dev/rest-api/openapi).
195
+
> [docs](https://api.openstatus.dev/v1).
196
196
197
197
## Conclusion
198
198