-
-
-If you want to run the test locally copy your API key to a `.env` file.
-
-```env
-OPENSTATUS_API_KEY=your-api-key
-```
-
-Here is our test first we warm up our endpoint and then run the latency test with OpenStatus.
-
-
-
-```typescript
-test("should fail if p75 > 1000", async () => {
-
- // Let's warm our endpoint
- await fetch("https://github-action-rollback.thibaultleouay.workers.dev/");
- // Run the test
- const options = {
- method: "POST",
- headers: {
- "Content-Type": "application/json",
- "x-openstatus-key": process.env.OPENSTATUS_API_KEY || "",
- },
- body: '{"url":"https://github-action-rollback.thibaultleouay.workers.dev/","method":"GET","regions":["ams","iad","gru","hkg","jnb","syd"],"runCount":2,"aggregated":true}',
- };
-
- const data = await fetch("https://api.openstatus.dev/v1/check", options);
- const json = await data.json();
- const result = schema.parse(json);
- expect(result.aggregated.firstByte.p75 < 1000).toBe(true);
-});
-```
-
-## Setting up the GitHub Actions
-
-We will use GitHub Actions to deploy our endpoint and run the test.
-We are using the package.json command to deploy our endpoint instead of the Cloudflare Workers Action and run the test
-
-You need to set up your secrets in the GitHub repository settings for the OpenStatus API key and Cloudflare API token.
-
-Go to 1. Settings -> 2. Secrets and variables -> 3. New repository secret.
-
-
-
- 
-
-
-
-
-Here is the GitHub Action workflow file:
-
-```yaml
-
-name: Deploy
-
-on:
- push:
- branches:
- - main
-
-jobs:
- deploy:
- name: Deploy 🔥
- runs-on: ubuntu-latest
- env:
- OPENSTATUS_API_KEY: ${{ secrets.OPENSTATUS_API_KEY }}
- CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
- CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-
- steps:
- - name: ⬇️ Checkout repo
- uses: actions/checkout@v3
-
- - name: 🔥 Install bun
- uses: oven-sh/setup-bun@v1
- with:
- bun-version: latest
-
- - name: 📥 Download deps
- run: bun install
-
- - name: 🔥 Deploy
- run: bun run deploy
-
-
- - name: 🧪 Test
- run: bun test
- id: test
-
- - name: 🚀 Rollback
- if: failure() && steps.test.outcome == 'failure'
- run: bun run rollback
-```
-
-In the workflow file, we have this step it will only run if the test fails:
-
-```yaml
- - name: 🚀 Rollback
- if: failure() && steps.test.outcome == 'failure'
- run: bun run rollback
-```
-
-and in our package.json we have the following script:
-
-```json
-{
- "scripts": {
- "rollback": "wrangler rollback --message 'Integration test failed'"
- }
-}
-```
-
-If you want to see the example in action, you can check the [GitHub repository actions](https://github.com/openstatusHQ/github-action-rollback/actions)
-
-
-## Conclusion
-
-We have successfully set up a GitHub Action that deploys our endpoint our Cloudflare Workers and runs a latency test against it with OpenStatus.
-
-
-Don't ever let your users experience slow endpoints, use OpenStatus to monitor your endpoint's performance and roll back deployments if needed.
\ No newline at end of file
diff --git a/apps/docs/integrations.mdx b/apps/docs/integrations.mdx
deleted file mode 100644
index 4b11ec47141..00000000000
--- a/apps/docs/integrations.mdx
+++ /dev/null
@@ -1,3 +0,0 @@
-# Integrations 🔌
-
-You can connect with OpenStatus account with other service.
diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx
deleted file mode 100644
index cbfc99832e9..00000000000
--- a/apps/docs/introduction.mdx
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: What is OpenStatus?
----
-
-OpenStatus is an open-source synthetic and frontend performance monitoring
-service.
-
-## Products
-
-OpenStatus is composed of two products:
-
-
-
You will be redirected to the PagerDuty website to authorize OpenStatus to send notifications to your account.
-
- 
-
Select the service you want to use to send notifications. You can create a new service if you don't have one.
-
- 
-
You are now connected to PagerDuty. Give your integration a name and save it.
diff --git a/apps/docs/synthetic/features/notification/phone-call.mdx b/apps/docs/src/content/docs/alerting/providers/phone-call.mdx
similarity index 100%
rename from apps/docs/synthetic/features/notification/phone-call.mdx
rename to apps/docs/src/content/docs/alerting/providers/phone-call.mdx
diff --git a/apps/docs/synthetic/features/notification/slack.mdx b/apps/docs/src/content/docs/alerting/providers/slack.mdx
similarity index 100%
rename from apps/docs/synthetic/features/notification/slack.mdx
rename to apps/docs/src/content/docs/alerting/providers/slack.mdx
diff --git a/apps/docs/synthetic/features/notification/sms.mdx b/apps/docs/src/content/docs/alerting/providers/sms.mdx
similarity index 100%
rename from apps/docs/synthetic/features/notification/sms.mdx
rename to apps/docs/src/content/docs/alerting/providers/sms.mdx
diff --git a/apps/docs/synthetic/features/notification/telegram.mdx b/apps/docs/src/content/docs/alerting/providers/telegram.mdx
similarity index 100%
rename from apps/docs/synthetic/features/notification/telegram.mdx
rename to apps/docs/src/content/docs/alerting/providers/telegram.mdx
diff --git a/apps/docs/src/content/docs/cli/commands/monitors.mdx b/apps/docs/src/content/docs/cli/commands/monitors.mdx
new file mode 100644
index 00000000000..c83153b6a5a
--- /dev/null
+++ b/apps/docs/src/content/docs/cli/commands/monitors.mdx
@@ -0,0 +1,35 @@
+---
+title: Monitors
+---
+
+The monitors command is used to manage your monitors. You trigger, view and list your monitors using this command.
+
+## Info
+You can get the details of a monitor using the following command.
+
+```bash
+openstatus monitors info + +```bash +brew install openstatus +``` + +Then you can run the following command to verify the installation. + +```bash +openstatus --help +``` + +You need to get an API token to use the CLI. You can get an API key by signing up on the OpenStatus website. + +_Settings → API Token → Create API token_ + +You can set the API token using the following command. + +```bash +export OPENSTATUS_API_TOKEN=your-api-token +``` + +or you can set the `--access-token` option in the CLI command. + +```bash +openstatus [COMMAND] --access-token your-api-token +``` \ No newline at end of file diff --git a/apps/docs/contributing/get-started.mdx b/apps/docs/src/content/docs/contributing/getting-started.mdx similarity index 88% rename from apps/docs/contributing/get-started.mdx rename to apps/docs/src/content/docs/contributing/getting-started.mdx index 55aa0e6d881..137df6899df 100644 --- a/apps/docs/contributing/get-started.mdx +++ b/apps/docs/src/content/docs/contributing/getting-started.mdx @@ -1,7 +1,11 @@ --- -title: Get Started +title: Getting Started --- +import { Aside } from "@astrojs/starlight/components"; + + + ## Setup 1. Clone the repository and open the created directory diff --git a/apps/docs/contributing/requirements.mdx b/apps/docs/src/content/docs/contributing/requirements.mdx similarity index 96% rename from apps/docs/contributing/requirements.mdx rename to apps/docs/src/content/docs/contributing/requirements.mdx index f478d0d777d..75ef9d0bf3e 100644 --- a/apps/docs/contributing/requirements.mdx +++ b/apps/docs/src/content/docs/contributing/requirements.mdx @@ -2,6 +2,10 @@ title: Requirements --- +import { Aside } from "@astrojs/starlight/components"; + + + ## System Requirements Before you start, make sure you have the following applications and their diff --git a/apps/docs/contributing/setup-env.mdx b/apps/docs/src/content/docs/contributing/setup-env.mdx similarity index 99% rename from apps/docs/contributing/setup-env.mdx rename to apps/docs/src/content/docs/contributing/setup-env.mdx index 65ee2dc5ed7..04b4246cef7 100644 --- a/apps/docs/contributing/setup-env.mdx +++ b/apps/docs/src/content/docs/contributing/setup-env.mdx @@ -2,6 +2,10 @@ title: Setup environment files --- +import { Aside } from "@astrojs/starlight/components"; + + + # Configuration of the .env file The `.env` file contains various environment variables that need to be properly diff --git a/apps/docs/dummy/ping_response__v5.csv b/apps/docs/src/content/docs/dummy/ping_response__v5.csv similarity index 100% rename from apps/docs/dummy/ping_response__v5.csv rename to apps/docs/src/content/docs/dummy/ping_response__v5.csv diff --git a/apps/docs/src/content/docs/getting-started/introduction.mdx b/apps/docs/src/content/docs/getting-started/introduction.mdx new file mode 100644 index 00000000000..fe0c3123d26 --- /dev/null +++ b/apps/docs/src/content/docs/getting-started/introduction.mdx @@ -0,0 +1,22 @@ +--- +title: Getting Started +description: "What is OpenStatus.dev and how to get started" +topic: docs +next: 'Start Monitoring' +--- + +import { Aside } from '@astrojs/starlight/components'; + + +## What is OpenStatus 🧑🏫 + +[OpenStatus](https://www.openstatus.dev) is an open-source synthetic monitoring platform. It allows you to monitor your services and get notified when they are down. + + +## How to get started 🚀 + +You can either use the hosted version of OpenStatus or self-host it. + + \ No newline at end of file diff --git a/apps/docs/guides/how-deploy-checker-koyeb.mdx b/apps/docs/src/content/docs/guides/how-deploy-checker-koyeb.mdx similarity index 70% rename from apps/docs/guides/how-deploy-checker-koyeb.mdx rename to apps/docs/src/content/docs/guides/how-deploy-checker-koyeb.mdx index 83355c92385..12d1b8b174d 100644 --- a/apps/docs/guides/how-deploy-checker-koyeb.mdx +++ b/apps/docs/src/content/docs/guides/how-deploy-checker-koyeb.mdx @@ -1,7 +1,15 @@ --- title: How to deploy your own checker on Koyeb -description: Learn how to deploy our checker on Koyeb.` +description: Learn how to deploy our checker on Koyeb. +sidebar: + label: Deploy our probe on Koyeb --- +import { Image } from 'astro:assets'; + +import Koyeb1 from '../../../assets/guides/how-deploy-checker-koyeb/koyeb-1.png'; +import Koyeb2 from '../../../assets/guides/how-deploy-checker-koyeb/koyeb-2.png'; +import Koyeb3 from '../../../assets/guides/how-deploy-checker-koyeb/koyeb-3.png'; + ## Introduction @@ -16,23 +24,19 @@ You need a koeyb account to deploy our checker on Koyeb. If you don't have one, 3. Select the `Docker` option. - -
-
4. In the `Image` field, enter `ghcr.io/openstatushq/checker:latest`.
-
- 
-
5. Click on the `Next` button.
@@ -43,12 +47,10 @@ You should set the following environment variables
- `REGION` : The koyeb region where you want to deploy your checker
- `CRON_SECRET` : A secret key to secure your endpoint to avoid unauthorized access
-
- 
-
## Calling your probe
@@ -61,7 +63,7 @@ curl --request POST \
--header 'Content-Type: application/json' \
--data '{
"url": "https://www.openstatus.dev",
- "method": "GET",
+ "method": "GET"
}'
```
diff --git a/apps/docs/guides/how-deploy-status-page-cf-pages.mdx b/apps/docs/src/content/docs/guides/how-deploy-status-page-cf-pages.mdx
similarity index 93%
rename from apps/docs/guides/how-deploy-status-page-cf-pages.mdx
rename to apps/docs/src/content/docs/guides/how-deploy-status-page-cf-pages.mdx
index 950dc2f9412..0aa15d46fdc 100644
--- a/apps/docs/guides/how-deploy-status-page-cf-pages.mdx
+++ b/apps/docs/src/content/docs/guides/how-deploy-status-page-cf-pages.mdx
@@ -1,7 +1,11 @@
---
title: How to deploy your own status page to Cloudflare Pages
description: Learn how to use OpenStatus monitoring data and deploy your own Status Page to cloudflare pages.
+sidebar:
+ label: Host your status page on Cloudflare Pages
---
+import { Image } from 'astro:assets';
+import statusPage from '../../../assets/guides/how-deploy-status-page-cf-pages/status-page.png';
## Introduction
@@ -17,12 +21,10 @@ The code showcased in this guide is available on [GitHub](https://github.com/ope
-
- 
-
## Prerequisites
diff --git a/apps/docs/guides/introduction.mdx b/apps/docs/src/content/docs/guides/introduction.mdx
similarity index 86%
rename from apps/docs/guides/introduction.mdx
rename to apps/docs/src/content/docs/guides/introduction.mdx
index 90bbcd360d2..ac8d18144ef 100644
--- a/apps/docs/guides/introduction.mdx
+++ b/apps/docs/src/content/docs/guides/introduction.mdx
@@ -1,5 +1,8 @@
---
title: Introduction
+sidebar:
+ label: Introduction
+ order: 1
---
Here's some content for the getting started with OpenStatus.
diff --git a/apps/docs/help/support.mdx b/apps/docs/src/content/docs/help/support.mdx
similarity index 100%
rename from apps/docs/help/support.mdx
rename to apps/docs/src/content/docs/help/support.mdx
diff --git a/apps/docs/synthetic/features/incident.mdx b/apps/docs/src/content/docs/incident/overview.mdx
similarity index 68%
rename from apps/docs/synthetic/features/incident.mdx
rename to apps/docs/src/content/docs/incident/overview.mdx
index 5df9c9c5f58..f09744e8d86 100644
--- a/apps/docs/synthetic/features/incident.mdx
+++ b/apps/docs/src/content/docs/incident/overview.mdx
@@ -1,8 +1,13 @@
---
-title: Incident
+title: Overview
description: "How incident are created, how to acknowledge, and resolve them🔥"
---
+import { Aside } from '@astrojs/starlight/components';
+import { Image } from 'astro:assets';
+import IncidentDetail from '../../../assets/incident/incident-detail.png';
+
+When we detect a problem with your service, we create an incident.
## What is an incident 🧑🏫
We automatically create an incident when we detect a problem with your service.
@@ -29,11 +34,9 @@ On the incident page, you can see the details of the incident, the monitor that
We are also taking a screenshot of the monitor when the incident is created, and when it's resolved.
-
- 
-
-
-
## What is a status page 🧑🏫
diff --git a/apps/docs/synthetic/features/status-report.mdx b/apps/docs/src/content/docs/status-page/reports.mdx
similarity index 74%
rename from apps/docs/synthetic/features/status-report.mdx
rename to apps/docs/src/content/docs/status-page/reports.mdx
index db5abd2ee71..48a2b09adca 100644
--- a/apps/docs/synthetic/features/status-report.mdx
+++ b/apps/docs/src/content/docs/status-page/reports.mdx
@@ -4,7 +4,7 @@ description: "What is a Status Page Report 🔥"
---
## What is a Status Page Report?
-A status page report is a timeline of status updates that can be shared with your users. It is a great way to keep your users informed about the status of your application, website or service.
+A status page report is a timeline of sta tus updates that can be shared with your users. It is a great way to keep your users informed about the status of your application, website or service.
## How to create a Status Page Report?
diff --git a/apps/docs/synthetic/features/status-page-subscribers.mdx b/apps/docs/src/content/docs/status-page/subscribers.mdx
similarity index 85%
rename from apps/docs/synthetic/features/status-page-subscribers.mdx
rename to apps/docs/src/content/docs/status-page/subscribers.mdx
index 8f6f7919bb8..ae8646d01de 100644
--- a/apps/docs/synthetic/features/status-page-subscribers.mdx
+++ b/apps/docs/src/content/docs/status-page/subscribers.mdx
@@ -2,7 +2,10 @@
title: Status Page Subscribers
---
-
-
-
-
-### HTTP Request 📤
-
-Customize the request sent to your endpoint.
-
-Choose between one of the request **HTTP Method**: `GET` (default), `POST` or
-`HEAD`.
-
-Add custom key-value **HTTP Headers** to your request.
-
-> OpenStatus automatically set the `"User-Agent": "OpenStatus/1.0"` header to
-> your request. This header is used to identify the request as a ping request
-> and can be exluded from your analytics.
-
-
-
-If you select the `POST` method, you can add a custom **HTTP Body** to your
-request.
-
-### Advanced Configuration ⚙️
-
-You can pause your monitor with the **active** switch button.
-
-#### Frequency ⏱
-
-Define the **frequency** of your checks. You can choose between: `30s`, `1m`,
-`5m`, `10m` (default), `30min` or `1h`.
-
-#### Regions 🌍
-
-By default, **all regions** are enabled. You can disable some regions if you
-want to. Our regions are:
-
-- `ams` - Amsterdam, Netherlands - 🇳🇱
-- `iad` - Ashburn, Virginia, USA - 🇺🇸
-- `jnb` - Johannesburg, South Africa - 🇿🇦
-- `hkg` - Hong Kong, Honkg Kong - 🇭🇰
-- `gru` - Sao Paulo, Brazil - 🇧🇷
-- `syd` - Sydney, Australia - 🇦🇺
-
-#### Description 📝
-
-The **description** is optional. If defined, an `Info` tooltip will be added to
-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**
-
-
-## Public Monitor 🌐
-
-You can make your monitor public by checking **Allow public monitor**.
-
-
- 
-
-
-
-
-A public monitor is accessible by anyone with the monitor URL.
-e.g. https://status.openstatus.dev/monitors/1
-
-
-
- 
-
-
-If the monitor is attached to a **status page**, the monitor will be displayed on the status page in the **Monitors** tab.
-
-## Video Tutorial 📺
-
-
diff --git a/apps/docs/synthetic/features/notification.mdx b/apps/docs/synthetic/features/notification.mdx
deleted file mode 100644
index 194e8b2b7b8..00000000000
--- a/apps/docs/synthetic/features/notification.mdx
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: Overview
-description: "How to create your first alert with OpenStatus.dev"
----
-
-If you connect notification channels to your OpenStatus account, you can receive
-alerts when your services are down. We will contact you when an incident is
-created.
-
-
- 
-
-
-## Notification channels
-
-