feat(core): Add span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 \u003e 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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}
, '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 span.isRecording() instead of span.sampled#10034

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
mydea merged 4 commits into from
Jan 5, 2024
Merged

feat(core): Add span.isRecording() instead of span.sampled#10034

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
7d1e468
feat(core): Add `span.isRecording()` instead of `span.sampled`
mydea Jan 3, 2024
3490398
fix test
mydea Jan 3, 2024
b50642a
fix lint
mydea Jan 5, 2024
27a47bc
fix test
mydea Jan 5, 2024
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
1 change: 1 addition & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,6 +57,7 @@ In v8, the Span class is heavily reworked. The following properties & methods ar
* `span.setName(newName)`: Use `span.updateName(newName)` instead.
* `span.toTraceparent()`: use `spanToTraceHeader(span)` util instead.
* `span.getTraceContext()`: Use `spanToTraceContext(span)` utility function instead.
* `span.sampled`: Use `span.isRecording()` instead.

## Deprecate `pushScope` & `popScope` in favor of `withScope`

Expand Down
6 changes: 3 additions & 3 deletions packages/astro/test/server/meta.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { vi } from 'vitest';
import { getTracingMetaTags, isValidBaggageString } from '../../src/server/meta';

const mockedSpan = {
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: {
Expand DownExpand Up@@ -70,7 +70,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand All@@ -93,7 +93,7 @@ describe('getTracingMetaTags', () => {
const tags = getTracingMetaTags(
// @ts-expect-error - only passing a partial span object
{
sampled: true,
isRecording: () => true,
traceId: '12345678901234567890123456789012',
spanId: '1234567890123456',
transaction: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -515,7 +515,7 @@ export function shouldProfileTransaction(transaction: Transaction): boolean {
return false;
}

if (!transaction.sampled) {
if (!transaction.isRecording()) {
if (DEBUG_BUILD) {
logger.log('[Profiling] Discarding profile because transaction was not sampled.');
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/profiling/hubextensions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ describe('BrowserProfilingIntegration', () => {
// @ts-expect-error force api to be undefined
global.window.Profiler = undefined;
// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
const mockTransaction = { isRecording: () => true } as Transaction;
expect(() => onProfilingStartRouteTransaction(mockTransaction)).not.toThrow();
});
it('does not throw if constructor throws', () => {
Expand All@@ -80,8 +80,8 @@ describe('BrowserProfilingIntegration', () => {
}
}

// set sampled to true so that profiling does not early return
const mockTransaction = { sampled: true } as Transaction;
// set isRecording to true so that profiling does not early return
const mockTransaction = { isRecording: () => true } as Transaction;

// @ts-expect-error override with our own constructor
global.window.Profiler = Profiler;
Expand Down
2 changes: 1 addition & 1 deletion packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,7 +80,7 @@ describe('Bun Serve Integration', () => {
client.on('finishTransaction', transaction => {
expect(transaction.traceId).toBe(TRACE_ID);
expect(transaction.parentSpanId).toBe(PARENT_SPAN_ID);
expect(transaction.sampled).toBe(true);
expect(transaction.isRecording()).toBe(true);

expect(transaction.metadata?.dynamicSamplingContext).toStrictEqual({ version: '1.0', environment: 'production' });
});
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/tracing/hubextensions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ function _startTransaction(
The transaction will not be sampled. Please use the ${configInstrumenter} instrumentation to start transactions.`,
);

// eslint-disable-next-line deprecation/deprecation
transactionContext.sampled = false;
}

Expand All@@ -64,7 +65,7 @@ The transaction will not be sampled. Please use the ${configInstrumenter} instru
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand DownExpand Up@@ -94,7 +95,7 @@ export function startIdleTransaction(
transactionContext,
...customSamplingContext,
});
if (transaction.sampled) {
if (transaction.isRecording()) {
transaction.initSpanRecorder(options._experiments && (options._experiments.maxSpans as number));
}
if (client && client.emit) {
Expand Down
7 changes: 7 additions & 0 deletions packages/core/src/tracing/sampling.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,13 +21,16 @@ export function sampleTransaction<T extends Transaction>(
): T {
// nothing to do if tracing is not enabled
if (!hasTracingEnabled(options)) {
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// if the user has forced a sampling decision by passing a `sampled` value in their transaction context, go with that
// eslint-disable-next-line deprecation/deprecation
if (transaction.sampled !== undefined) {
transaction.setMetadata({
// eslint-disable-next-line deprecation/deprecation
sampleRate: Number(transaction.sampled),
});
return transaction;
Expand DownExpand Up@@ -60,6 +63,7 @@ export function sampleTransaction<T extends Transaction>(
// only valid values are booleans or numbers between 0 and 1.)
if (!isValidSampleRate(sampleRate)) {
DEBUG_BUILD && logger.warn('[Tracing] Discarding transaction because of invalid sample rate.');
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}
Expand All@@ -74,15 +78,18 @@ export function sampleTransaction<T extends Transaction>(
: 'a negative sampling decision was inherited or tracesSampleRate is set to 0'
}`,
);
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = false;
return transaction;
}

// Now we roll the dice. Math.random is inclusive of 0, but not of 1, so strict < is safe here. In case sampleRate is
// a boolean, the < comparison will cause it to be automatically cast to 1 if it's true and 0 if it's false.
// eslint-disable-next-line deprecation/deprecation
transaction.sampled = Math.random() < (sampleRate as number | boolean);

// if we're not going to keep it, we're done
// eslint-disable-next-line deprecation/deprecation
if (!transaction.sampled) {
DEBUG_BUILD &&
logger.log(
Expand Down
8 changes: 8 additions & 0 deletions packages/core/src/tracing/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,7 @@ export class Span implements SpanInterface {
}
// We want to include booleans as well here
if ('sampled' in spanContext) {
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
}
if (spanContext.op) {
Expand DownExpand Up@@ -193,6 +194,7 @@ export class Span implements SpanInterface {
const childSpan = new Span({
...spanContext,
parentSpanId: this.spanId,
// eslint-disable-next-line deprecation/deprecation
sampled: this.sampled,
traceId: this.traceId,
});
Expand DownExpand Up@@ -351,6 +353,7 @@ export class Span implements SpanInterface {
this.endTimestamp = spanContext.endTimestamp;
this.op = spanContext.op;
this.parentSpanId = spanContext.parentSpanId;
// eslint-disable-next-line deprecation/deprecation
this.sampled = spanContext.sampled;
this.spanId = spanContext.spanId || this.spanId;
this.startTimestamp = spanContext.startTimestamp || this.startTimestamp;
Expand DownExpand Up@@ -400,6 +403,11 @@ export class Span implements SpanInterface {
});
}

/** @inheritdoc */
public isRecording(): boolean {
return !this.endTimestamp && !!this.sampled;
}

/**
* Get the merged data for this span.
* For now, this combines `data` and `attributes` together,
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,7 +24,7 @@ export function spanToTraceContext(span: Span): TraceContext {
* Convert a Span to a Sentry trace header.
*/
export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(span.traceId, span.spanId, span.sampled);
return generateSentryTraceHeader(span.traceId, span.spanId, span.isRecording());
}

/**
Expand Down
17 changes: 17 additions & 0 deletions packages/core/test/lib/tracing/span.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -209,6 +209,23 @@ describe('span', () => {
});
});

describe('isRecording', () => {
it('returns true for sampled span', () => {
const span = new Span({ sampled: true });
expect(span.isRecording()).toEqual(true);
});

it('returns false for sampled, finished span', () => {
const span = new Span({ sampled: true, endTimestamp: Date.now() });
expect(span.isRecording()).toEqual(false);
});

it('returns false for unsampled span', () => {
const span = new Span({ sampled: false });
expect(span.isRecording()).toEqual(false);
});
});

// Ensure that attributes & data are merged together
describe('_getData', () => {
it('works without data & attributes', () => {
Expand Down
1 change: 1 addition & 0 deletions packages/tracing-internal/src/browser/browsertracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -333,6 +333,7 @@ export class BrowserTracing implements Integration {
this._latestRouteName = finalContext.name;
this._latestRouteSource = finalContext.metadata && finalContext.metadata.source;

// eslint-disable-next-line deprecation/deprecation
if (finalContext.sampled === false) {
DEBUG_BUILD && logger.log(`[Tracing] Will not send ${finalContext.op} transaction because of beforeNavigate.`);
}
Expand Down
8 changes: 8 additions & 0 deletions packages/types/src/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,8 @@ export interface SpanContext {

/**
* Was this span chosen to be sent as part of the sample?
*
* @deprecated Use `isRecording()` instead.
*/
sampled?: boolean;

Expand DownExpand Up@@ -268,4 +270,10 @@ export interface Span extends SpanContext {
trace_id: string;
origin?: SpanOrigin;
};

/**
* If this is span is actually recording data.
* This will return false if tracing is disabled, this span was not sampled or if the span is already finished.
*/
isRecording(): boolean;
}