Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import type { Span } from '../types/span';
import type { getTraceData } from '../utils/traceData';
import type {
continueTrace,
isTracingSuppressed,
startInactiveSpan,
startNewTrace,
startSpan,
Expand DownExpand Up@@ -86,6 +87,9 @@ export interface AsyncContextStrategy {
/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
suppressTracing?: typeof suppressTracing;

/** If tracing is suppressed in the given scope. */
isTracingSuppressed?: typeof isTracingSuppressed;

/** Get trace data as serialized string values for propagation via `sentry-trace` and `baggage`. */
getTraceData?: typeof getTraceData;

Expand Down
1 change: 1 addition & 0 deletions packages/core/src/tracing/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export {
continueTrace,
withActiveSpan,
suppressTracing,
isTracingSuppressed,
startNewTrace,
SUPPRESS_TRACING_KEY,
} from './trace';
Expand Down
29 changes: 18 additions & 11 deletions packages/core/src/tracing/trace.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -291,6 +291,17 @@ export function suppressTracing<T>(callback: () => T): T {
});
}

/** Check if tracing is suppressed. */
export function isTracingSuppressed(scope = getCurrentScope()): boolean {
const acs = getAcs();

if (acs.isTracingSuppressed) {
return acs.isTracingSuppressed(scope);
}

return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}

/**
* Starts a new trace for the duration of the provided callback. Spans started within the
* callback will be part of the new trace instead of a potentially previously started trace.
Expand DownExpand Up@@ -372,7 +383,7 @@ function createChildOrRootSpan({

const client = getClient();
if (_shouldIgnoreStreamedSpan(client, spanArguments)) {
if (!_isTracingSuppressed(scope)) {
if (!isTracingSuppressed(scope)) {
// if tracing is actively suppressed (Sentry.suppressTracing(...)),
// we don't want to record a client outcome for the ignored span
client?.recordDroppedEvent('ignored', 'span');
Expand DownExpand Up@@ -489,9 +500,9 @@ function _startRootSpan(
const finalAttributes = mutableSpanSamplingData.spanAttributes;

const currentPropagationContext = scope.getPropagationContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const _isTracingSuppressed = isTracingSuppressed(scope);

const [sampled, sampleRate, localSampleRateWasApplied] = isTracingSuppressed
const [sampled, sampleRate, localSampleRateWasApplied] = _isTracingSuppressed
? [false]
: sampleSpan(
options,
Expand All@@ -515,7 +526,7 @@ function _startRootSpan(
sampled,
});

if (!sampled && client && !isTracingSuppressed) {
if (!sampled && client && !_isTracingSuppressed) {
DEBUG_BUILD && debug.log('[Tracing] Discarding root span because its trace was not chosen to be sampled.');
client.recordDroppedEvent('sample_rate', hasSpanStreamingEnabled(client) ? 'span' : 'transaction');
}
Expand All@@ -540,8 +551,8 @@ function _startChildSpan(
isolationScope: Scope,
): Span {
const { spanId, traceId } = parentSpan.spanContext();
const isTracingSuppressed = _isTracingSuppressed(scope);
const sampled = isTracingSuppressed ? false : spanIsSampled(parentSpan);
const _isTracingSuppressed = isTracingSuppressed(scope);
const sampled = _isTracingSuppressed ? false : spanIsSampled(parentSpan);

const childSpan = sampled
? new SentrySpan({
Expand DownExpand Up@@ -569,7 +580,7 @@ function _startChildSpan(
// record a client outcome for the child.
childSpan.dropReason = parentSpan.dropReason;
client.recordDroppedEvent(parentSpan.dropReason, 'span');
} else if (!isTracingSuppressed) {
} else if (!_isTracingSuppressed) {
// Otherwise, the child is not sampled due to sampling of the parent span,
// hence we record a sample_rate client outcome for the child.
childSpan.dropReason = 'sample_rate';
Expand DownExpand Up@@ -642,7 +653,3 @@ function _shouldIgnoreStreamedSpan(client: Client | undefined, spanArguments: Se
function _isIgnoredSpan(span: Span): span is SentryNonRecordingSpan {
return spanIsNonRecordingSpan(span) && span.dropReason === 'ignored';
}

function _isTracingSuppressed(scope: Scope): boolean {
return scope.getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true;
}
56 changes: 56 additions & 0 deletions packages/core/test/lib/tracing/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,11 +19,13 @@ import { getAsyncContextStrategy } from '../../../src/asyncContext';
import {
continueTrace,
getDynamicSamplingContextFromSpan,
isTracingSuppressed,
registerSpanErrorInstrumentation,
SentrySpan,
startInactiveSpan,
startSpan,
startSpanManual,
SUPPRESS_TRACING_KEY,
suppressTracing,
withActiveSpan,
} from '../../../src/tracing';
Expand DownExpand Up@@ -2561,6 +2563,60 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
getCurrentScope().clear();
getIsolationScope().clear();
getGlobalScope().clear();

setAsyncContextStrategy(undefined);

const options = getDefaultTestClientOptions({ tracesSampleRate: 1 });
client = new TestClient(options);
setCurrentClient(client);
client.init();
});

afterEach(() => {
vi.clearAllMocks();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('only suppresses tracing within the active scope', () => {
withScope(() => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

// Outside of the suppressed scope, tracing is no longer suppressed
expect(isTracingSuppressed()).toBe(false);
});

it('respects a scope passed in explicitly', () => {
const scope = getCurrentScope().clone();
scope.setSDKProcessingMetadata({ [SUPPRESS_TRACING_KEY]: true });

expect(isTracingSuppressed(scope)).toBe(true);
expect(isTracingSuppressed()).toBe(false);
});
});

describe('startNewTrace', () => {
beforeEach(() => {
getCurrentScope().clear();
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import { subscribe } from 'node:diagnostics_channel';
import { context, trace } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
Expand All@@ -11,7 +10,13 @@ import type {
HttpModuleExport,
Span,
} from '@sentry/core';
import { getHttpClientSubscriptions, patchHttpModuleClient, SDK_VERSION, getRequestOptions } from '@sentry/core';
import {
getHttpClientSubscriptions,
patchHttpModuleClient,
SDK_VERSION,
getRequestOptions,
isTracingSuppressed,
} from '@sentry/core';
import { INSTRUMENTATION_NAME } from './constants';
import { HTTP_ON_CLIENT_REQUEST } from '@sentry/core';
import { NODE_VERSION } from '../../nodeVersion';
Expand DownExpand Up@@ -172,8 +177,7 @@ export class SentryHttpInstrumentation extends InstrumentationBase<SentryHttpIns
spans: options.createSpansForOutgoingRequests && (options.spans ?? true),
ignoreOutgoingRequests(url, request) {
return (
isTracingSuppressed(context.active()) ||
!!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
isTracingSuppressed() || !!options.ignoreOutgoingRequests?.(url, getRequestOptions(request as ClientRequest))
);
},
outgoingRequestHook(span, request) {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { errorMonitor } from 'node:events';
import type { IncomingHttpHeaders } from 'node:http';
import { context, SpanKind, trace } from '@opentelemetry/api';
import type { RPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, isTracingSuppressed, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import {
HTTP_RESPONSE_STATUS_CODE,
HTTP_ROUTE,
Expand DownExpand Up@@ -32,6 +32,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
stripUrlQueryAndFragment,
isTracingSuppressed,
} from '@sentry/core';
import { DEBUG_BUILD } from '../../debug-build';
import type { NodeClient } from '../../sdk/client';
Expand DownExpand Up@@ -306,7 +307,7 @@ function shouldIgnoreSpansForIncomingRequest(
ignoreIncomingRequests?: (urlPath: string, request: HttpIncomingMessage) => boolean;
},
): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
import { context } from '@opentelemetry/api';
import { isTracingSuppressed } from '@opentelemetry/core';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase } from '@opentelemetry/instrumentation';
import { LRUMap, SDK_VERSION } from '@sentry/core';
import { LRUMap, SDK_VERSION, isTracingSuppressed } from '@sentry/core';
import * as diagch from 'diagnostics_channel';
import { NODE_MAJOR, NODE_MINOR } from '../../nodeVersion';
import {
Expand DownExpand Up@@ -184,7 +182,7 @@ export class SentryNodeFetchInstrumentation extends InstrumentationBase<SentryNo
* Check if the given outgoing request should be ignored.
*/
private _shouldIgnoreOutgoingRequest(request: UndiciRequest): boolean {
if (isTracingSuppressed(context.active())) {
if (isTracingSuppressed()) {
return true;
}

Expand Down
3 changes: 2 additions & 1 deletion packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ import type { CurrentScopes } from './types';
import { getContextFromScope, getScopesFromContext } from './utils/contextData';
import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';
import { suppressTracing, isTracingSuppressed } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
Expand DownExpand Up@@ -110,6 +110,7 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
startInactiveSpan,
getActiveSpan,
suppressTracing,
isTracingSuppressed,
getTraceData,
continueTrace,
startNewTrace,
Expand Down
12 changes: 11 additions & 1 deletion packages/opentelemetry/src/utils/suppressTracing.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
import { context } from '@opentelemetry/api';
import { suppressTracing as suppressTracingImpl } from '@opentelemetry/core';
import {
suppressTracing as suppressTracingImpl,
isTracingSuppressed as isTracingSuppressedImpl,
} from '@opentelemetry/core';
import type { Scope } from '@sentry/core';
import { getContextFromScope } from './contextData';

/** Suppress tracing in the given callback, ensuring no spans are generated inside of it. */
export function suppressTracing<T>(callback: () => T): T {
const ctx = suppressTracingImpl(context.active());
return context.with(ctx, callback);
}

export function isTracingSuppressed(scope?: Scope): boolean {
const ctx = scope ? getContextFromScope(scope) : context.active();
return ctx ? isTracingSuppressedImpl(ctx) : false;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing active context fallback

Medium Severity

The OpenTelemetry isTracingSuppressed helper returns false when getContextFromScope(scope) is missing, instead of falling back to context.active(). Node HTTP/fetch instrumentation now uses this path rather than checking the active OTel context directly, so suppression can be missed and outgoing spans or trace headers may still be created.

Additional Locations (2)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit 620084c. Configure here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this is the safer approach, if that is missing.

Comment thread
sentry[bot] marked this conversation as resolved.
}
37 changes: 37 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
getRootSpan,
isTracingSuppressed,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE,
Expand DownExpand Up@@ -2107,6 +2108,42 @@ describe('suppressTracing', () => {
});
});

describe('isTracingSuppressed', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
});

afterEach(async () => {
await cleanupOtel();
});

it('returns false when tracing is not suppressed', () => {
expect(isTracingSuppressed()).toBe(false);
});

it('returns true while inside suppressTracing', () => {
const suppressed = suppressTracing(() => isTracingSuppressed());
expect(suppressed).toBe(true);
});

it('returns false again after suppressTracing has finished', () => {
suppressTracing(() => {
expect(isTracingSuppressed()).toBe(true);
});

expect(isTracingSuppressed()).toBe(false);
});

it('stays suppressed across async boundaries within suppressTracing', async () => {
const suppressed = await suppressTracing(async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return isTracingSuppressed();
});

expect(suppressed).toBe(true);
});
});

describe('span.end() timestamp conversion', () => {
beforeEach(() => {
mockSdkInit({ tracesSampleRate: 1 });
Expand Down
Loading