feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

Merged
lforst merged 4 commits into from
Feb 4, 2025
Merged

feat(core): Add inheritOrSampleWith helper to traceSampler#15277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79f490c
feat(core): Add `inheritOrSampleWith` helper to `traceSampler`
Feb 3, 2025
eb7bcc2
review feedback comments and explanations
Feb 4, 2025
03a2fd6
tests
Feb 4, 2025
59b68da
tests
Feb 4, 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
8 changes: 2 additions & 6 deletions ...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
transport: loggingTransport,
tracesSampler: ({ parentSampleRate }) => {
if (parentSampleRate) {
return parentSampleRate;
}

return 0.69;
tracesSampler: ({ inheritOrSampleWith }) => {
return inheritOrSampleWith(0.69);
},
});

Expand Down
26 changes: 25 additions & 1 deletion ...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
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 () => {
test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
const runner = createRunner(__dirname, 'server.js').start();
const response = await runner.makeRequest('get', '/check', {
headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
},
});

expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
});

test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
const runner = createRunner(__dirname, 'server.js').start();
const response = await runner.makeRequest('get', '/check', {
headers: {
'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
baggage: '',
},
});

expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
});

test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
});

Expand Down
19 changes: 18 additions & 1 deletion packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
// work; prefer the hook if so
let sampleRate;
if (typeof options.tracesSampler === 'function') {
sampleRate = options.tracesSampler(samplingContext);
sampleRate = options.tracesSampler({
...samplingContext,
inheritOrSampleWith: fallbackSampleRate => {
// If we have an incoming parent sample rate, we'll just use that one.
// The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
if (typeof samplingContext.parentSampleRate === 'number') {
return samplingContext.parentSampleRate;
}

// Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
// This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
if (typeof samplingContext.parentSampled === 'boolean') {
return Number(samplingContext.parentSampled);
}

return fallbackSampleRate;
},
});
localSampleRateWasApplied = true;
} else if (samplingContext.parentSampled !== undefined) {
sampleRate = samplingContext.parentSampled;
Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
* @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
* equivalent to returning 1 and returning `false` is equivalent to returning 0.
*/
tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

/**
* An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down
14 changes: 11 additions & 3 deletions packages/core/src/types-hoist/samplingcontext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
* Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
*
* Adds default data to data provided by the user.
* Auxiliary data for various sampling mechanisms in the Sentry SDK.
*/
export interface SamplingContext extends CustomSamplingContext {
/**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
/** Initial attributes that have been passed to the span being sampled. */
attributes?: SpanAttributes;
}

/**
* Auxiliary data passed to the `tracesSampler` function.
*/
export interface TracesSamplerSamplingContext extends SamplingContext {
/**
* Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
*/
inheritOrSampleWith: (fallbackSampleRate: number) => number;
}
1 change: 1 addition & 0 deletions packages/core/test/lib/tracing/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
test2: 'aa',
test3: 'bb',
},
inheritOrSampleWith: expect.any(Function),
});
});

Expand Down
4 changes: 4 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
parentSampled: undefined,
name: 'outer',
attributes: {},
inheritOrSampleWith: expect.any(Function),
});

// Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
attr2: 1,
'sentry.op': 'test.op',
},
inheritOrSampleWith: expect.any(Function),
});

// Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
parentSampled: undefined,
name: 'outer3',
attributes: {},
inheritOrSampleWith: expect.any(Function),
});
});

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
parentSampled: true,
name: 'outer',
attributes: {},
inheritOrSampleWith: expect.any(Function),
});
});

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(core): Add inheritOrSampleWith helper to traceSampler#15277

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

 Merged

lforst
merged 4 commits into

from

Feb 4, 2025
 Merged


feat(core): Add inheritOrSampleWith helper to traceSampler#15277
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
79f490c

feat(core): Add `inheritOrSampleWith` helper to `traceSampler`

Feb 3, 2025
eb7bcc2

review feedback comments and explanations

Feb 4, 2025
03a2fd6

tests

Feb 4, 2025
59b68da

tests

Feb 4, 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


8 changes: 2 additions & 6 deletions
...ges/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/server.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,12 +4,8 @@ const Sentry = require('@sentry/node');
Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 transport: loggingTransport,
 tracesSampler: ({ parentSampleRate }) => {
 if (parentSampleRate) {
 return parentSampleRate;
 }

 return 0.69;
 tracesSampler: ({ inheritOrSampleWith }) => {
 return inheritOrSampleWith(0.69);
 },
});

Expand Down

26 changes: 25 additions & 1 deletion
...kages/node-integration-tests/suites/tracing/sample-rate-propagation/tracesSampler/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 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 () => {
 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (1 -> because there is a positive sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
Expand All@@ -20,6 +20,30 @@ describe('parentSampleRate propagation with tracesSampler', () => {
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=1/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (0 -> because there is a negative sampling decision and inheritOrSampleWith was used)', async () => {
 const runner = createRunner(__dirname, 'server.js').start();
 const response = await runner.makeRequest('get', '/check', {
 headers: {
 'sentry-trace': '530699e319cc067ce440315d74acb312-414dc2a08d5d1dac-0',
 baggage: '',
 },
 });

 expect((response as any).propagatedData.baggage).toMatch(/sentry-sample_rate=0/);
 });

 test('should propagate sample_rate equivalent to sample rate returned by tracesSampler when there is no incoming sample rate (the fallback value -> because there is no sampling decision and inheritOrSampleWith was used)', 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/);
 });

Expand Down

19 changes: 18 additions & 1 deletion
packages/core/src/tracing/sampling.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,24 @@ export function sampleSpan(
 // work; prefer the hook if so
 let sampleRate;
 if (typeof options.tracesSampler === 'function') {
 sampleRate = options.tracesSampler(samplingContext);
 sampleRate = options.tracesSampler({
 ...samplingContext,
 inheritOrSampleWith: fallbackSampleRate => {
 // If we have an incoming parent sample rate, we'll just use that one.
 // The sampling decision will be inherited because of the sample_rand that was generated when the trace reached the incoming boundaries of the SDK.
 if (typeof samplingContext.parentSampleRate === 'number') {
 return samplingContext.parentSampleRate;
 }

 // Fallback if parent sample rate is not on the incoming trace (e.g. if there is no baggage)
 // This is to provide backwards compatibility if there are incoming traces from older SDKs that don't send a parent sample rate or a sample rand. In these cases we just want to force either a sampling decision on the downstream traces via the sample rate.
 if (typeof samplingContext.parentSampled === 'boolean') {
 return Number(samplingContext.parentSampled);
 }

 return fallbackSampleRate;
 },
 });
 localSampleRateWasApplied = true;
 } else if (samplingContext.parentSampled !== undefined) {
 sampleRate = samplingContext.parentSampled;
Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/types-hoist/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { CaptureContext } from '../scope';
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { TracesSamplerSamplingContext } from './samplingcontext';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
Expand DownExpand Up@@ -243,7 +243,7 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
 * @returns A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning `true` is
 * equivalent to returning 1 and returning `false` is equivalent to returning 0.
 */
 tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 tracesSampler?: (samplingContext: TracesSamplerSamplingContext) => number | boolean;

 /**
 * An event-processing callback for error and message events, guaranteed to be invoked after all other event
Expand Down

14 changes: 11 additions & 3 deletions
packages/core/src/types-hoist/samplingcontext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,9 +10,7 @@ export interface CustomSamplingContext {
}

/**
 * Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
 *
 * Adds default data to data provided by the user.
 * Auxiliary data for various sampling mechanisms in the Sentry SDK.
 */
export interface SamplingContext extends CustomSamplingContext {
 /**
Expand DownExpand Up@@ -42,3 +40,13 @@ export interface SamplingContext extends CustomSamplingContext {
 /** Initial attributes that have been passed to the span being sampled. */
 attributes?: SpanAttributes;
}

/**
 * Auxiliary data passed to the `tracesSampler` function.
 */
export interface TracesSamplerSamplingContext extends SamplingContext {
 /**
 * Returns a sample rate value that matches the sampling decision from the incoming trace, or falls back to the provided `fallbackSampleRate`.
 */
 inheritOrSampleWith: (fallbackSampleRate: number) => number;
}

1 change: 1 addition & 0 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -608,6 +608,7 @@ describe('startSpan', () => {
 test2: 'aa',
 test3: 'bb',
 },
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down

4 changes: 4 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1350,6 +1350,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `false`, it should not sample
Expand DownExpand Up@@ -1416,6 +1417,7 @@ describe('trace (sampling)', () => {
 attr2: 1,
 'sentry.op': 'test.op',
 },
 inheritOrSampleWith: expect.any(Function),
 });

 // Now return `0`, it should not sample
Expand DownExpand Up@@ -1457,6 +1459,7 @@ describe('trace (sampling)', () => {
 parentSampled: undefined,
 name: 'outer3',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand DownExpand Up@@ -1490,6 +1493,7 @@ describe('trace (sampling)', () => {
 parentSampled: true,
 name: 'outer',
 attributes: {},
 inheritOrSampleWith: expect.any(Function),
 });
 });

Expand Down