feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 2 commits into from
Nov 27, 2024
Merged

feat(core): Deprecate spanId on propagationContext #14482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba1dfe0
feat(core): Deprecate `spanId` on propagationContext
mydea Nov 26, 2024
7965df1
fix linting
mydea Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/migration/draft-v9-migration-guide.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down
6 changes: 3 additions & 3 deletions packages/browser/src/tracing/browserTracingIntegration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
TRACING_DEFAULTS,
generateTraceId,
getActiveSpan,
getClient,
getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
GLOBAL_OBJ,
browserPerformanceTimeOrigin,
generatePropagationContext,
getDomElement,
logger,
propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
* This will only do something if a browser tracing integration has been setup.
*/
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
getIsolationScope().setPropagationContext(generatePropagationContext());
getCurrentScope().setPropagationContext(generatePropagationContext());
getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

client.emit('startNavigationSpan', spanOptions);

Expand Down
2 changes: 2 additions & 0 deletions packages/browser/test/tracing/browserTracingIntegration.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

const propCtxAfterEnd = getCurrentScope().getPropagationContext();
expect(propCtxAfterEnd).toStrictEqual({
// eslint-disable-next-line deprecation/deprecation
spanId: propCtxBeforeEnd.spanId,
traceId: propCtxBeforeEnd.traceId,
sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

const propCtxAfterEnd = getCurrentScope().getPropagationContext();
expect(propCtxAfterEnd).toStrictEqual({
// eslint-disable-next-line deprecation/deprecation
spanId: propCtxBeforeEnd.spanId,
traceId: propCtxBeforeEnd.traceId,
sampled: false,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/currentScopes.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
const propagationContext = scope.getPropagationContext();

// TODO(v9): Use generateSpanId() instead of spanId
// eslint-disable-next-line deprecation/deprecation
const { traceId, spanId, parentSpanId } = propagationContext;

const traceContext: TraceContext = dropUndefinedKeys({
Expand Down
19 changes: 14 additions & 5 deletions packages/core/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
this._extra = {};
this._contexts = {};
this._sdkProcessingMetadata = {};
this._propagationContext = generatePropagationContext();
this._propagationContext = {
traceId: generateTraceId(),
spanId: generateSpanId(),
};
}

/**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
this._session = undefined;
_setSpanForScope(this, undefined);
this._attachments = [];
this._propagationContext = generatePropagationContext();
this.setPropagationContext({ traceId: generateTraceId() });

this._notifyScopeListeners();
return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
/**
* @inheritDoc
*/
public setPropagationContext(context: PropagationContext): this {
this._propagationContext = context;
public setPropagationContext(
context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
): this {
this._propagationContext = {
// eslint-disable-next-line deprecation/deprecation
spanId: generateSpanId(),
...context,
};
return this;
}

Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/tracing/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
*/
export function startNewTrace<T>(callback: () => T): T {
return withScope(scope => {
scope.setPropagationContext(generatePropagationContext());
scope.setPropagationContext({ traceId: generateTraceId() });
DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
return withActiveSpan(null, callback);
});
Expand Down
7 changes: 6 additions & 1 deletion packages/core/src/utils-hoist/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
// eslint-disable-next-line deprecation/deprecation
generatePropagationContext,
generateTraceId,
generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down
22 changes: 19 additions & 3 deletions packages/core/src/utils-hoist/propagationContext.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
* Returns a new minimal propagation context
* Returns a new minimal propagation context.
*
* @deprecated Use `generateTraceId` and `generateSpanId` instead.
*/
export function generatePropagationContext(): PropagationContext {
return {
traceId: uuid4(),
spanId: uuid4().substring(16),
traceId: generateTraceId(),
spanId: generateSpanId(),
};
}

/**
* Generate a random, valid trace ID.
*/
export function generateTraceId(): string {
return uuid4();
}

/**
* Generate a random, valid span ID.
*/
export function generateSpanId(): string {
return uuid4().substring(16);
}
6 changes: 3 additions & 3 deletions packages/core/src/utils-hoist/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

if (!traceparentData || !traceparentData.traceId) {
return generatePropagationContext();
return { traceId: generateTraceId(), spanId: generateSpanId() };
}

const { traceId, parentSpanId, parentSampled } = traceparentData;

const virtualSpanId = uuid4().substring(16);
const virtualSpanId = generateSpanId();

return {
traceId,
Expand Down
2 changes: 2 additions & 0 deletions packages/core/src/utils/traceData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
* Get a sentry-trace header value for the given scope.
*/
function scopeToTraceHeader(scope: Scope): string {
// TODO(v9): Use generateSpanId() instead of spanId
// eslint-disable-next-line deprecation/deprecation
const { traceId, sampled, spanId } = scope.getPropagationContext();
return generateSentryTraceHeader(traceId, spanId, sampled);
}
1 change: 1 addition & 0 deletions packages/core/test/utils-hoist/proagationContext.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
it('generates a new minimal propagation context', () => {
// eslint-disable-next-line deprecation/deprecation
expect(generatePropagationContext()).toEqual({
traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down
2 changes: 2 additions & 0 deletions packages/node/src/integrations/anr/worker.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
applyScopeDataToEvent(event, scope);

if (!event.contexts?.trace) {
// TODO(v9): Use generateSpanId() instead of spanId
// eslint-disable-next-line deprecation/deprecation
const { traceId, spanId, parentSpanId } = scope.propagationContext;
event.contexts = {
trace: {
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry/src/propagator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
return {
dynamicSamplingContext,
traceId: propagationContext.traceId,
// TODO(v9): Use generateSpanId() instead
// eslint-disable-next-line deprecation/deprecation
spanId: propagationContext.spanId,
sampled: propagationContext.sampled,
};
Expand Down
1 change: 1 addition & 0 deletions packages/opentelemetry/src/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

const spanOptions: SpanContext = {
traceId: propagationContext.traceId,
// eslint-disable-next-line deprecation/deprecation
spanId: propagationContext.parentSpanId || propagationContext.spanId,
isRemote: true,
traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down
4 changes: 3 additions & 1 deletion packages/types/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
/**
* Add propagation context to the scope, used for distributed tracing
*/
setPropagationContext(context: PropagationContext): this;
setPropagationContext(
context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
): this;

/**
* Get propagation context from the scope, used for distributed tracing
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/tracing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
* particular execution context when performance monitoring is disabled.
*
* The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
*
* @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
*/
spanId: string;
/**
Expand Down
1 change: 1 addition & 0 deletions packages/utils/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down

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

Skip to content
feat(core): Deprecate spanId on propagationContext#14482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 27, 2024
 Merged


feat(core): Deprecate spanId on propagationContext
#14482
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba1dfe0

feat(core): Deprecate `spanId` on propagationContext


mydea Nov 26, 2024
7965df1

fix linting


mydea Nov 26, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
docs/migration/draft-v9-migration-guide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,6 +43,8 @@
- Deprecated `debugIntegration`. To log outgoing events, use [Hook Options](https://docs.sentry.io/platforms/javascript/configuration/options/#hooks) (`beforeSend`, `beforeSendTransaction`, ...).
- Deprecated `sessionTimingIntegration`. To capture session durations alongside events, use [Context](https://docs.sentry.io/platforms/javascript/enriching-events/context/) (`Sentry.setContext()`).
- Deprecated `addTracingHeadersToFetchRequest` method - this was only meant for internal use and is not needed anymore.
- Deprecated `generatePropagationContext()` in favor of using `generateTraceId()` directly.
- Deprecated `spanId` field on `propagationContext` - this field will be removed in v9, and should neither be read or set anymore.

## `@sentry/nestjs`

Expand Down

6 changes: 3 additions & 3 deletions
packages/browser/src/tracing/browserTracingIntegration.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ import {
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 TRACING_DEFAULTS,
 generateTraceId,
 getActiveSpan,
 getClient,
 getCurrentScope,
Expand All@@ -28,7 +29,6 @@ import {
import {
 GLOBAL_OBJ,
 browserPerformanceTimeOrigin,
 generatePropagationContext,
 getDomElement,
 logger,
 propagationContextFromHeaders,
Expand DownExpand Up@@ -452,8 +452,8 @@ export function startBrowserTracingPageLoadSpan(
 * This will only do something if a browser tracing integration has been setup.
 */
export function startBrowserTracingNavigationSpan(client: Client, spanOptions: StartSpanOptions): Span | undefined {
 getIsolationScope().setPropagationContext(generatePropagationContext());
 getCurrentScope().setPropagationContext(generatePropagationContext());
 getIsolationScope().setPropagationContext({ traceId: generateTraceId() });
 getCurrentScope().setPropagationContext({ traceId: generateTraceId() });

 client.emit('startNavigationSpan', spanOptions);

Expand Down

2 changes: 2 additions & 0 deletions
packages/browser/test/tracing/browserTracingIntegration.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -688,6 +688,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: true,
Expand DownExpand Up@@ -727,6 +728,7 @@ describe('browserTracingIntegration', () => {

 const propCtxAfterEnd = getCurrentScope().getPropagationContext();
 expect(propCtxAfterEnd).toStrictEqual({
 // eslint-disable-next-line deprecation/deprecation
 spanId: propCtxBeforeEnd.spanId,
 traceId: propCtxBeforeEnd.traceId,
 sampled: false,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/currentScopes.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,8 @@ export function getClient<C extends Client>(): C | undefined {
export function getTraceContextFromScope(scope: Scope): TraceContext {
 const propagationContext = scope.getPropagationContext();

 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = propagationContext;

 const traceContext: TraceContext = dropUndefinedKeys({
Expand Down

19 changes: 14 additions & 5 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,7 @@ import { updateSession } from './session';
import { isPlainObject } from './utils-hoist/is';
import { logger } from './utils-hoist/logger';
import { uuid4 } from './utils-hoist/misc';
import { generatePropagationContext } from './utils-hoist/propagationContext';
import { generateSpanId, generateTraceId } from './utils-hoist/propagationContext';
import { dateTimestampInSeconds } from './utils-hoist/time';
import { merge } from './utils/merge';
import { _getSpanForScope, _setSpanForScope } from './utils/spanOnScope';
Expand DownExpand Up@@ -115,7 +115,10 @@ class ScopeClass implements ScopeInterface {
 this._extra = {};
 this._contexts = {};
 this._sdkProcessingMetadata = {};
 this._propagationContext = generatePropagationContext();
 this._propagationContext = {
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
 }

 /**
Expand DownExpand Up@@ -398,7 +401,7 @@ class ScopeClass implements ScopeInterface {
 this._session = undefined;
 _setSpanForScope(this, undefined);
 this._attachments = [];
 this._propagationContext = generatePropagationContext();
 this.setPropagationContext({ traceId: generateTraceId() });

 this._notifyScopeListeners();
 return this;
Expand DownExpand Up@@ -491,8 +494,14 @@ class ScopeClass implements ScopeInterface {
 /**
 * @inheritDoc
 */
 public setPropagationContext(context: PropagationContext): this {
 this._propagationContext = context;
 public setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this {
 this._propagationContext = {
 // eslint-disable-next-line deprecation/deprecation
 spanId: generateSpanId(),
 ...context,
 };
 return this;
 }

Expand Down

4 changes: 2 additions & 2 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ import { getAsyncContextStrategy } from '../asyncContext';
import { DEBUG_BUILD } from '../debug-build';
import { SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
import { logger } from '../utils-hoist/logger';
import { generatePropagationContext } from '../utils-hoist/propagationContext';
import { generateTraceId } from '../utils-hoist/propagationContext';
import { propagationContextFromHeaders } from '../utils-hoist/tracing';
import { handleCallbackErrors } from '../utils/handleCallbackErrors';
import { hasTracingEnabled } from '../utils/hasTracingEnabled';
Expand DownExpand Up@@ -260,7 +260,7 @@ export function suppressTracing<T>(callback: () => T): T {
 */
export function startNewTrace<T>(callback: () => T): T {
 return withScope(scope => {
 scope.setPropagationContext(generatePropagationContext());
 scope.setPropagationContext({ traceId: generateTraceId() });
 DEBUG_BUILD && logger.info(`Starting a new trace with id ${scope.getPropagationContext().traceId}`);
 return withActiveSpan(null, callback);
 });
Expand Down

7 changes: 6 additions & 1 deletion
packages/core/src/utils-hoist/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,7 +166,12 @@ export { makeFifoCache } from './cache';
export { eventFromMessage, eventFromUnknownInput, exceptionFromError, parseStackFrames } from './eventbuilder';
export { callFrameToStackFrame, watchdogTimer } from './anr';
export { LRUMap } from './lru';
export { generatePropagationContext } from './propagationContext';
export {
 // eslint-disable-next-line deprecation/deprecation
 generatePropagationContext,
 generateTraceId,
 generateSpanId,
} from './propagationContext';
export { vercelWaitUntil } from './vercelWaitUntil';
export { SDK_VERSION } from './version';
export { getDebugImagesForResources, getFilenameToDebugIdMap } from './debug-ids';
Expand Down

22 changes: 19 additions & 3 deletions
packages/core/src/utils-hoist/propagationContext.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,11 +2,27 @@ import type { PropagationContext } from '@sentry/types';
import { uuid4 } from './misc';

/**
 * Returns a new minimal propagation context
 * Returns a new minimal propagation context.
 *
 * @deprecated Use `generateTraceId` and `generateSpanId` instead.
 */
export function generatePropagationContext(): PropagationContext {
 return {
 traceId: uuid4(),
 spanId: uuid4().substring(16),
 traceId: generateTraceId(),
 spanId: generateSpanId(),
 };
}

/**
 * Generate a random, valid trace ID.
 */
export function generateTraceId(): string {
 return uuid4();
}

/**
 * Generate a random, valid span ID.
 */
export function generateSpanId(): string {
 return uuid4().substring(16);
}

6 changes: 3 additions & 3 deletions
packages/core/src/utils-hoist/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import type { PropagationContext, TraceparentData } from '@sentry/types';

import { baggageHeaderToDynamicSamplingContext } from './baggage';
import { uuid4 } from './misc';
import { generatePropagationContext } from './propagationContext';
import { generateSpanId, generateTraceId } from './propagationContext';

// eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- RegExp is used for readability here
export const TRACEPARENT_REGEXP = new RegExp(
Expand DownExpand Up@@ -56,12 +56,12 @@ export function propagationContextFromHeaders(
 const dynamicSamplingContext = baggageHeaderToDynamicSamplingContext(baggage);

 if (!traceparentData || !traceparentData.traceId) {
 return generatePropagationContext();
 return { traceId: generateTraceId(), spanId: generateSpanId() };
 }

 const { traceId, parentSpanId, parentSampled } = traceparentData;

 const virtualSpanId = uuid4().substring(16);
 const virtualSpanId = generateSpanId();

 return {
 traceId,
Expand Down

2 changes: 2 additions & 0 deletions
packages/core/src/utils/traceData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,6 +81,8 @@ export function isValidBaggageString(baggage?: string): boolean {
 * Get a sentry-trace header value for the given scope.
 */
function scopeToTraceHeader(scope: Scope): string {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, sampled, spanId } = scope.getPropagationContext();
 return generateSentryTraceHeader(traceId, spanId, sampled);
}

1 change: 1 addition & 0 deletions
packages/core/test/utils-hoist/proagationContext.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { generatePropagationContext } from '../../src/utils-hoist/propagationCon

describe('generatePropagationContext', () => {
 it('generates a new minimal propagation context', () => {
 // eslint-disable-next-line deprecation/deprecation
 expect(generatePropagationContext()).toEqual({
 traceId: expect.stringMatching(/^[0-9a-f]{32}$/),
 spanId: expect.stringMatching(/^[0-9a-f]{16}$/),
Expand Down

2 changes: 2 additions & 0 deletions
packages/node/src/integrations/anr/worker.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,8 @@ function applyScopeToEvent(event: Event, scope: ScopeData): void {
 applyScopeDataToEvent(event, scope);

 if (!event.contexts?.trace) {
 // TODO(v9): Use generateSpanId() instead of spanId
 // eslint-disable-next-line deprecation/deprecation
 const { traceId, spanId, parentSpanId } = scope.propagationContext;
 event.contexts = {
 trace: {
Expand Down

2 changes: 2 additions & 0 deletions
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -220,6 +220,8 @@ export function getInjectionData(context: Context): {
 return {
 dynamicSamplingContext,
 traceId: propagationContext.traceId,
 // TODO(v9): Use generateSpanId() instead
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.spanId,
 sampled: propagationContext.sampled,
 };
Expand Down

1 change: 1 addition & 0 deletions
packages/opentelemetry/src/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -201,6 +201,7 @@ function getContext(scope: Scope | undefined, forceTransaction: boolean | undefi

 const spanOptions: SpanContext = {
 traceId: propagationContext.traceId,
 // eslint-disable-next-line deprecation/deprecation
 spanId: propagationContext.parentSpanId || propagationContext.spanId,
 isRemote: true,
 traceFlags: propagationContext.sampled ? TraceFlags.SAMPLED : TraceFlags.NONE,
Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -226,7 +226,9 @@ export interface Scope {
 /**
 * Add propagation context to the scope, used for distributed tracing
 */
 setPropagationContext(context: PropagationContext): this;
 setPropagationContext(
 context: Omit<PropagationContext, 'spanId'> & Partial<Pick<PropagationContext, 'spanId'>>,
 ): this;

 /**
 * Get propagation context from the scope, used for distributed tracing
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/tracing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,8 @@ export interface PropagationContext {
 * particular execution context when performance monitoring is disabled.
 *
 * The ID of a current span (if one exists) should have precedence over this value when propagating trace data.
 *
 * @deprecated This value will not be used anymore in the future, and should not be set or read anymore.
 */
 spanId: string;
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/utils/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -517,6 +517,7 @@ export const watchdogTimer = watchdogTimer_imported;
export const LRUMap = LRUMap_imported;

/** @deprecated Import from `@sentry/core` instead. */
// eslint-disable-next-line deprecation/deprecation
export const generatePropagationContext = generatePropagationContext_imported;

/** @deprecated Import from `@sentry/core` instead. */
Expand Down