Propagated Sampling Rates #11912

cleptric · 2024-11-22T07:29:24Z

No description provided.

vercel · 2024-11-22T07:29:29Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
develop-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 22, 2024 8:22am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Nov 22, 2024 8:22am
sentry-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 22, 2024 8:22am

antonpirker · 2024-11-22T09:06:54Z

develop-docs/sdk/telemetry/traces/index.mdx

@@ -65,6 +65,21 @@ This Option replaces the non-standardized `tracingOrigins` option which was prev

 </Alert>

+### `strictTracePropagation`
+
+This option disables trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.


Suggested change

This option disables trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.

This should be a boolean value. Default is `false`. This option controls trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.

antonpirker · 2024-11-22T09:08:09Z

develop-docs/sdk/telemetry/traces/index.mdx

+
+This option disables trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.
+
+If the SDK can parse an org ID from the configured DSN, this value must be propagated as a baggage entry with the key `sentry-org`. Given a DSN of `https://[email protected]/1`, the org ID is `1`, based on `o1`.


Suggested change

If the SDK can parse an org ID from the configured DSN, this value must be propagated as a baggage entry with the key `sentry-org`. Given a DSN of `https://[email protected]/1`, the org ID is `1`, based on `o1`.

If the SDK can parse an org ID from the configured DSN, it must be propagated as a baggage entry with the key `sentry-org`. Given a DSN of `https://[email protected]/1`, the org ID is `1`, based on `o1`.

antonpirker · 2024-11-22T09:10:26Z

develop-docs/sdk/telemetry/traces/index.mdx

+If the SDK can parse an org ID from the configured DSN, this value must be propagated as a baggage entry with the key `sentry-org`. Given a DSN of `https://[email protected]/1`, the org ID is `1`, based on `o1`.
+
+On incoming traces, the SDK must compare the `sentry-org` baggage value against its own parsed value from the DSN. Only if both match, the trace is continued. If there is no match, neither the trace ID, the parent sampling decision nor the baggage should be taken into account.
+The SDK should behave like it is the head of trace in this case.


This sentence I do not understand. Can you please reword this?

antonpirker · 2024-11-22T09:11:56Z

develop-docs/sdk/telemetry/traces/index.mdx

+
+This behavior can be disabled by setting `strictTracePropagation: false` in the SDK init call.
+Initially, SDKs should introduce the this option with a default values of `false`.
+Once the majority of SDKs introduced this option, we will make it opt-out in a major version.


Suggested change

Once the majority of SDKs introduced this option, we will make it opt-out in a major version.

Once the majority of SDKs introduced this option, we will change the default value to `true` (in a major version bump) making it opt-out.

antonpirker · 2024-11-22T09:21:43Z

develop-docs/sdk/telemetry/traces/index.mdx

@@ -185,6 +201,35 @@ Depending on the platform, other default data may be included. (For example, for

 A transaction's sampling decision should be passed to all of its children, including across service boundaries. This can be accomplished in the `startChild` method for same-service children and using the `senry-trace` header for children in a different service.

+### Propagated Sampling Rates
+
+To increase the chance of capturing complete traces when users return a new sample rate from the `tracesSampler` in backend services, we propagate the generated random value used by the SDK for computing the sampling decision instead of creating a new random value in every service. Therefore, across a trace every SDK uses the same random value.


Suggested change

To increase the chance of capturing complete traces when users return a new sample rate from the `tracesSampler` in backend services, we propagate the generated random value used by the SDK for computing the sampling decision instead of creating a new random value in every service. Therefore, across a trace every SDK uses the same random value.

To increase the chance of capturing complete traces when users return a new sample rate from the `tracesSampler` in backend services, we propagate the generated random value used by the SDK for making the sampling decision instead of creating a new random value in every service. Therefore, across a trace every SDK uses the same random value.

antonpirker · 2024-11-22T09:32:58Z

develop-docs/sdk/telemetry/traces/index.mdx

+
+The behavior of the static `tracesSampleRate` without the use of `tracesSampler` does not change. We continue to fully inherit sampling decisions for propagated traces and create a new one for started traces. In the future, we might change the default behavior of `tracesSampleRate`, too.
+
+Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.


Suggested change

Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.

When a new trace is started by the SDK, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.

antonpirker · 2024-11-22T09:42:44Z

develop-docs/sdk/telemetry/traces/index.mdx

+- When the `tracesSampler` is invoked, this also applies to the return value of traces sampler. i.e. `trace["sentry-sample_rand"] < tracesSampler(context)`
+- Otherwise, when the SDK is the head of a trace, this applies to sample decisions based on `tracesSampleRate` , i.e. `trace["sentry-sample_rand"] < config.tracesSampleRate`
+
+When using a `tracesSampler`, the most correct way to inherit parent sampling decisions is now to return the parent's sample rate instead of the decision as float (1.0). This way, we can still extrapolate counts correctly.


Suggested change

When using a `tracesSampler`, the most correct way to inherit parent sampling decisions is now to return the parent's sample rate instead of the decision as float (1.0). This way, we can still extrapolate counts correctly.

When using a `tracesSampler`, the correct way to inherit parent sampling decisions is now to return the parent's sample rate instead of the decision as float (1.0). This way, we can still extrapolate counts correctly.

antonpirker · 2024-11-22T09:44:20Z

develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx

@@ -60,6 +61,8 @@ The rest of the context attributes, `trace_id`, `public_key`, and `sample_rate`,
 | `release`                   | string | The release name as specified in client options.                                                                             | `[email protected]`, `1.2.3`, `2025.4.107` | required                             |
 | `environment`               | string | The environment name as specified in client options.                                                                         | `production`, `staging`              | required                             |
 | `transaction`               | string | The transaction name set on the scope. **Only include** if name has [good quality](#note-on-good-quality-transaction-names). | `/login`, `myApp.myController.login` | required (if known and good quality) |
+| `org`                       | string | The org ID parsed from the DSN or received by a downstream SDK.                                                              | `1`                                  | required                             |
+| `sample_rand`               | string | A trully random number originating from the head of trace SDK.                                                               | `0.5`                                | required                             |


antonpirker · 2024-11-22T09:44:52Z

develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx

@@ -60,6 +61,8 @@ The rest of the context attributes, `trace_id`, `public_key`, and `sample_rate`,
 | `release`                   | string | The release name as specified in client options.                                                                             | `[email protected]`, `1.2.3`, `2025.4.107` | required                             |
 | `environment`               | string | The environment name as specified in client options.                                                                         | `production`, `staging`              | required                             |
 | `transaction`               | string | The transaction name set on the scope. **Only include** if name has [good quality](#note-on-good-quality-transaction-names). | `/login`, `myApp.myController.login` | required (if known and good quality) |
+| `org`                       | string | The org ID parsed from the DSN or received by a downstream SDK.                                                              | `1`                                  | required                             |
+| `sample_rand`               | string | A trully random number originating from the head of trace SDK.                                                               | `0.5`                                | required                             |


Does it have to be a true random number? (I guess not all systems can create a true random number)

sentrivana · 2024-11-22T09:51:32Z

develop-docs/sdk/telemetry/traces/index.mdx

+The SDK should behave like it is the head of trace in this case.
+
+This behavior can be disabled by setting `strictTracePropagation: false` in the SDK init call.
+Initially, SDKs should introduce the this option with a default values of `false`.


Suggested change

Initially, SDKs should introduce the this option with a default values of `false`.

Initially, SDKs should introduce the this option with a default value of `false`.

sentrivana · 2024-11-22T09:52:10Z

develop-docs/sdk/telemetry/traces/index.mdx

+Initially, SDKs should introduce the this option with a default values of `false`.
+Once the majority of SDKs introduced this option, we will make it opt-out in a major version.
+
+The SDK must be configurable with an optional `org: <org-id>` setting that takes precedence over the parsed value from the DSN. This option should be set when running a self-hosted version of Sentry or if a none standard Sentry DSN is used, such as when using a local Relay.


Suggested change

The SDK must be configurable with an optional `org: <org-id>` setting that takes precedence over the parsed value from the DSN. This option should be set when running a self-hosted version of Sentry or if a none standard Sentry DSN is used, such as when using a local Relay.

The SDK must be configurable with an optional `org: <org-id>` setting that takes precedence over the parsed value from the DSN. This option should be set when running a self-hosted version of Sentry or if a non-standard Sentry DSN is used, such as when using a local Relay.

sentrivana · 2024-11-22T09:52:58Z

develop-docs/sdk/telemetry/traces/dynamic-sampling-context.mdx

@@ -49,7 +49,8 @@ To align DSC propagation over all our SDKs, we defined a [unified propagation me
 All of the attributes in the table below are required (non-optional) in a sense, that when they are known to an SDK at the time an envelope with an event (transaction or error) is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

 At the moment, only `release`, `environment` and `transaction` are used by the product for dynamic sampling functionality.
-The rest of the context attributes, `trace_id`, `public_key`, and `sample_rate`, are used by Relay for internal decisions (like transaction sample rate smoothing).
+The rest of the context attributes, `trace_id`, `public_key`, `sampled` and `sample_rate`, are used by Relay for internal decisions (like transaction sample rate smoothing).
+Additional entries such as `replay_id`, `org` and `sample_rand` are only using the DSC as a mean of transport.


Suggested change

Additional entries such as `replay_id`, `org` and `sample_rand` are only using the DSC as a mean of transport.

Additional entries such as `replay_id`, `org` and `sample_rand` are only using the DSC as a means of transport.

sentrivana · 2024-11-22T09:54:40Z

develop-docs/sdk/telemetry/traces/index.mdx

+
+The behavior of the static `tracesSampleRate` without the use of `tracesSampler` does not change. We continue to fully inherit sampling decisions for propagated traces and create a new one for started traces. In the future, we might change the default behavior of `tracesSampleRate`, too.
+
+Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.


Suggested change

Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.

Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on the fly.

sentrivana · 2024-11-22T09:59:18Z

develop-docs/sdk/telemetry/traces/index.mdx


 ### `tracesSampler`

 This should be a callback, called when a transaction is started, which will be given a `samplingContext` object and which should return a sample rate between `0.0` and `1.0` _for the transaction in question_. This sample rate should behave the same way as the `tracesSampleRate` above, with the difference that it only applies to the newly-created transaction, such that different transactions can be sampled at different rates. Returning `0.0` should force the transaction to be dropped (set to `sampled = false`) and returning `1.0` should force the transaction to be sent (set `sampled = true`).

-Optionally, the `tracesSampler` callback can also return a boolean to force a sampling decision (with `false` equivalent to `0.0` and `true` equivalent to `1.0`). If returning two different datatypes isn't an option in the implementing language, this possibility can safely be omitted.
+Historically, the `tracesSampler` callback could have also returned a boolean to force a sampling decision (with `false` equivalent to `0.0` and `true` equivalent to `1.0`). This behavior is now **deprecated** and should be removed from all SDKs.


Why deprecate this and not just keep treating true as 1.0 and false as 0.0?

Propagated Sampling Rates

e79e54a

vercel bot deployed to Preview – develop-docs November 22, 2024 07:39 View deployment

Clarify org setting

c93add7

cleptric requested a review from jan-auer November 22, 2024 08:13

vercel bot deployed to Preview – develop-docs November 22, 2024 08:22 View deployment

antonpirker reviewed Nov 22, 2024

View reviewed changes

sentrivana reviewed Nov 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Propagated Sampling Rates #11912

Propagated Sampling Rates #11912

cleptric commented Nov 22, 2024

vercel bot commented Nov 22, 2024 •

edited

Loading

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

antonpirker Nov 22, 2024

sentrivana Nov 22, 2024

sentrivana Nov 22, 2024

sentrivana Nov 22, 2024

sentrivana Nov 22, 2024

sentrivana Nov 22, 2024

	This option disables trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.
	This should be a boolean value. Default is `false`. This option controls trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.


		This option disables trace continuation from unknown 3rd party services that happen to be instrumented by a Sentry SDK.

		If the SDK can parse an org ID from the configured DSN, this value must be propagated as a baggage entry with the key `sentry-org`. Given a DSN of `https://[email protected]/1`, the org ID is `1`, based on `o1`.

	Once the majority of SDKs introduced this option, we will make it opt-out in a major version.
	Once the majority of SDKs introduced this option, we will change the default value to `true` (in a major version bump) making it opt-out.

	To increase the chance of capturing complete traces when users return a new sample rate from the `tracesSampler` in backend services, we propagate the generated random value used by the SDK for computing the sampling decision instead of creating a new random value in every service. Therefore, across a trace every SDK uses the same random value.
	To increase the chance of capturing complete traces when users return a new sample rate from the `tracesSampler` in backend services, we propagate the generated random value used by the SDK for making the sampling decision instead of creating a new random value in every service. Therefore, across a trace every SDK uses the same random value.


		The behavior of the static `tracesSampleRate` without the use of `tracesSampler` does not change. We continue to fully inherit sampling decisions for propagated traces and create a new one for started traces. In the future, we might change the default behavior of `tracesSampleRate`, too.

		Once the SDK starts a new trace, `sentry-sample_rand` is filled with a truly random number. This also applies when the `tracesSampleRate` is set to `1.0`. If the SDK receives an incoming trace, containing a `sentry-sample_rand` entry in the baggage, this value should overwrite the currently stored number. For incoming traces without a `sentry-sample_rand` baggage entry (from old SDKs), the SDK inserts a new truly random number on-the-fly.

	When using a `tracesSampler`, the most correct way to inherit parent sampling decisions is now to return the parent's sample rate instead of the decision as float (1.0). This way, we can still extrapolate counts correctly.
	When using a `tracesSampler`, the correct way to inherit parent sampling decisions is now to return the parent's sample rate instead of the decision as float (1.0). This way, we can still extrapolate counts correctly.

	\| `sample_rand` \| string \| A trully random number originating from the head of trace SDK. \| `0.5` \| required \|
	\| `sample_rand` \| string \| A truly random number originating from the head of trace SDK. \| `0.5` \| required \|

	Initially, SDKs should introduce the this option with a default values of `false`.
	Initially, SDKs should introduce the this option with a default value of `false`.

	The SDK must be configurable with an optional `org: <org-id>` setting that takes precedence over the parsed value from the DSN. This option should be set when running a self-hosted version of Sentry or if a none standard Sentry DSN is used, such as when using a local Relay.
	The SDK must be configurable with an optional `org: <org-id>` setting that takes precedence over the parsed value from the DSN. This option should be set when running a self-hosted version of Sentry or if a non-standard Sentry DSN is used, such as when using a local Relay.

	Additional entries such as `replay_id`, `org` and `sample_rand` are only using the DSC as a mean of transport.
	Additional entries such as `replay_id`, `org` and `sample_rand` are only using the DSC as a means of transport.

Propagated Sampling Rates #11912

Are you sure you want to change the base?

Propagated Sampling Rates #11912

Conversation

cleptric commented Nov 22, 2024

vercel bot commented Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented Nov 22, 2024 •

edited

Loading