-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs: Add strict trace continuation for Dart/Flutter #16986
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.
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
Draft
antonis
wants to merge
3
commits into
master
Choose a base branch
from
docs/strict-trace-continuation-dart-flutter
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−0
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -240,3 +240,21 @@ String entries do not have to be full matches, meaning the URL of a request is m | |||||
| If <PlatformIdentifier name="tracePropagationTargets" /> is not provided, trace data is attached to every outgoing request from the instrumented client. | ||||||
|
|
||||||
| </SdkOption> | ||||||
|
|
||||||
| <SdkOption name="strictTraceContinuation" type="bool" defaultValue="false"> | ||||||
|
|
||||||
| If set to `true`, the SDK will only continue a trace if the organization ID of the incoming trace found in the `baggage` header matches the organization ID of the current Sentry client. | ||||||
|
|
||||||
| The client's organization ID is extracted from the DSN or can be set with the `orgId` option. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| If the organization IDs do not match, the SDK will start a new trace instead of continuing the incoming one. This is useful to prevent traces of unknown third-party services from being continued in your application. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| </SdkOption> | ||||||
|
|
||||||
| <SdkOption name="orgId" type="String?"> | ||||||
|
|
||||||
| The organization ID for your Sentry project. | ||||||
|
|
||||||
| The SDK will try to extract the organization ID from the DSN. If it cannot be found, or if you need to override it, you can provide the ID with this option. The organization ID is used for trace propagation and features like `strictTraceContinuation`. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| </SdkOption> | ||||||
30 changes: 30 additions & 0 deletions
30
platform-includes/distributed-tracing/how-to-use/dart.flutter.mdx
This file contains hidden or 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,3 +1,33 @@ | ||
| If you're using the current version of our Flutter SDK, distributed tracing will work out of the box. | ||
|
|
||
| If you're using version `7.10.0` or below, you'll need to have our <PlatformLink to="/tracing/">tracing feature enabled</PlatformLink> in order for distributed tracing to work. | ||
|
|
||
| ### Strict Trace Continuation | ||
|
|
||
| When your application receives requests, they might include `sentry-trace` and `baggage` headers from an upstream service that is also using Sentry. | ||
| By default, the SDK will continue the trace from these incoming headers. However, this behavior can be undesirable if the requests are from a third-party service, | ||
| as it can lead to unwanted traces, increased billing, and skewed performance data. | ||
|
|
||
| To prevent this, you can enable `strictTraceContinuation`. When this option is set to `true`, the SDK checks the incoming trace for Sentry trace information and only continues it if it belongs to the same Sentry organization. | ||
| Otherwise, it starts a new trace. | ||
|
|
||
| ```dart {4} | ||
| await SentryFlutter.init((options) { | ||
| options.dsn = '___PUBLIC_DSN___'; | ||
| options.tracesSampleRate = 1.0; | ||
| // Ensure that only traces from your own organization are continued | ||
| options.strictTraceContinuation = true; | ||
| }); | ||
| ``` | ||
|
|
||
| The SDK automatically parses the organization ID from your DSN. If you use a DSN format that doesn't include the organization ID (number followed by the letter `"o"`), or if you need to override it, you can provide it manually using the `orgId` option: | ||
|
|
||
| ```dart {5} | ||
| await SentryFlutter.init((options) { | ||
| options.dsn = '___PUBLIC_DSN___'; | ||
| options.tracesSampleRate = 1.0; | ||
| options.strictTraceContinuation = true; | ||
| // Manually provide your organization ID (overrides organization ID parsed from DSN) | ||
| options.orgId = '12345'; | ||
| }); | ||
antonis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.