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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
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
36 changes: 1 addition & 35 deletions packages/core/src/asyncContext/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
import type { Carrier } from './../carrier';
import { getMainCarrier, getSentryCarrier } from './../carrier';
import type { Scope } from './../scope';
import { _setSpanForScope } from './../utils/spanOnScope';
import { getStackAsyncContextStrategy } from './stackStrategy';
import type { AsyncContextStrategy, TracingChannelBinding } from './types';
import type { AsyncContextStrategy } from './types';

/**
* @private Private API with no semver guarantees!
Expand DownExpand Up@@ -31,35 +29,3 @@ export function getAsyncContextStrategy(carrier: Carrier): AsyncContextStrategy
// Otherwise, use the default one (stack)
return getStackAsyncContextStrategy();
}

/**
* Get the runtime binding needed to connect tracing channels to async context.
*/
export function getTracingChannelBinding(): TracingChannelBinding | undefined {
return getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: unknown,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
59 changes: 59 additions & 0 deletions packages/core/src/asyncContext/tracing-channel-binding.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
import { getMainCarrier } from '../carrier';
import type { Scope } from '../scope';
import { _setSpanForScope } from '../utils/spanOnScope';
import { safeUnref } from '../utils/timer';
import { getAsyncContextStrategy } from './index';
import type { TracingChannelBinding } from './types';

/**
* Execute a callback whenever the tracing channel binding is available.
* If it is not available after retry, the callback is not executed.
*/
export function waitForTracingChannelBinding(callback: () => void, retries = 1): void {
const binding = getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.();

if (binding) {
callback();
return;
}

if (!retries) {
return;
}

// It is possible that the binding is not available yet when this is initially called
// This happens when users use a custom OTEL setup
// In this case, we wait for a tick and try again afterwards
// If it still fails, we bail and do nothing
// `safeUnref` so this retry timer never keeps the process alive on its own (Node server runtimes).
safeUnref(
setTimeout(() => {
waitForTracingChannelBinding(callback, retries - 1);
}, 1),
);
}

/**
* Build the default {@link TracingChannelBinding} shared by AsyncLocalStorage-based strategies.
*
* The ALS instance is supplied by the caller (kept as `unknown`).
* The binding clones the current scope, plants the span on it, and reuses the existing isolation scope.
*
* The OpenTelemetry strategy does not use this: its store value is an OTel context, not a
* `{ scope, isolationScope }` pair.
*/
export function _INTERNAL_createTracingChannelBinding(
asyncLocalStorage: NonNullable<unknown>,
getScopes: () => { scope: Scope; isolationScope: Scope },
): TracingChannelBinding {
return {
asyncLocalStorage,
getStoreWithActiveSpan: span => {
const { scope, isolationScope } = getScopes();
const activeScope = scope.clone();
_setSpanForScope(activeScope, span);

return { scope: activeScope, isolationScope };
},
};
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,7 +21,7 @@ export interface TracingChannelBinding {
/**
* The ALS instance that will be bound to the channel.
*/
asyncLocalStorage: unknown;
asyncLocalStorage: NonNullable<unknown>;

/**
* Activates a span for the tracing channels nested invocations, the return value must be the same type as the `asyncLocalStorage` inner value.
Expand Down
6 changes: 3 additions & 3 deletions packages/core/src/shared-exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,11 @@ export {
hasExternalPropagationContext,
} from './currentScopes';
export { getDefaultCurrentScope, getDefaultIsolationScope } from './defaultScopes';
export { setAsyncContextStrategy, getAsyncContextStrategy } from './asyncContext';
export {
setAsyncContextStrategy,
getTracingChannelBinding as _INTERNAL_getTracingChannelBinding,
waitForTracingChannelBinding,
_INTERNAL_createTracingChannelBinding,
} from './asyncContext';
} from './asyncContext/tracing-channel-binding';
export { getGlobalSingleton, getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
export { Scope } from './scope';
Expand Down
123 changes: 123 additions & 0 deletions packages/core/test/lib/asyncContext/tracing-channel-binding.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { getAsyncContextStrategy, setAsyncContextStrategy } from '../../../src/asyncContext';
import { waitForTracingChannelBinding } from '../../../src/asyncContext/tracing-channel-binding';
import type { TracingChannelBinding } from '../../../src/asyncContext/types';
import { getMainCarrier } from '../../../src/carrier';

const FAKE_BINDING: TracingChannelBinding = {
asyncLocalStorage: {},
getStoreWithActiveSpan: () => ({}),
};

/** Install an async context strategy whose `getTracingChannelBinding` is driven by `provider`. */
function setBindingProvider(provider: (() => TracingChannelBinding | undefined) | undefined): void {
setAsyncContextStrategy({
...getAsyncContextStrategy(getMainCarrier()),
getTracingChannelBinding: provider,
});
}

describe('waitForTracingChannelBinding', () => {
beforeEach(() => {
vi.useFakeTimers();
setAsyncContextStrategy(undefined);
});

afterEach(() => {
setAsyncContextStrategy(undefined);
vi.useRealTimers();
});

it('runs the callback synchronously when the binding is already available', () => {
const getBinding = vi.fn(() => FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).toHaveBeenCalledTimes(1);
// Resolved on the first attempt, so no retry should be scheduled.
expect(getBinding).toHaveBeenCalledTimes(1);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).toHaveBeenCalledTimes(1);
});

it('retries on the next tick and runs the callback once the binding becomes available', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

// Not available on the first (synchronous) attempt.
expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);

expect(callback).toHaveBeenCalledTimes(1);
});

it('does not run the callback if the binding never becomes available (default single retry)', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback);

expect(callback).not.toHaveBeenCalled();

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled();

// The single retry is exhausted — no further attempts are scheduled.
expect(getBinding).toHaveBeenCalledTimes(2);
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(2);
expect(callback).not.toHaveBeenCalled();
});

it('does not retry when retries is 0', () => {
const getBinding = vi.fn(() => undefined);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
expect(getBinding).toHaveBeenCalledTimes(1);

// No retry is scheduled when no retries remain.
vi.runAllTimers();
expect(getBinding).toHaveBeenCalledTimes(1);
expect(callback).not.toHaveBeenCalled();
});

it('honors a custom retry count', () => {
const getBinding = vi.fn<[], TracingChannelBinding | undefined>(() => FAKE_BINDING);
getBinding.mockReturnValueOnce(undefined).mockReturnValueOnce(undefined).mockReturnValue(FAKE_BINDING);
setBindingProvider(getBinding);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 2);

expect(callback).not.toHaveBeenCalled(); // attempt 1 (sync): undefined

vi.advanceTimersByTime(1);
expect(callback).not.toHaveBeenCalled(); // attempt 2: undefined

vi.advanceTimersByTime(1);
expect(callback).toHaveBeenCalledTimes(1); // attempt 3: available
});

it('does nothing when the strategy exposes no `getTracingChannelBinding`', () => {
// The default (stack) strategy has no tracing-channel binding support.
setAsyncContextStrategy(undefined);

const callback = vi.fn();
waitForTracingChannelBinding(callback, 0);

expect(callback).not.toHaveBeenCalled();
});
});
2 changes: 1 addition & 1 deletion packages/node-core/src/sdk/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function _init(
initializeEsmLoader();
}

setOpenTelemetryContextAsyncContextStrategy();
setOpenTelemetryContextAsyncContextStrategy(options);

const scope = getCurrentScope();
scope.update(options.initialScope);
Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/redis/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
spanToJSON,
truncate,
waitForTracingChannelBinding,
} from '@sentry/core';
import * as dc from 'node:diagnostics_channel';
import { subscribeRedisDiagnosticChannels, type RedisTracingChannelFactory } from '@sentry/server-utils';
Expand DownExpand Up@@ -128,9 +129,9 @@ export const instrumentRedis = Object.assign(
// so defer to the next tick.
// Check this here to ensure this does not fail at runtime for Node <= 18.18.0
if (dc.tracingChannel) {
void Promise.resolve().then(() =>
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook),
);
waitForTracingChannelBinding(() => {
subscribeRedisDiagnosticChannels(dc.tracingChannel as RedisTracingChannelFactory, cacheResponseHook);
});
}

// todo: implement them gradually
Expand Down
28 changes: 5 additions & 23 deletions packages/opentelemetry/src/asyncContextStrategy.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as api from '@opentelemetry/api';
import type { Scope, Span, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import type { Scope, TracingChannelBinding, withActiveSpan as defaultWithActiveSpan } from '@sentry/core';
import { getDefaultCurrentScope, getDefaultIsolationScope, setAsyncContextStrategy } from '@sentry/core';
import {
SENTRY_FORK_ISOLATION_SCOPE_CONTEXT_KEY,
Expand All@@ -13,19 +13,13 @@ import { getActiveSpan } from './utils/getActiveSpan';
import { getTraceData } from './utils/getTraceData';
import { suppressTracing } from './utils/suppressTracing';

interface ContextApi {
_getContextManager(): {
getAsyncLocalStorageLookup(): {
asyncLocalStorage: unknown;
};
};
}

/**
* Sets the async context strategy to use follow the OTEL context under the hood.
* We handle forking a hub inside of our custom OTEL Context Manager (./otelContextManager.ts)
*/
export function setOpenTelemetryContextAsyncContextStrategy(): void {
export function setOpenTelemetryContextAsyncContextStrategy(options?: {
getTracingChannelBinding?: () => TracingChannelBinding | undefined;
}): void {
function getScopes(): CurrentScopes {
const ctx = api.context.active();
const scopes = getScopesFromContext(ctx);
Expand DownExpand Up@@ -116,18 +110,6 @@ export function setOpenTelemetryContextAsyncContextStrategy(): void {
// The types here don't fully align, because our own `Span` type is narrower
// than the OTEL one - but this is OK for here, as we now we'll only have OTEL spans passed around
withActiveSpan: withActiveSpan as typeof defaultWithActiveSpan,
getTracingChannelBinding: () => {
try {
const contextManager = (api.context as unknown as ContextApi)._getContextManager();
const lookup = contextManager.getAsyncLocalStorageLookup();

return {
asyncLocalStorage: lookup.asyncLocalStorage,
getStoreWithActiveSpan: (span: Span) => api.trace.setSpan(api.context.active(), span as api.Span),
};
} catch {
return undefined;
}
},
getTracingChannelBinding: options?.getTracingChannelBinding,
});
}
10 changes: 8 additions & 2 deletions packages/opentelemetry/src/asyncLocalStorageContextManager.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,10 +25,11 @@ import type { Context, ContextManager } from '@opentelemetry/api';
import { ROOT_CONTEXT } from '@opentelemetry/api';
import { AsyncLocalStorage } from 'node:async_hooks';
import { EventEmitter } from 'node:events';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import type { AsyncLocalStorageLookup } from './contextManager';
import { SENTRY_SCOPES_CONTEXT_KEY } from './constants';
import { buildContextWithSentryScopes } from './utils/buildContextWithSentryScopes';
import { setIsSetup } from './utils/setupCheck';
import { getAsyncContextStrategy, getMainCarrier } from '@sentry/core';

type ListenerFn = (...args: unknown[]) => unknown;

Expand All@@ -44,13 +45,18 @@ const ADD_LISTENER_METHODS = ['addListener', 'on', 'once', 'prependListener', 'p
* Semantics match `@opentelemetry/context-async-hooks` (function `bind` + `EventEmitter` patching).
*/
export class SentryAsyncLocalStorageContextManager implements ContextManager {
protected readonly _asyncLocalStorage = new AsyncLocalStorage<Context>();
protected readonly _asyncLocalStorage: AsyncLocalStorage<Context>;

private readonly _kOtListeners = Symbol('OtListeners');
private _wrapped = false;

public constructor() {
setIsSetup('SentryContextManager');
// Pick the instance from the async context strategy
// this should normally always be there, but if it is not for whatever reason, we fall back to a new instance
this._asyncLocalStorage =
(getAsyncContextStrategy(getMainCarrier()).getTracingChannelBinding?.()
?.asyncLocalStorage as AsyncLocalStorage<Context>) ?? new AsyncLocalStorage<Context>();
}

public active(): Context {
Expand Down
1 change: 0 additions & 1 deletion packages/opentelemetry/src/exports.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,6 @@ export { suppressTracing } from './utils/suppressTracing';

export { setupEventContextTrace } from './setupEventContextTrace';

export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';
// eslint-disable-next-line typescript/no-deprecated
export { wrapContextManagerClass } from './contextManager';

Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.browser.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,9 @@ export class SentryAsyncLocalStorageContextManager {
}
}

// This is the generic, non-node specific async context strategy
export { setOpenTelemetryContextAsyncContextStrategy } from './asyncContextStrategy';

export type AsyncLocalStorageLookup = {
asyncLocalStorage: unknown;
contextSymbol: symbol;
Expand Down
3 changes: 3 additions & 0 deletions packages/opentelemetry/src/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,3 +3,6 @@ export * from './exports';
// Node-specific exports
export { SentryAsyncLocalStorageContextManager } from './asyncLocalStorageContextManager';
export type { AsyncLocalStorageLookup } from './contextManager';

// We export the node-specific variant here that uses async local storage
export { setNodeOpenTelemetryContextAsyncContextStrategy as setOpenTelemetryContextAsyncContextStrategy } from './nodeAsyncContextStrategy';
Comment thread
cursor[bot] marked this conversation as resolved.
Loading
Loading