Skip to content

Commit 3eace40

Browse files
gaprllizokmevanpurkhiser
authored
Add Uptime Monitoring Documentation (#10810)
* add main uptime monitoring page * add uptime monitoring troubleshooting page * add uptime monitoring to early adopter features list * add automatic detection documentation * fix broken URL for uptime troubleshooting page * apply structural wrapping to uptime index page * add initial uptime issue page * add temporary section on uptime monitoring ip ranges * add uptime alert summary * Apply suggestions from code review Co-authored-by: Liza Mock <[email protected]> * rupdate User-agent matching to use sentry's uptime bot agent token instead of full string * update IP ranges used by uptime * add uptime issue alert rule configuration * add uptime issue details page screenshot * Update docs/product/alerts/uptime-monitoring/index.mdx redirects wording Co-authored-by: Evan Purkhiser <[email protected]> --------- Co-authored-by: Liza Mock <[email protected]> Co-authored-by: Evan Purkhiser <[email protected]>
1 parent 84e8594 commit 3eace40

File tree

10 files changed

+156
-0
lines changed

10 files changed

+156
-0
lines changed

‎docs/organization/early-adopter-features/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ Limitations:
2020
- [Issue Status](/product/issues/states-triage/) tags
2121
- [Span Summary](/product/performance/transaction-summary/#span-summary)
2222
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Tracing
23+
- [Uptime Monitoring](/product/alerts/uptime-monitoring/)

‎docs/product/alerts/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ Create alerts to monitor metrics, such as:
3636

3737
You can find a full list of available metric alerts in [Metric Alerts](/product/alerts/alert-types/#metric-alerts).
3838

39+
## Uptime Monitoring Alerts
40+
41+
[Uptime alerts](/product/alerts/uptime-monitoring/) are triggered when an uptime HTTP check request fails to meet our
42+
[uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria).
43+
You can use uptime alerts to make sure a specific URL is constantly available, even during periods of low or no traffic.
44+
3945
## Creating Alerts
4046

4147
When you create a new project in [sentry.io](https://sentry.io), you can select a default issue alert. However, you can also [create your own alerts](/product/alerts/create-alerts/) to suit your team’s needs, using these [best practices](/product/alerts/best-practices/) as a guide.

‎docs/product/alerts/uptime-monitoring/automatic-detection.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Automatic Detection
3+
sidebar_order: 51
4+
description: "Learn how automatic detection of uptime monitoring works."
5+
---
6+
7+
<Include name="feature-stage-alpha-uptime.mdx" />
8+
9+
The automatic detection of uptime alerts sets up uptime alerts for the most frequently encountered
10+
hostnames in all URLs of your error data. This helps ensure that critical hostnames are continuously monitored,
11+
enhancing the reliability and availability of your web services.
12+
13+
## How It Works
14+
15+
We analyze all the URLs detected in your project's captured error data to find the hostname that appears most frequently. We then create an uptime alert if it passes our [uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria).
16+
17+
To avoid creating flaky alerts, the hostname undergoes an "onboarding period" of three days. During this period, we send HTTP requests to the hostname every hour. If the request fails at least three times, the hostname is dropped and re-evaluated after seven days.
18+
19+
<Alert level="info">
20+
Sentry will execute uptime checks against the hostname root path of the most frequently seen URLs. For example, if the most seen URL in your events is `GET https://www.example.com/docs/introduction` the check will be `GET https://www.example.com/`.
21+
</Alert>
22+
23+
## Disabling Automatic Detection
24+
Deleting an alert will disable automatic detection for the entire project linked to the host. This feature can also be turned off globally for the entire organization from the [organization settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/organization) page.
25+
26+
Alternatively, the hostname's `robots.txt` can be updated to disallow Sentry:
27+
28+
```txt{tabTitle: Example}{filename: robots.txt}
29+
User-agent: SentryUptimeBot
30+
Disallow: *
31+
```
32+
33+
## Current Limitations
34+
35+
In the current version, automatically-detected uptime alerts can only be deleted, not edited. Support for editing
36+
will be added in the future. Additionally, each organization is limited to one automatically-detected host.

‎docs/product/alerts/uptime-monitoring/img/uptime-issue-alert-rule.png

41.1 KB
Loading

‎docs/product/alerts/uptime-monitoring/index.mdx

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Uptime Monitoring
3+
sidebar_order: 50
4+
description: "Learn how to help maintain uptime for your web services by monitoring relevant URLs with Sentry's Uptime Monitoring."
5+
---
6+
7+
<Include name="feature-stage-alpha-uptime.mdx" />
8+
9+
Sentry's Uptime Monitoring lets you monitor the availability and reliability of your web services effortlessly.
10+
In the current version, uptime is [automatically configured](/product/alerts/uptime-monitoring/automatic-detection/) as a new alert for only the most relevant URL detected in your organization. In future updates, you'll have the flexibility to add and monitor additional URLs.
11+
12+
## Uptime Check Criteria
13+
14+
Our uptime monitoring system verifies the availability of your URLs
15+
by performing GET requests at regular 5-minute intervals.
16+
For a URL to be considered up and running, the response must meet the following criteria:
17+
18+
1. **Successful Response (2xx Status Codes):**
19+
The URL must return an HTTP status code in the 200–299 range, indicating a successful request.
20+
2. **Automatic Handling of Redirects (3xx Status Codes):** Sentry will follow redirects for URLs returning an HTTP status code in the 300–399 range and verify that the final destination URL returns a successful response. This ensures that redirects won't falsely trigger downtime alerts.
21+
3. **Timeout Setting:** Each request has a timeout threshold of 10 seconds.
22+
If the server doesn't respond within this period, the check will be marked as a failure,
23+
indicating a potential downtime or performance issues.
24+
4. **DNS Issue Detection:** Our monitoring also includes the detection of DNS resolution issues.
25+
If a DNS issue is detected, the check will be marked as a failure,
26+
allowing you to address the underlying connectivity problems.
27+
28+
## Notifications
29+
30+
An uptime alert continuously monitors the configured URL with the criteria defined above. If a failure is detected,
31+
a new [uptime issue](/product/issues/issue-details/uptime-issues/) with failed check and related errors details will be created.
32+
33+
To start getting notifications for a new downtime issue, [configure an issue alert](/product/alerts/create-alerts/issue-alert-config/) and choose the issue category "uptime". Then choose how you'd like to be notified (via email, Slack, and so on).
34+
35+
![Uptime issue alert rule configuration](./img/uptime-issue-alert-rule.png)
36+
37+
## Learn More About Uptime Monitoring
38+
39+
<PageGrid />

‎docs/product/alerts/uptime-monitoring/troubleshooting.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Troubleshooting
3+
sidebar_order: 52
4+
description: "Learn how to troubleshoot potential Uptime Monitoring problems."
5+
---
6+
7+
<Include name="feature-stage-alpha-uptime.mdx" />
8+
9+
## Verify Feature Eligibility
10+
11+
Uptime alerts are only available for organizations that have early adopter features enabled. They must also have URLs that match our [auto detection criteria](/product/alerts/uptime-monitoring/automatic-detection/#how-it-works). In the current version, organizations are limited to a single uptime alert.
12+
13+
## Verify Firewall Configuration
14+
15+
Some hosting platforms can block incoming requests from Sentry's Uptime Bot, falsely triggering uptime alerts. We recommend verifying your firewall configuration to ensure incoming requests from Sentry are allowed.
16+
17+
If you need to configure your firewall allowlist to include Sentry's Uptime Bot, we recommend checking against our `User-Agent`, given that our IP addresses can change without notice.
18+
19+
### User Agent
20+
21+
Our uptime check requests use the following `User-Agent`:
22+
23+
```
24+
Mozilla/5.0 (compatible; SentryUptimeBot/1.0; +http://docs.sentry.io/product/alerts/uptime-monitoring/)
25+
```
26+
27+
### IP Addresses
28+
29+
See [IP Ranges](/security-legal-pii/security/ip-ranges/#uptime-monitoring) for a complete list of IP addresses used for uptime checks.
30+
31+
## Verify That Issue Alerts Match Downtime Issues
32+
33+
Uptime alerts create downtime issues. If you're not receiving notifications when downtimes are detected, make sure you've properly [configured an issue alert](/product/alerts/create-alerts/issue-alert-config/) with the issue category "uptime".

‎docs/product/issues/issue-details/uptime-issues/img/uptime-issue-details.png

355 KB
Loading

‎docs/product/issues/issue-details/uptime-issues/index.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Uptime Issues
3+
sidebar_order: 40
4+
description: "Learn how to use the information on the Issue Details page to debug an error issue."
5+
---
6+
7+
<Include name="feature-stage-alpha-uptime.mdx" />
8+
9+
An uptime issue is a grouping of detected downtime events for a specific URL. A downtime event is generated by
10+
active uptime alerts when HTTP requests fail to meet our
11+
[uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria).
12+
13+
![Uptime issue details](./img/uptime-issue-details.png)
14+
15+
## Traced Errors
16+
17+
Uptime checks made against web services configured with one of Sentry's supported SDKs contain a
18+
[trace](/concepts/key-terms/tracing/) that can be used to track detected errors resulting from failed HTTP uptime checks. The trace navigator allows you to browse through potential root causes of your downtime and is a powerful tool for quickly identifying and resolving issues.
19+
20+
## Issue Lifecycle
21+
22+
Uptime issues are grouped by the monitored URL and created upon the first detected downtime. Sentry automatically resolves an ongoing uptime issue when the monitored URL returns to a healthy status and meets our [uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria). If the URL experiences subsequent downtime, the issue's status will change to regressed.

‎docs/security-legal-pii/security/ip-ranges.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,19 @@ All email is delivered from [SendGrid](https://sendgrid.com/) from the following
122122
```
123123

124124
These IP addresses are only for Sentry use.
125+
126+
## Uptime Monitoring
127+
128+
Sentry uses the following IP addresses for uptime checks:
129+
130+
US
131+
```
132+
34.123.33.225
133+
34.41.121.171
134+
```
135+
136+
EU
137+
```
138+
34.159.197.47
139+
35.242.231.10
140+
```

‎includes/feature-stage-alpha-uptime.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<Note>
2+
This feature is only available if your organization has enabled [early adopter features](/organization/early-adopter-features/). Early adopter features are still in-progress and may have bugs. We recognize the irony. If you’re interested in participating, enable early adopter features in [organization settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/organization).
3+
</Note>

0 commit comments

Comments
 (0)