getsentry · lforst · Jan 22, 2025 · Jan 9, 2025 · Jan 13, 2025 · Jan 13, 2025
diff --git a/packages/browser/test/tracing/browserTracingIntegration.test.ts b/packages/browser/test/tracing/browserTracingIntegration.test.ts
@@ -18,7 +18,6 @@
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   TRACING_DEFAULTS,
@@ -104,7 +103,6 @@
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
       },
       span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -176,7 +174,6 @@
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.pageload.browser',
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
       },
       span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -291,7 +288,6 @@
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
           [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual',
           [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-          [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
         },
         span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -327,7 +323,6 @@
         data: {
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
           [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.test',
-          [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
           [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
           testy: 'yes',
@@ -684,7 +679,7 @@
      });

      const propCtxBeforeEnd = getCurrentScope().getPropagationContext();
      expect(propCtxBeforeEnd).toStrictEqual({
        sampleRand: expect.any(Number),
        traceId: expect.stringMatching(/[a-f0-9]{32}/),
      });
@@ -724,7 +719,7 @@
      });

      const propCtxBeforeEnd = getCurrentScope().getPropagationContext();
      expect(propCtxBeforeEnd).toStrictEqual({
        traceId: expect.stringMatching(/[a-f0-9]{32}/),
        sampleRand: expect.any(Number),
      });

diff --git a/packages/core/src/envelope.ts b/packages/core/src/envelope.ts
@@ -1,5 +1,4 @@
 import type { Client } from './client';
-import { SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE } from './semanticAttributes';
 import { getDynamicSamplingContextFromSpan } from './tracing/dynamicSamplingContext';
 import type { SentrySpan } from './tracing/sentrySpan';
 import type {
@@ -142,11 +141,6 @@ export function createSpanEnvelope(spans: [SentrySpan, ...SentrySpan[]], client?
   const items: SpanItem[] = [];
   for (const span of spans) {
     const spanJson = convertToSpanJSON(span);
-
-    // This attribute is important for internal logic but should not leak into actual data
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
-    delete spanJson.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
-
     if (spanJson) {
       items.push(createSpanEnvelopeItem(spanJson));
     }

diff --git a/packages/core/src/semanticAttributes.ts b/packages/core/src/semanticAttributes.ts
@@ -12,11 +12,6 @@ export const SEMANTIC_ATTRIBUTE_SENTRY_SOURCE = 'sentry.source';
  */
 export const SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE = 'sentry.sample_rate';
 
-/**
- * Use this attribute on a root span to propagate the spans sample rate downstream as parent sample rate in the DSC, overriding anything that was previously set on the DSC.
- */
-export const SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE = 'sentry.override_trace_sample_rate';
-
 /**
  * Use this attribute to represent the operation of a span.
  */

diff --git a/packages/core/src/tracing/dynamicSamplingContext.ts b/packages/core/src/tracing/dynamicSamplingContext.ts
@@ -2,11 +2,7 @@ import type { Client } from '../client';
 import { DEFAULT_ENVIRONMENT } from '../constants';
 import { getClient } from '../currentScopes';
 import type { Scope } from '../scope';
-import {
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
-  SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
-  SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
-} from '../semanticAttributes';
+import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
 import type { DynamicSamplingContext, Span } from '../types-hoist';
 import {
   baggageHeaderToDynamicSamplingContext,
@@ -79,17 +75,13 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
   }
 
   const rootSpan = getRootSpan(span);
-  const rootSpanJson = spanToJSON(rootSpan);
-  const rootSpanAttributes = rootSpanJson.data;
-  const shouldOverrideDscSampleRate = rootSpanAttributes[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
-  const maybeSampleRate = rootSpanAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE];
+  const rootSpanPropagationContext = getCapturedScopesOnSpan(rootSpan).scope?.getPropagationContext();
 
   // The root span sample rate should always be applied to the DSC, even if the DSC is frozen.
   // This is so that the downstream traces/services can use parentSampleRate in their `tracesSampler` to make consistent sampling decisions across the entire trace.
   function applyRootSpanSampleRateToDsc(dsc: Partial<DynamicSamplingContext>): Partial<DynamicSamplingContext> {
-    // Note: This is a `!= null` check meaning "nullish"
-    if (shouldOverrideDscSampleRate && maybeSampleRate != null) {
-      dsc.sample_rate = `${maybeSampleRate}`;
+    if (rootSpanPropagationContext?.sampleRateOverride !== undefined) {
+      dsc.sample_rate = `${rootSpanPropagationContext.sampleRateOverride}`;
     }
     return dsc;
   }
@@ -114,6 +106,10 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
   // Else, we generate it from the span
   const dsc = getDynamicSamplingContextFromClient(span.spanContext().traceId, client);
 
+  const rootSpanJson = spanToJSON(rootSpan);
+  const rootSpanAttributes = rootSpanJson.data;
+  const maybeSampleRate = rootSpanAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE];
+
   // Note: This is a `!= null` check meaning "nullish"
   if (maybeSampleRate != null) {
     dsc.sample_rate = `${maybeSampleRate}`;
@@ -133,7 +129,7 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
   // So we end up with an active span that is not sampled (neither positively nor negatively)
   if (hasTracingEnabled()) {
     dsc.sampled = String(spanIsSampled(rootSpan));
-    dsc.sample_rand = getCapturedScopesOnSpan(rootSpan).scope?.getPropagationContext().sampleRand.toString();
+    dsc.sample_rand = rootSpanPropagationContext?.sampleRand.toString();
   }
 
   client.emit('createDsc', dsc, rootSpan);

diff --git a/packages/core/src/tracing/sampling.ts b/packages/core/src/tracing/sampling.ts
@@ -21,7 +21,7 @@ export function sampleSpan(
     return [false];
   }
 
-  let shouldUpdateSampleRateOnDsc = undefined;
+  let shouldUpdateSampleRateOnDsc: undefined | true = undefined;
 
   // we would have bailed already if neither `tracesSampler` nor `tracesSampleRate` nor `enableTracing` were defined, so one of these should
   // work; prefer the hook if so
@@ -74,8 +74,7 @@ export function sampleSpan(
           sampleRate,
         )})`,
       );
-    return [false, parsedSampleRate, shouldUpdateSampleRateOnDsc];
   }
 
-  return [true, parsedSampleRate, shouldUpdateSampleRateOnDsc];
+  return [shouldSample, parsedSampleRate, shouldUpdateSampleRateOnDsc];
 }
diff --git a/packages/core/src/tracing/sentrySpan.ts b/packages/core/src/tracing/sentrySpan.ts
@@ -7,7 +7,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 } from '../semanticAttributes';
 import type {
@@ -349,10 +348,8 @@ export class SentrySpan implements Span {
     // remove internal root span attributes we don't need to send.
     /* eslint-disable @typescript-eslint/no-dynamic-delete */
     delete this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
-    delete this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
     spans.forEach(span => {
-      delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
-      delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
+      span.data && delete span.data[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
     });
     // eslint-enabled-next-line @typescript-eslint/no-dynamic-delete
 

diff --git a/packages/core/src/tracing/trace.ts b/packages/core/src/tracing/trace.ts
@@ -16,11 +16,7 @@ import { getClient, getCurrentScope, getIsolationScope, withScope } from '../cur
 import { getAsyncContextStrategy } from '../asyncContext';
 import { DEBUG_BUILD } from '../debug-build';
 import type { Scope } from '../scope';
-import {
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
-  SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
-  SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
-} from '../semanticAttributes';
+import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
 import { logger } from '../utils-hoist/logger';
 import { generateTraceId } from '../utils-hoist/propagationContext';
 import { propagationContextFromHeaders } from '../utils-hoist/tracing';
@@ -442,7 +438,9 @@ function _startRootSpan(spanArguments: SentrySpanArguments, scope: Scope, parent
 
   if (sampleRate !== undefined) {
     rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, sampleRate);
-    rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE, shouldUpdateSampleRateOnDsc);
+    if (shouldUpdateSampleRateOnDsc) {
+      currentPropagationContext.sampleRateOverride = sampleRate;
+    }
   }
 
   if (client) {

diff --git a/packages/core/src/types-hoist/tracing.ts b/packages/core/src/types-hoist/tracing.ts
@@ -50,6 +50,16 @@ export interface PropagationContext {
    * The current SDK should not modify this value!
    */
   dsc?: Partial<DynamicSamplingContext>;
+
+  /**
+   * This is set when the currently incoming sample rate should be overridden for further propagation.
+   *
+   * This is the case whenever
+   * - the tracesSampleRate is applied
+   * - the tracesSampler is invoked
+   */
+  // TODO: Link to docs when this is properly specified. For now: https://github.com/getsentry/team-sdks/issues/117
+  sampleRateOverride?: number;
 }
 
 /**

diff --git a/packages/opentelemetry/src/sampler.ts b/packages/opentelemetry/src/sampler.ts
@@ -13,7 +13,6 @@ import {
 import type { Client, SpanAttributes } from '@sentry/core';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   hasTracingEnabled,
   logger,
@@ -121,9 +120,12 @@ export class SentrySampler implements Sampler {
 
       const attributes: Attributes = {
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: sampleRate,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: shouldUpdateSampleRateOnDsc,
       };
 
+      if (currentPropagationContext && sampleRate && shouldUpdateSampleRateOnDsc) {
+        currentPropagationContext.sampleRateOverride = sampleRate;
+      }
+
       const method = `${maybeSpanHttpMethod}`.toUpperCase();
       if (method === 'OPTIONS' || method === 'HEAD') {
         DEBUG_BUILD && logger.log(`[Tracing] Not sampling span because HTTP method is '${method}' for ${spanName}`);

diff --git a/packages/opentelemetry/src/spanExporter.ts b/packages/opentelemetry/src/spanExporter.ts
@@ -15,7 +15,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   captureEvent,
@@ -392,7 +391,6 @@ function removeSentryAttributes(data: Record<string, unknown>): Record<string, u
   delete cleanedData[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE];
   delete cleanedData[SEMANTIC_ATTRIBUTE_SENTRY_PARENT_IS_REMOTE];
   delete cleanedData[SEMANTIC_ATTRIBUTE_SENTRY_CUSTOM_SPAN_NAME];
-  delete cleanedData[SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE];
   /* eslint-enable @typescript-eslint/no-dynamic-delete */
 
   return cleanedData;

diff --git a/packages/opentelemetry/test/sampler.test.ts b/packages/opentelemetry/test/sampler.test.ts
@@ -28,7 +28,7 @@ describe('SentrySampler', () => {
     const actual = sampler.shouldSample(ctx, traceId, spanName, spanKind, spanAttributes, links);
     expect(actual).toEqual({
       decision: SamplingDecision.NOT_RECORD,
-      attributes: { 'sentry.sample_rate': 0, 'sentry.override_trace_sample_rate': true },
+      attributes: { 'sentry.sample_rate': 0 },
       traceState: new TraceState().set('sentry.sampled_not_recording', '1'),
     });
     expect(spyOnDroppedEvent).toHaveBeenCalledTimes(1);
@@ -80,7 +80,7 @@ describe('SentrySampler', () => {
     const actual = sampler.shouldSample(ctx, traceId, spanName, spanKind, spanAttributes, links);
     expect(actual).toEqual({
       decision: SamplingDecision.RECORD_AND_SAMPLED,
-      attributes: { 'sentry.sample_rate': 1, 'sentry.override_trace_sample_rate': true },
+      attributes: { 'sentry.sample_rate': 1 },
       traceState: new TraceState(),
     });
     expect(spyOnDroppedEvent).toHaveBeenCalledTimes(0);

diff --git a/packages/opentelemetry/test/trace.test.ts b/packages/opentelemetry/test/trace.test.ts
@@ -8,7 +8,6 @@ import { Span as SpanClass } from '@opentelemetry/sdk-trace-base';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   getClient,
@@ -224,7 +223,6 @@ describe('trace', () => {
           expect(span).toBeDefined();
           expect(getSpanAttributes(span)).toEqual({
             [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-            [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
           });
         },
       );
@@ -245,7 +243,6 @@ describe('trace', () => {
             [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.test.origin',
             [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'my-op',
             [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-            [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
           });
         },
       );
@@ -270,7 +267,6 @@ describe('trace', () => {
           expect(getSpanStartTime(span)).toEqual(date);
           expect(getSpanAttributes(span)).toEqual({
             [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-            [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
             test1: 'test 1',
             test2: 2,
           });
@@ -528,7 +524,6 @@ describe('trace', () => {
       expect(span).toBeDefined();
       expect(getSpanAttributes(span)).toEqual({
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
       });
 
       const span2 = startInactiveSpan({
@@ -543,7 +538,6 @@ describe('trace', () => {
       expect(span2).toBeDefined();
       expect(getSpanAttributes(span2)).toEqual({
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
         [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.test.origin',
         [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'my-op',
@@ -568,7 +562,6 @@ describe('trace', () => {
       expect(getSpanStartTime(span)).toEqual(date);
       expect(getSpanAttributes(span)).toEqual({
         [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-        [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
         test1: 'test 1',
         test2: 2,
       });
@@ -841,7 +834,6 @@ describe('trace', () => {
           expect(getSpanStartTime(span)).toEqual(date);
           expect(getSpanAttributes(span)).toEqual({
             [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
-            [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: true,
             test1: 'test 1',
             test2: 2,
           });