Add Distributed Tracing Docs for Uptime #11911
Open
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 444 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
|
|
||
| ## How Uptime Tracing Works | ||
|
|
||
| Sentry Uptime Tracing automatically appends a `sentry-trace` header to every outgoing request made to the configured URL in your Uptime Alert settings. This header propagates trace information. |
There was a problem hiding this comment.
Suggested change
| Sentry Uptime Tracing automatically appends a `sentry-trace` header to every outgoing request made to the configured URL in your Uptime Alert settings. This header propagates trace information. | |
| Sentry Uptime Tracing automatically appends a `sentry-trace` header to every outgoing request made to the configured URL in your Uptime Alert settings. This header propagates a trace identifier. |
maybe more obvious?
Comment on lines
+30
to
+34
| <Alert level="warning" title="Important"> | ||
|
|
||
| Uptime check requests do not override your SDK's error sampling rate. If your SDK’s error sample rate is set below 1, some errors from uptime check requests may not appear in the trace. | ||
|
|
||
| </Alert> |
There was a problem hiding this comment.
Suggested change
| <Alert level="warning" title="Important"> | |
| Uptime check requests do not override your SDK's error sampling rate. If your SDK’s error sample rate is set below 1, some errors from uptime check requests may not appear in the trace. | |
| </Alert> | |
| <Alert level="warning" title="Important"> | |
| Uptime check requests do not override your SDK's error sampling rate. If your SDK’s error sample rate is set below 1, some errors from uptime check requests may not appear in the trace. | |
| </Alert> |
I think you don't need these spaces anymore
Comment on lines
+36
to
+58
| ### Disabling Uptime Tracing of Errors | ||
|
|
||
| To disable error tracing for uptime checks, configure a [before send](/platform-redirect/?next=/configuration/filtering/) filter in your SDK to ignore errors from Sentry's `User-Agent`. Here's an example: | ||
|
|
||
| ```typescript {tabTitle: Node.js Express} {filename: instrument.mjs} | ||
| import * as Sentry from "@sentry/node"; | ||
|
|
||
| Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| // Filtering example for a Node.js Express app | ||
| beforeSend(event) { | ||
| const userAgent = event.request?.headers?.["user-agent"]; | ||
|
|
||
| // Ignore events captured in a request from SentryUptimeBot | ||
| if (userAgent && userAgent.includes("SentryUptimeBot")) { | ||
| return null; | ||
| } | ||
|
|
||
| // Process other events | ||
| return event; | ||
| }, | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
This section feels a little high, since I imagine most people don't want to disable error tracing
Comment on lines
+72
to
+76
| <Alert level="warning" title="Important"> | ||
|
|
||
| Uptime check requests do not override your SDK's trace sampling rate. If your SDK's trace sample rate is set below 1, some spans from uptime check requests may not appear in the trace. | ||
|
|
||
| </Alert> |
There was a problem hiding this comment.
Suggested change
| <Alert level="warning" title="Important"> | |
| Uptime check requests do not override your SDK's trace sampling rate. If your SDK's trace sample rate is set below 1, some spans from uptime check requests may not appear in the trace. | |
| </Alert> | |
| <Alert level="warning" title="Important"> | |
| Uptime check requests do not override your SDK's trace sampling rate. If your SDK's trace sample rate is set below 1, some spans from uptime check requests may not appear in the trace. | |
| </Alert> |
|
|
||
| ## Billing Considerations | ||
|
|
||
| Captured errors and spans from uptime check requests are billed as regular events in Sentry. |
There was a problem hiding this comment.
Is there a page we can link to for this?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new distributed tracing page for uptime that describes how it works, and how it can be enabled or disabled for errors and spans.