-
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 📝 more content * 📝 more content * ci: apply automated fixes * 📝 more content --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
a95f63a
commit 4353c6c
Showing
28 changed files
with
288 additions
and
236 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: Incident Detail | ||
order: 2 | ||
--- | ||
|
||
import { Image } from 'astro:assets'; | ||
import IncidentDetail from '../../../assets/incident/incident-detail.png'; | ||
import { Aside } from '@astrojs/starlight/components'; | ||
|
||
|
||
On the incident page, you can see the details of the incident, the monitor that failed, and the duration. | ||
We are also taking a screenshot of the monitor when the incident is created, and when it's resolved. | ||
|
||
|
||
<Image | ||
src={IncidentDetail} | ||
alt="Incident page" | ||
/> | ||
|
||
<Aside>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Aside> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,11 @@ | ||
--- | ||
title: Overview | ||
description: "How incident are created, how to acknowledge, and resolve them🔥" | ||
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. | ||
When a monitor fails in more than 50% of the locations, we create an incident. | ||
We do that in order to avoid false positives. | ||
|
||
## How to acknowledge an incident | ||
|
||
Go to the incident page and click on the acknowledge button. | ||
|
||
## How to resolve an incident | ||
|
||
Go to the incident page and click on the resolve button. | ||
|
||
## Auto resolve an incident | ||
|
||
We automatically resolve an incident when the monitor is passing in more than | ||
50% of the locations. | ||
|
||
|
||
## Incident detail page | ||
|
||
On the incident page, you can see the details of the incident, the monitor that failed, and the duration. | ||
We are also taking a screenshot of the monitor when the incident is created, and when it's resolved. | ||
|
||
|
||
<Image | ||
src={IncidentDetail} | ||
alt="Incident page" | ||
/> | ||
|
||
<Aside>There might be a delay between the incident creation and the screenshot capture. Your endpoint could have already recovered.</Aside> |
24 changes: 24 additions & 0 deletions
24
apps/docs/src/content/docs/incident/work-with-incident.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: Work with Incidents | ||
--- | ||
|
||
An incident can have the following states: | ||
|
||
- **On Going**: The incident is still active. | ||
- **Acknowledged**: The incident has been acknowledged. | ||
- **Resolved**: The incident has been resolved. | ||
|
||
## How to acknowledge an incident | ||
|
||
Go to the incident page and click on the acknowledge button. | ||
|
||
## How to resolve an incident | ||
|
||
Go to the incident page and click on the resolve button. | ||
|
||
## Auto resolve an incident | ||
|
||
We automatically resolve an incident when the monitor is passing in more than | ||
50% of the locations. | ||
|
||
|
5 changes: 5 additions & 0 deletions
5
apps/docs/src/content/docs/monitoring/customization/notification.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Notification | ||
--- | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
apps/docs/src/content/docs/status-page/advanced/description.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Description | ||
--- | ||
|
||
import { Image } from 'astro:assets'; | ||
|
||
import StatusPage from '../../../../assets/status-page/description.png'; | ||
|
||
|
||
You can set a custom description for your status page. The description will be displayed on the status page. | ||
|
||
To add a custom description for your status page: _Select a status page → Settings → Advanced_. | ||
|
||
|
||
|
||
|
||
<Image | ||
src={StatusPage} | ||
alt="OpenStatus status page" | ||
/> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Icon | ||
--- | ||
|
||
import { Image } from 'astro:assets'; | ||
|
||
import StatusPage from '../../../../assets/status-page/favicon.png'; | ||
|
||
|
||
|
||
You can set a custom icon for your status page. The icon will be displayed in the browser tab and on the status page. | ||
|
||
To add a custom favicon for your status page: _Select a status page → Settings → Advanced_. | ||
|
||
|
||
<Image | ||
src={StatusPage} | ||
alt="OpenStatus status page" | ||
/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 0 additions & 7 deletions
7
apps/docs/src/content/docs/status-page/customization/advanced.mdx
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Status Page Report | ||
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. | ||
|
||
Only the update that happened during the last 7 days will be displayed on the main page of your status page. | ||
Otherwise they will be displayed on your status page and under the **Event** tab. | ||
|
||
## How to create a Status Page Report? | ||
|
||
Go to your **status page** tab, select your status page click on the **Status report**. | ||
|
||
When creating a status report, you can map it to a **monitor** or not. This will allow you access the latest reports on your status | ||
page. | ||
|
||
If you don't select a monitor, this is useful if you want to inform your users about an incident, a maintenance of a third party provider. | ||
|
||
Update your report over time and keep your users informed. Add a new **status**, | ||
**date** and **message** to your report. They will be displayed on a timeline. | ||
|
||
|
||
### Status update | ||
|
||
The status update can be one of the following: | ||
|
||
- **Investigating**: You are investigating an issue | ||
- **Identified**: You have identified the issue | ||
- **Monitoring**: You are monitoring the issue | ||
- **Resolved**: The issue has been resolved | ||
|
||
|
File renamed without changes.
Oops, something went wrong.