Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions docs/platforms/dart/common/configuration/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
If set to `true`, the SDK will only continue a trace when the organization ID in the incoming `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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The client's organization ID is extracted from the DSN or can be set with the `orgId` option.
The client's organization ID is extracted from the DSN or can be explicitly set with the `orgId` option.


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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The 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.
If the organization IDs don't 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.


</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`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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`.
The SDK will try to extract the organization ID from the DSN. If it can't be found, or if you need to override it, you can explicitly provide the ID with this option. The organization ID is used for trace propagation and features like `strictTraceContinuation`.


</SdkOption>
30 changes: 30 additions & 0 deletions platform-includes/distributed-tracing/how-to-use/dart.flutter.mdx
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';
});
```
Loading