Skip to content

Commit b15c421

Browse files
sfanahataShannon Anahata
andauthored
Updating uptime-monitoring docs to include uptime request spans (#14765)
## DESCRIBE YOUR PR We are introducing uptime request spans to the uptime UX. These are out of the box spans that come at no additional charge to the customer. We need to update a few pages in order to reflect these changes: - Main uptime monitoring documentation (docs/product/uptime-monitoring/index.mdx) - Uptime tracing documentation (docs/product/uptime-monitoring/uptime-tracing.mdx) - Product overview (docs/product/index.mdx) Uptime monitoring doc: https://sentry-docs-git-uptime-request-spans-updates.sentry.dev/product/uptime-monitoring/ Uptime tracing doc: https://sentry-docs-git-uptime-request-spans-updates.sentry.dev/product/uptime-monitoring/uptime-tracing/ Product overview: https://sentry-docs-git-uptime-request-spans-updates.sentry.dev/product/ ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [x] Other deadline: Some time week ending Sept 5th - [ ] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Shannon Anahata <[email protected]>
1 parent abd84c9 commit b15c421

File tree

6 files changed

+35
-5
lines changed

6 files changed

+35
-5
lines changed

docs/product/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Our [**AI Agents Monitoring**](/product/insights/ai/agents/) feature gives you i
5050

5151
### Uptime Monitoring
5252

53-
Sentry's [**Uptime Monitoring**](/product/uptime-monitoring/) helps you maintain uptime for your web services by monitoring relevant URLs. It continuously tracks configured URLs, delivering alerts and insights to quickly identify downtime and troubleshoot issues. By leveraging [distributed tracing](/product/uptime-monitoring/uptime-tracing/), Sentry enables you to pinpoint any errors that occur during an uptime check, simplifying triage and accelerating root cause analysis.
53+
Sentry's [**Uptime Monitoring**](/product/uptime-monitoring/) helps you maintain uptime for your web services by monitoring relevant URLs. It continuously tracks configured URLs, delivering alerts and insights to quickly identify downtime and troubleshoot issues. By leveraging [distributed tracing](/product/uptime-monitoring/uptime-tracing/), Sentry enables you to pinpoint any errors that occur during an uptime check, simplifying triage and accelerating root cause analysis. Uptime monitoring includes [uptime request spans](/product/uptime-monitoring/#uptime-request-spans) by default. These act as the root of any uptime issue's trace, giving you better context for faster debugging.
5454

5555
### Recurring Job Monitoring
5656

107 KB
Loading
-85.8 KB
Binary file not shown.
364 KB
Loading

docs/product/uptime-monitoring/index.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,22 @@ To prevent false alerts caused by temporary network issues, **an issue is only g
3737

3838
_In rare cases where Sentry is unable to perform a scheduled uptime check—such as during outages—the check status will be marked as "Unknown"._
3939

40+
## Uptime Request Spans
41+
42+
Uptime checks include spans called _uptime request spans_ that Sentry automatically creates for the request. The `uptime.request` span acts as a root span for traces related to uptime checks.
43+
44+
![Uptime request span](./img/uptime-request-span.png)
45+
46+
**Key Benefits:**
47+
48+
- Context: You instantly know a trace was generated by an uptime check vs user traffic
49+
- Request lifecycle: You can see the full journey from the initial uptime check through your application's response
50+
- Enhanced debugging: You can see more details about exactly where and why the failure occurred to distinguish between uptime-related issues and other application problems
51+
52+
<Alert type="info">
53+
Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/). These spans are always created, even if you have sampling disabled.
54+
</Alert>
55+
4056
## Notifications
4157

4258
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 "outage". Then choose how you'd like to be notified (via email, Slack, and so on).

docs/product/uptime-monitoring/uptime-tracing.mdx

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@ sidebar_order: 52
44
description: "Learn how to use distributed tracing to troubleshoot downtime."
55
---
66

7-
Sentry's Uptime Monitoring uses [distributed tracing](/product/tracing/#whats-distributed-tracing) to track the flow and timing of requests and operations during uptime checks. This helps you quickly find the root cause of downtime by connecting related errors and performance data.
7+
Sentry's Uptime Monitoring uses [distributed tracing](/product/tracing/#whats-distributed-tracing) to track the flow and timing of requests and operations during uptime checks. This helps you quickly find the root cause of downtime by connecting related errors and performance data.
88

9-
You can trace errors to identify and diagnose issues like crashes or exceptions. This is automatically enabled for all Uptime Alerts. You can also trace spans to monitor the performance and flow of operations, such as API calls or database queries. Span tracing is disabled by default, but can be enabled by allowing sampling in your Uptime Alert settings. Errors focus on problems, while spans focus on performance.
9+
When uptime checks are performed, Sentry creates a **trace** that shows the complete request lifecycle. This trace contains:
10+
11+
- **Uptime request spans**: A [default set of root spans](/product/uptime-monitoring/#uptime-request-spans) that identifies this as an uptime check
12+
- **Application spans**: Individual operations like database queries, API calls, and cache operations, configured through distributed tracing
13+
- **Error events**: Any exceptions or failures that occur during the request
14+
15+
**Error tracing** captures when things go wrong, while **span tracing** shows the performance and flow of operations. Together, they provide complete visibility into why an uptime check failed. Span tracing is disabled by default for uptime checks, but can be enabled by allowing sampling in your [Uptime Alert settings](/product/alerts/create-alerts/uptime-alert-config/). Errors plus spans focus on problems, while uptime monitoring plus spans focus on performance.
1016

1117
## How Uptime Tracing Works
1218

@@ -56,15 +62,23 @@ Sentry.init({
5662
5763
## Tracing Spans
5864
59-
Unlike error tracing, span tracing is **disabled** by default for uptime checks, but can be enabled by allowing sampling in your Uptime Alert settings. Enabling span tracing can be helpful because it provides a detailed view of the timing and flow of requests and operations during uptime checks, which is especially useful for diagnosing timeouts or performance issues.
65+
There are two sets of spans avaialble for uptime checks:
66+
1. **Uptime request spans**. These are automatically created by Sentry for every uptime check request. You can find them as the root of any uptime issue's trace.
67+
2. **Application spans**. These are spans that are configured through distributed tracing. You can find them as the children of uptime request spans.
68+
69+
Unlike error tracing, span tracing that you configure is **disabled** by default for uptime checks, but can be enabled by allowing sampling in your [Uptime Alert settings](/product/alerts/create-alerts/uptime-alert-config/). Enabling span tracing can be helpful because it provides a detailed view of the timing and flow of requests and operations during uptime checks, which is especially useful for diagnosing timeouts or performance issues.
6070
6171
### Enabling Uptime Tracing for Spans
6272
6373
To enable span tracing, modify your Uptime Alert settings with the "Allow Sampling" option. This will ensure that Sentry defers the sampling decision to your SDK, which will follow the trace sample rate you've configured.
6474
6575
Because uptime requests won't override your SDK’s error sampling rate, some errors may not appear in traces if that rate is set to below 1.
6676
67-
![Uptime Alert Allow Sampling Configuration](./img/uptime-allow-sampling.png)
77+
![Uptime Alert Allow Sampling Configuration](./img/allow-sampling-new.png)
78+
79+
<Alert>
80+
Uptime request spans will always be on, even if sampling is disabled. Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/).
81+
</Alert>
6882
6983
### Custom Sampling
7084

0 commit comments

Comments
 (0)