Skip to content

docs(rust): Document strict trace continuation options #18872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
szokeasaurusrex wants to merge 1 commit into
base: master
Choose a base branch
from
+38 −0
Open

docs(rust): Document strict trace continuation options #18872

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/platforms/rust/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,44 @@ Calling `.traces_sampler(...)` selects `TracesSamplingStrategy::Function` and re

</SdkOption>

<SdkOption name="org_id" type='OrganizationId'>

An optional override for the SDK's organization ID.

By default, the organization ID is parsed from the DSN. This only works for Sentry SaaS ingest hosts (`o123.ingest.sentry.io`, including regional hosts such as `o123.ingest.us.sentry.io`). For self-hosted Sentry and local Relay setups, it cannot be derived from the DSN, so set it explicitly with this option.

The organization ID is used for trace continuation, including <PlatformLink to="/configuration/options#strict_trace_continuation">strict trace continuation</PlatformLink>.

</SdkOption>

<SdkOption name="strict_trace_continuation" type='bool' defaultValue='false'>

When enabled, the SDK only continues an incoming trace if it contains an organization ID that matches the current Sentry client's.

Third-party services instrumented with Sentry by another organization can send traces to your application through incoming `sentry-trace` and `baggage` headers. To keep those separate from your own traces, the SDK compares the incoming `sentry-org_id` (from the `baggage` header) with the client's organization ID.

Whenever both organization IDs are known and differ, the SDK starts a new trace instead of continuing the incoming one, regardless of this option. Enabling this option extends that to traces carrying no organization ID: they are never continued. When disabled (the default), such traces are.

Starting a new trace means a new trace ID, no parent span, and a fresh sampling decision.

<Alert>

We recommend enabling strict trace continuation only when the SDK knows its organization ID. SaaS DSNs embed the organization ID, so no further configuration is needed.

For self-hosted Sentry and local Relay setups, you should configure `org_id` explicitly, since it cannot be derived from those DSNs.

</Alert>

<Alert level="warning">

Not all SDKs attach an organization ID to outgoing traces yet — including the Rust SDK itself. If a service sending requests to your application uses such an SDK, keep this option disabled, or its traces will not be continued.

</Alert>

Learn more in <PlatformLink to="/tracing/trace-propagation/">Trace Propagation</PlatformLink>.

</SdkOption>

## Transport Options

<SdkOption name="http_proxy" type='string' envVar='HTTP_PROXY'>
Expand Down
Loading