feat: Pass parentSampleRate to tracesSampler

dev-packages/node-integration-tests/suites/sample-rand-propagation/test.ts → dev-packages/node-integration-tests/suites/tracing/sample-rand-propagation/test.ts

@@ -1,4 +1,4 @@
-import { cleanupChildProcesses, createRunner } from '../../utils/runner';
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
 
 describe('sample_rand propagation', () => {
   afterAll(() => {

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/no-tracing-enabled/server.js

@@ -0,0 +1,39 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+});
+
+// express must be required after Sentry is initialized
+const express = require('express');
+const cors = require('cors');
+const {
+  startExpressServerAndSendPortToRunner,
+  getPortAppIsRunningOn,
+} = require('@sentry-internal/node-integration-tests');
+
+const app = express();
+
+app.use(cors());
+
+app.get('/check', (req, res) => {
+  const appPort = getPortAppIsRunningOn(app);
+  // eslint-disable-next-line no-undef
+  fetch(`http://localhost:${appPort}/bounce`)
+    .then(r => r.json())
+    .then(bounceRes => {
+      res.json({ propagatedData: bounceRes });
+    });
+});
+
+app.get('/bounce', (req, res) => {
+  res.json({
+    baggage: req.headers['baggage'],
+  });
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+startExpressServerAndSendPortToRunner(app);

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/no-tracing-enabled/test.ts

@@ -0,0 +1,25 @@
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
+
+describe('parentSampleRate propagation with no tracing enabled', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('should propagate an incoming sample rate', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-1',
+        baggage: 'sentry-sample_rate=0.1337',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.1337/);
+  });
+
+  test('should not propagate a sample rate for root traces', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check');
+    expect((response as any).propagatedData.baggage).not.toMatch(/sentry-sample_rate/);
+  });
+});

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampleRate/server.js

@@ -0,0 +1,40 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+  tracesSampleRate: 0.69,
+});
+
+// express must be required after Sentry is initialized
+const express = require('express');
+const cors = require('cors');
+const {
+  startExpressServerAndSendPortToRunner,
+  getPortAppIsRunningOn,
+} = require('@sentry-internal/node-integration-tests');
+
+const app = express();
+
+app.use(cors());
+
+app.get('/check', (req, res) => {
+  const appPort = getPortAppIsRunningOn(app);
+  // eslint-disable-next-line no-undef
+  fetch(`http://localhost:${appPort}/bounce`)
+    .then(r => r.json())
+    .then(bounceRes => {
+      res.json({ propagatedData: bounceRes });
+    });
+});
+
+app.get('/bounce', (req, res) => {
+  res.json({
+    baggage: req.headers['baggage'],
+  });
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+startExpressServerAndSendPortToRunner(app);

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampleRate/test.ts

@@ -0,0 +1,61 @@
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
+
+describe('parentSampleRate propagation with tracesSampleRate', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('should propagate incoming sample rate when inheriting a positive sampling decision', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-1',
+        baggage: 'sentry-sample_rate=0.1337',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.1337/);
+  });
+
+  test('should propagate incoming sample rate when inheriting a negative sampling decision', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
+        baggage: 'sentry-sample_rate=0.1337',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.1337/);
+  });
+
+  test('should propagate configured sample rate when receiving a trace without sampling decision and sample rate', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac',
+        baggage: '',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.69/);
+  });
+
+  test('should propagate configured sample rate when receiving a trace without sampling decision, but with sample rate', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac',
+        baggage: 'sentry-sample_rate=0.1337',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.69/);
+  });
+
+  test('should propagate configured sample rate when there is no incoming trace', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check');
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.69/);
+  });
+});

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

@@ -0,0 +1,46 @@
+const { loggingTransport } = require('@sentry-internal/node-integration-tests');
+const Sentry = require('@sentry/node');
+
+Sentry.init({
+  dsn: 'https://[email protected]/1337',
+  transport: loggingTransport,
+  tracesSampler: ({ parentSampleRate }) => {
+    if (parentSampleRate) {
+      return parentSampleRate;
+    }
+
+    return 0.69;
+  },
+});
+
+// express must be required after Sentry is initialized
+const express = require('express');
+const cors = require('cors');
+const {
+  startExpressServerAndSendPortToRunner,
+  getPortAppIsRunningOn,
+} = require('@sentry-internal/node-integration-tests');
+
+const app = express();
+
+app.use(cors());
+
+app.get('/check', (req, res) => {
+  const appPort = getPortAppIsRunningOn(app);
+  // eslint-disable-next-line no-undef
+  fetch(`http://localhost:${appPort}/bounce`)
+    .then(r => r.json())
+    .then(bounceRes => {
+      res.json({ propagatedData: bounceRes });
+    });
+});
+
+app.get('/bounce', (req, res) => {
+  res.json({
+    baggage: req.headers['baggage'],
+  });
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+startExpressServerAndSendPortToRunner(app);

dev-packages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

@@ -0,0 +1,37 @@
+import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
+
+describe('parentSampleRate propagation with tracesSampler', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming trace', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check');
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.69/);
+  });
+
+  test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-1',
+        baggage: '',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.69/);
+  });
+
+  test('should propagate sample_rate equivalent to incoming sample_rate (because tracesSampler is configured that way)', async () => {
+    const runner = createRunner(__dirname, 'server.js').start();
+    const response = await runner.makeRequest('get', '/check', {
+      headers: {
+        'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-1',
+        baggage: 'sentry-sample_rate=0.1337',
+      },
+    });
+
+    expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0\.1337/);
+  });
+});

packages/browser/test/tracing/browserTracingIntegration.test.ts

@@ -18,6 +18,7 @@ global.window.TextDecoder = TextDecoder;
 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,
@@ -103,6 +104,7 @@ describe('browserTracingIntegration', () => {
         [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]: 1,
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
       },
       span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -174,6 +176,7 @@ describe('browserTracingIntegration', () => {
         [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]: 1,
         [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
       },
       span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -288,6 +291,7 @@ describe('browserTracingIntegration', () => {
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
           [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'manual',
           [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
+          [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: 1,
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
         },
         span_id: expect.stringMatching(/[a-f0-9]{16}/),
@@ -323,6 +327,7 @@ describe('browserTracingIntegration', () => {
         data: {
           [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'pageload',
           [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.test',
+          [SEMANTIC_ATTRIBUTE_SENTRY_OVERRIDE_TRACE_SAMPLE_RATE]: 1,
           [SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE]: 1,
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
           testy: 'yes',

packages/core/src/envelope.ts

@@ -1,4 +1,5 @@
 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 {
@@ -141,6 +142,11 @@ 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));
     }

packages/core/src/semanticAttributes.ts

@@ -12,6 +12,11 @@ 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.
  */