Skip to content

feat(browser): Add option to sample linked traces consistently #16037

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.

Sign up for GitHub

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
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

feat(browser): Add option to sample linked traces consistently #16037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb6c1c8
feat(browser): Add option to sample linked traces consistently
Lms24 Apr 11, 2025
05e5a43
add integration tests
Lms24 Apr 11, 2025
4b39b4a
Update packages/core/src/tracing/dynamicSamplingContext.ts
Lms24 Apr 11, 2025
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
17 changes: 17 additions & 0 deletions .../browserTracingIntegration/previous-trace-links/consistent-sampling-meta-negative/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://[email protected]/1337',
integrations: [
Sentry.browserTracingIntegration({
linkPreviousTrace: 'in-memory',
sampleLinkedTracesConsistently: true
}),
],
tracePropagationTargets: ['someurl.com'],
tracesSampleRate: 1,
debug: true,
sendClientReports: true
});
17 changes: 17 additions & 0 deletions ...owserTracingIntegration/previous-trace-links/consistent-sampling-meta-negative/subject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
const btn1 = document.getElementById('btn1');

const btn2 = document.getElementById('btn2');

btn1.addEventListener('click', () => {
Sentry.startNewTrace(() => {
Sentry.startSpan({name: 'custom root span 1', op: 'custom'}, () => {});
});
});

btn2.addEventListener('click', () => {
Sentry.startNewTrace(() => {
Sentry.startSpan({name: 'custom root span 2', op: 'custom'}, async () => {
await fetch('https://someUrl.com');
});
});
});
13 changes: 13 additions & 0 deletions ...erTracingIntegration/previous-trace-links/consistent-sampling-meta-negative/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-0" />
<meta
name="baggage"
content="sentry-trace_id=12345678901234567890123456789012,sentry-sample_rate=0.2,sentry-sampled=false,sentry-transaction=my-transaction,sentry-public_key=public,sentry-release=1.0.0,sentry-environment=prod,sentry-sample_rand=0.9"
/>
</head>
<button id="btn1">Custom Trace</button>
<button id="btn2">fetch request</button>
</html>
116 changes: 116 additions & 0 deletions .../browserTracingIntegration/previous-trace-links/consistent-sampling-meta-negative/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
import { expect } from '@playwright/test';
import type { ClientReport } from '@sentry/core';
import { extractTraceparentData, parseBaggageHeader } from '@sentry/core';

import { sentryTest } from '../../../../../utils/fixtures';
import {
envelopeRequestParser,
getMultipleSentryEnvelopeRequests,
shouldSkipTracingTest,
waitForClientReportRequest,
} from '../../../../../utils/helpers';

const metaTagSampleRand = 0.9;
const metaTagSampleRate = 0.2;
const metaTagTraceId = '12345678901234567890123456789012';

sentryTest.describe('When `sampleLinkedTracesConsistently` is `true` and page contains <meta> tags', () => {
sentryTest(
'Continues negative sampling decision from meta tag across all traces and downstream propagations',
async ({ getLocalTestUrl, page }) => {
if (shouldSkipTracingTest()) {
sentryTest.skip();
}

const url = await getLocalTestUrl({ testDir: __dirname });

let txnsReceived = 0;
// @ts-expect-error - no need to return something valid here
getMultipleSentryEnvelopeRequests<Event>(page, 1, { envelopeType: 'transaction' }, () => {
++txnsReceived;
return {};
});

const clientReportPromise = waitForClientReportRequest(page);

await sentryTest.step('Initial pageload', async () => {
await page.goto(url);
expect(txnsReceived).toEqual(0);
});

await sentryTest.step('Custom instrumented button click', async () => {
await page.locator('#btn1').click();
expect(txnsReceived).toEqual(0);
});

await sentryTest.step('Navigation', async () => {
await page.goto(`${url}#foo`);
expect(txnsReceived).toEqual(0);
});

await sentryTest.step('Make fetch request', async () => {
let sentryTrace = undefined;
let baggage = undefined;

await page.route('https://someUrl.com', (route, req) => {
baggage = req.headers()['baggage'];
sentryTrace = req.headers()['sentry-trace'];
return route.fulfill({ status: 200, body: 'ok' });
});

await page.locator('#btn2').click();

expect(sentryTrace).toBeDefined();
expect(baggage).toBeDefined();

expect(extractTraceparentData(sentryTrace)).toEqual({
traceId: expect.not.stringContaining(metaTagTraceId),
parentSpanId: expect.stringMatching(/^[0-9a-f]{16}$/),
parentSampled: false,
});

expect(parseBaggageHeader(baggage)).toEqual({
'sentry-environment': 'production',
'sentry-public_key': 'public',
'sentry-sample_rand': `${metaTagSampleRand}`,
'sentry-sample_rate': `${metaTagSampleRate}`,
'sentry-sampled': 'false',
'sentry-trace_id': expect.not.stringContaining(metaTagTraceId),
'sentry-transaction': 'custom root span 2',
});
});

await sentryTest.step('Client report', async () => {
await page.evaluate(() => {
Object.defineProperty(document, 'visibilityState', {
configurable: true,
get: function () {
return 'hidden';
},
});

// Dispatch the visibilitychange event to notify listeners
document.dispatchEvent(new Event('visibilitychange'));
});

const clientReport = envelopeRequestParser<ClientReport>(await clientReportPromise);
expect(clientReport).toEqual({
timestamp: expect.any(Number),
discarded_events: [
{
category: 'transaction',
quantity: 4,
reason: 'sample_rate',
},
],
});
});

await sentryTest.step('Wait for transactions to be discarded', async () => {
// give it a little longer just in case a txn is pending to be sent
await page.waitForTimeout(1000);
expect(txnsReceived).toEqual(0);
});
},
);
});
17 changes: 17 additions & 0 deletions ...s/tracing/browserTracingIntegration/previous-trace-links/consistent-sampling-meta/init.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;

Sentry.init({
dsn: 'https://[email protected]/1337',
integrations: [
Sentry.browserTracingIntegration({
linkPreviousTrace: 'in-memory',
sampleLinkedTracesConsistently: true
}),
],
tracePropagationTargets: ['someurl.com'],
// only take into account sampling from meta tag; otherwise sample negatively
tracesSampleRate: 0,
debug: true,
});
17 changes: 17 additions & 0 deletions ...racing/browserTracingIntegration/previous-trace-links/consistent-sampling-meta/subject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
const btn1 = document.getElementById('btn1');

const btn2 = document.getElementById('btn2');

btn1.addEventListener('click', () => {
Sentry.startNewTrace(() => {
Sentry.startSpan({name: 'custom root span 1', op: 'custom'}, () => {});
});
});

btn2.addEventListener('click', () => {
Sentry.startNewTrace(() => {
Sentry.startSpan({name: 'custom root span 2', op: 'custom'}, async () => {
await fetch('https://someUrl.com');
});
});
});
14 changes: 14 additions & 0 deletions ...ing/browserTracingIntegration/previous-trace-links/consistent-sampling-meta/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1" />
<meta name="baggage"
content="sentry-trace_id=12345678901234567890123456789012,sentry-sample_rate=0.2,sentry-sampled=true,sentry-transaction=my-transaction,sentry-public_key=public,sentry-release=1.0.0,sentry-environment=prod,sentry-sample_rand=0.051121"/>

</head>
<button id="btn1">
</button>
<button id="btn2">
</button>
</html>
Loading
Loading