fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into from
Sep 12, 2023
Merged

fix(node-otel): Refactor OTEL span reference cleanup #9000

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
727214b
feat(node-otel): Implement new strict parent handling mode
mydea Sep 12, 2023
aa5f56b
fix strict mode
mydea Sep 12, 2023
7da7fc4
ref: Refactor span map handling
mydea Sep 12, 2023
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: 1 addition & 1 deletion packages/opentelemetry-node/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down
4 changes: 2 additions & 2 deletions packages/opentelemetry-node/src/propagator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
SENTRY_TRACE_HEADER,
SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
* Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
const span = getSentrySpan(spanContext.spanId);
if (span) {
setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down
20 changes: 5 additions & 15 deletions packages/opentelemetry-node/src/spanprocessor.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
* Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

// Otel supports having multiple non-nested spans at the same time
// so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

if (sentryParentSpan) {
const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
spanId: otelSpanId,
});

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
} else {
const traceCtx = getTraceData(otelSpan, parentContext);
const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
spanId: otelSpanId,
});

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
}
}

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
if (!sentrySpan) {
__DEBUG_BUILD__ &&
logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
clearSpan(otelSpanId);
return;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry-node/src/utils/spanData.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down
92 changes: 92 additions & 0 deletions packages/opentelemetry-node/src/utils/spanMap.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
sentrySpan: SentrySpan;
ref: SpanRefType;
// These are not direct children, but all spans under the tree of a root span.
subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
* Get a Sentry span for a given span ID.
*/
export function getSentrySpan(spanId: string): SentrySpan | undefined {
const entry = SPAN_MAP.get(spanId);
return entry ? entry.sentrySpan : undefined;
}

/**
* Set a Sentry span for a given span ID.
* This is necessary so we can lookup parent spans later.
* We also keep a list of children for root spans only, in order to be able to clean them up together.
*/
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
let ref: SpanRefType = SPAN_REF_ROOT;

const rootSpanId = sentrySpan.transaction?.spanId;

if (rootSpanId && rootSpanId !== spanId) {
const root = SPAN_MAP.get(rootSpanId);
if (root) {
root.subSpans.push(spanId);
ref = SPAN_REF_CHILD;
}
}

SPAN_MAP.set(spanId, {
sentrySpan,
ref,
subSpans: [],
});
}

/**
* Clear references of the given span ID.
*/
export function clearSpan(spanId: string): void {
const entry = SPAN_MAP.get(spanId);
if (!entry) {
return;
}

const { ref, subSpans } = entry;

// If this is a child, mark it as ended.
if (ref === SPAN_REF_CHILD) {
entry.ref = SPAN_REF_CHILD_ENDED;
return;
}

// If this is a root span, clear all (ended) children
if (ref === SPAN_REF_ROOT) {
for (const childId of subSpans) {
const child = SPAN_MAP.get(childId);
if (!child) {
continue;
}

if (child.ref === SPAN_REF_CHILD_ENDED) {
// if the child has already ended, just clear it
SPAN_MAP.delete(childId);
} else if (child.ref === SPAN_REF_CHILD) {
// If the child has not ended yet, mark it as a root span so it is cleared when it ends.
child.ref = SPAN_REF_ROOT;
}
}

SPAN_MAP.delete(spanId);
return;
}

// Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
// But if it does, just clear the span
SPAN_MAP.delete(spanId);
}
8 changes: 4 additions & 4 deletions packages/opentelemetry-node/test/propagator.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
makeMain(hub);

afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
});

enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
if (type === PerfType.Span) {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { spanId, ...ctx } = transactionContext;
const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
}
}

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading

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

Skip to content
fix(node-otel): Refactor OTEL span reference cleanup#9000

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 3 commits into

from

Sep 12, 2023
 Merged


fix(node-otel): Refactor OTEL span reference cleanup
#9000
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
727214b

feat(node-otel): Implement new strict parent handling mode


mydea Sep 12, 2023
aa5f56b

fix strict mode


mydea Sep 12, 2023
7da7fc4

ref: Refactor span map handling


mydea Sep 12, 2023

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: 1 addition & 1 deletion
packages/opentelemetry-node/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getSentrySpan } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

export { SentrySpanProcessor } from './spanprocessor';
export { SentryPropagator } from './propagator';
Expand Down

4 changes: 2 additions & 2 deletions
packages/opentelemetry-node/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ import {
 SENTRY_TRACE_HEADER,
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from './constants';
import { SENTRY_SPAN_PROCESSOR_MAP } from './spanprocessor';
import { getSentrySpan } from './utils/spanMap';

/**
 * Injects and extracts `sentry-trace` and `baggage` headers from carriers.
Expand All@@ -30,7 +30,7 @@ export class SentryPropagator extends W3CBaggagePropagator {

 let baggage = propagation.getBaggage(context) || propagation.createBaggage({});

 const span = SENTRY_SPAN_PROCESSOR_MAP.get(spanContext.spanId);
 const span = getSentrySpan(spanContext.spanId);
 if (span) {
 setter.set(carrier, SENTRY_TRACE_HEADER, span.toTraceparent());

Expand Down

20 changes: 5 additions & 15 deletions
packages/opentelemetry-node/src/spanprocessor.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,18 +10,7 @@ import { SENTRY_DYNAMIC_SAMPLING_CONTEXT_KEY, SENTRY_TRACE_PARENT_CONTEXT_KEY }
import { isSentryRequestSpan } from './utils/isSentryRequest';
import { mapOtelStatus } from './utils/mapOtelStatus';
import { parseSpanDescription } from './utils/parseOtelSpanDescription';

export const SENTRY_SPAN_PROCESSOR_MAP: Map<string, SentrySpan> = new Map<string, SentrySpan>();

// make sure to remove references in maps, to ensure this can be GCed
function clearSpan(otelSpanId: string): void {
 SENTRY_SPAN_PROCESSOR_MAP.delete(otelSpanId);
}

/** Get a Sentry span for an otel span ID. */
export function getSentrySpan(otelSpanId: string): SentrySpan | undefined {
 return SENTRY_SPAN_PROCESSOR_MAP.get(otelSpanId);
}
import { clearSpan, getSentrySpan, setSentrySpan } from './utils/spanMap';

/**
 * Converts OpenTelemetry Spans to Sentry Spans and sends them to Sentry via
Expand DownExpand Up@@ -62,7 +51,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {

 // Otel supports having multiple non-nested spans at the same time
 // so we cannot use hub.getSpan(), as we cannot rely on this being on the current span
 const sentryParentSpan = otelParentSpanId && SENTRY_SPAN_PROCESSOR_MAP.get(otelParentSpanId);
 const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);

 if (sentryParentSpan) {
 const sentryChildSpan = sentryParentSpan.startChild({
Expand All@@ -72,7 +61,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, sentryChildSpan);
setSentrySpan(otelSpanId, sentryChildSpan);
 } else {
 const traceCtx = getTraceData(otelSpan, parentContext);
 const transaction = getCurrentHub().startTransaction({
Expand All@@ -83,7 +72,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 spanId: otelSpanId,
 });

SENTRY_SPAN_PROCESSOR_MAP.set(otelSpanId, transaction);
setSentrySpan(otelSpanId, transaction);
 }
 }

Expand All@@ -97,6 +86,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
 if (!sentrySpan) {
 __DEBUG_BUILD__ &&
 logger.error(`SentrySpanProcessor could not find span with OTEL-spanId ${otelSpanId} to finish.`);
 clearSpan(otelSpanId);
 return;
 }

Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry-node/src/utils/spanData.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
import { Transaction } from '@sentry/core';
import type { Context, SpanOrigin } from '@sentry/types';

import { getSentrySpan } from '../spanprocessor';
import { getSentrySpan } from './spanMap';

type SentryTags = Record<string, string>;
type SentryData = Record<string, unknown>;
Expand Down

92 changes: 92 additions & 0 deletions
packages/opentelemetry-node/src/utils/spanMap.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
import type { Span as SentrySpan } from '@sentry/types';

interface SpanMapEntry {
 sentrySpan: SentrySpan;
 ref: SpanRefType;
 // These are not direct children, but all spans under the tree of a root span.
 subSpans: string[];
}

const SPAN_REF_ROOT = Symbol('root');
const SPAN_REF_CHILD = Symbol('child');
const SPAN_REF_CHILD_ENDED = Symbol('child_ended');
type SpanRefType = typeof SPAN_REF_ROOT | typeof SPAN_REF_CHILD | typeof SPAN_REF_CHILD_ENDED;

/** Exported only for tests. */
export const SPAN_MAP = new Map<string, SpanMapEntry>();

/**
 * Get a Sentry span for a given span ID.
 */
export function getSentrySpan(spanId: string): SentrySpan | undefined {
 const entry = SPAN_MAP.get(spanId);
 return entry ? entry.sentrySpan : undefined;
}

/**
 * Set a Sentry span for a given span ID.
 * This is necessary so we can lookup parent spans later.
 * We also keep a list of children for root spans only, in order to be able to clean them up together.
 */
export function setSentrySpan(spanId: string, sentrySpan: SentrySpan): void {
 let ref: SpanRefType = SPAN_REF_ROOT;

 const rootSpanId = sentrySpan.transaction?.spanId;

 if (rootSpanId && rootSpanId !== spanId) {
 const root = SPAN_MAP.get(rootSpanId);
 if (root) {
 root.subSpans.push(spanId);
 ref = SPAN_REF_CHILD;
 }
 }

 SPAN_MAP.set(spanId, {
 sentrySpan,
 ref,
 subSpans: [],
 });
}

/**
 * Clear references of the given span ID.
 */
export function clearSpan(spanId: string): void {
 const entry = SPAN_MAP.get(spanId);
 if (!entry) {
 return;
 }

 const { ref, subSpans } = entry;

 // If this is a child, mark it as ended.
 if (ref === SPAN_REF_CHILD) {
 entry.ref = SPAN_REF_CHILD_ENDED;
 return;
 }

 // If this is a root span, clear all (ended) children
 if (ref === SPAN_REF_ROOT) {
 for (const childId of subSpans) {
 const child = SPAN_MAP.get(childId);
 if (!child) {
 continue;
 }

 if (child.ref === SPAN_REF_CHILD_ENDED) {
 // if the child has already ended, just clear it
 SPAN_MAP.delete(childId);
 } else if (child.ref === SPAN_REF_CHILD) {
 // If the child has not ended yet, mark it as a root span so it is cleared when it ends.
 child.ref = SPAN_REF_ROOT;
 }
 }

 SPAN_MAP.delete(spanId);
 return;
 }

 // Generally, `clearSpan` should never be called for ref === SPAN_REF_CHILD_ENDED
 // But if it does, just clear the span
 SPAN_MAP.delete(spanId);
}

8 changes: 4 additions & 4 deletions
packages/opentelemetry-node/test/propagator.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ import {
 SENTRY_TRACE_PARENT_CONTEXT_KEY,
} from '../src/constants';
import { SentryPropagator } from '../src/propagator';
import { SENTRY_SPAN_PROCESSOR_MAP } from '../src/spanprocessor';
import { setSentrySpan, SPAN_MAP } from '../src/utils/spanMap';

beforeAll(() => {
 addTracingExtensions();
Expand DownExpand Up@@ -51,7 +51,7 @@ describe('SentryPropagator', () => {
 makeMain(hub);

 afterEach(() => {
SENTRY_SPAN_PROCESSOR_MAP.clear();
SPAN_MAP.clear();
 });

 enum PerfType {
Expand All@@ -61,12 +61,12 @@ describe('SentryPropagator', () => {

 function createTransactionAndMaybeSpan(type: PerfType, transactionContext: TransactionContext) {
 const transaction = new Transaction(transactionContext, hub);
SENTRY_SPAN_PROCESSOR_MAP.set(transaction.spanId, transaction);
setSentrySpan(transaction.spanId, transaction);
 if (type === PerfType.Span) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { spanId, ...ctx } = transactionContext;
 const span = transaction.startChild({ ...ctx, description: transaction.name });
SENTRY_SPAN_PROCESSOR_MAP.set(span.spanId, span);
setSentrySpan(span.spanId, span);
 }
 }

Expand Down
Loading