feat(core): Streamline SpanJSON type#14693

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mydea merged 4 commits into from
Dec 16, 2024
Merged

feat(core): Streamline SpanJSON type #14693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a3dab1
feat(core): Streamline `SpanJSON` type
mydea Dec 13, 2024
c704a24
fix tests
mydea Dec 13, 2024
747adc1
fix more tests
mydea Dec 13, 2024
fb7efb9
fix node test?
mydea Dec 13, 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 dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
{
description: 'span_3',
parent_span_id: rootSpanId,
data: {},
},
{
description: 'span_5',
parent_span_id: span3Id,
data: {},
},
] as SpanJSON[],
});
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/types-hoist/span.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
data?: { [key: string]: any };
data: SpanAttributes;
description?: string;
op?: string;
parent_span_id?: string;
Expand Down
55 changes: 27 additions & 28 deletions packages/core/src/utils/spanUtils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
if (spanIsSentrySpan(span)) {
return span.getSpanJSON();
}

try {
const { spanId: span_id, traceId: trace_id } = span.spanContext();

// Handle a span from @opentelemetry/sdk-base-trace's `Span` class
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status } = span;

return dropUndefinedKeys({
span_id,
trace_id,
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
_metrics_summary: getMetricSummaryJsonForSpan(span),
});
}
const { spanId: span_id, traceId: trace_id } = span.spanContext();

// Finally, at least we have `spanContext()`....
return {
// Handle a span from @opentelemetry/sdk-base-trace's `Span` class
if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
const { attributes, startTime, name, endTime, parentSpanId, status } = span;

return dropUndefinedKeys({
span_id,
trace_id,
};
} catch {
return {};
data: attributes,
description: name,
parent_span_id: parentSpanId,
start_timestamp: spanTimeInputToSeconds(startTime),
// This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
timestamp: spanTimeInputToSeconds(endTime) || undefined,
status: getStatusMessage(status),
op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
_metrics_summary: getMetricSummaryJsonForSpan(span),
});
}

// Finally, at least we have `spanContext()`....
// This should not actually happen in reality, but we need to handle it for type safety.
return {
span_id,
trace_id,
start_timestamp: 0,
data: {},
};
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down
15 changes: 11 additions & 4 deletions packages/core/test/lib/baseclient.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
event_id: '972f45b826a248bba98e990878a177e1',
spans: [
{
data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
description: 'first-paint',
timestamp: 1591603196.637835,
op: 'paint',
parent_span_id: 'a3df84a60c2e4e76',
span_id: '9e15bf99fbe4bc80',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
{
description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
span_id: 'aa554c1f506b0783',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
],
start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
span_id: '9e15bf99fbe4bc80',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
{
description: 'second span',
span_id: 'aa554c1f506b0783',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
],
};
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
transaction: '/dogs/are/great',
type: 'transaction',
spans: [
{ span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
{ span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
{ span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
{ span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
{ span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
{ span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
],
});

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
span_id: '9e15bf99fbe4bc80',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
{
description: 'second span',
span_id: 'aa554c1f506b0783',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
],
};
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
span_id: '9e15bf99fbe4bc80',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
{
description: 'second span',
span_id: 'aa554c1f506b0783',
start_timestamp: 1591603196.637835,
trace_id: '86f39e84263a4de99c326acab3bfe3bd',
data: {},
},
],
};
Expand Down
4 changes: 4 additions & 0 deletions packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
expect(spanToJSON(span)).toEqual({
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
data: {},
start_timestamp: 0,
});

// Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
expect(spanToJSON(span)).toEqual({
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
data: {},
start_timestamp: 0,
});
});
});
19 changes: 15 additions & 4 deletions packages/core/test/lib/utils/spanUtils.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
});
});

it('returns empty object for unknown span implementation', () => {
const span = { other: 'other' };

expect(spanToJSON(span as unknown as Span)).toEqual({});
it('returns minimal object for unknown span implementation', () => {
const span = {
// This is the minimal interface we require from a span
spanContext: () => ({
spanId: 'SPAN-1',
traceId: 'TRACE-1',
}),
};

expect(spanToJSON(span as unknown as Span)).toEqual({
span_id: 'SPAN-1',
trace_id: 'TRACE-1',
start_timestamp: 0,
data: {},
});
});
});

Expand Down
4 changes: 2 additions & 2 deletions packages/node/src/integrations/tracing/graphql.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
// We keep track of each operation on the root span
// This can either be a string, or an array of strings (if there are multiple operations)
if (Array.isArray(existingOperations)) {
existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
} else if (existingOperations) {
} else if (typeof existingOperations === 'string') {
rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
} else {
rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down
17 changes: 9 additions & 8 deletions packages/node/src/integrations/tracing/vercelai/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
}
if (
attributes['ai.usage.completionTokens'] != undefined &&
attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
) {
span.data['ai.total_tokens.used'] =
attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
}

// The id of the model
const aiModelId: string | undefined = attributes['ai.model.id'];
const aiModelId = attributes['ai.model.id'];

// the provider of the model
const aiModelProvider: string | undefined = attributes['ai.model.provider'];
const aiModelProvider = attributes['ai.model.provider'];

// both of these must be defined for the integration to work
if (!aiModelId || !aiModelProvider) {
if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
return;
}

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
span.updateName(nameWthoutAi);

// If a Telemetry name is set and it is a pipeline span, use that as the operation name
if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
span.updateName(attributes['ai.telemetry.functionId']);
span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
const functionId = attributes['ai.telemetry.functionId'];
if (functionId && typeof functionId === 'string' && isPipelineSpan) {
span.updateName(functionId);
span.setAttribute('ai.pipeline.name', functionId);
}

if (attributes['ai.prompt']) {
Expand Down
2 changes: 1 addition & 1 deletion packages/opentelemetry/src/propagator.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
// `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
// eslint-disable-next-line deprecation/deprecation
const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
if (urlAttribute) {
if (typeof urlAttribute === 'string') {
return urlAttribute;
}

Expand Down
6 changes: 6 additions & 0 deletions packages/opentelemetry/test/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
expect(spanToJSON(span)).toEqual({
span_id: '1121201211212012',
trace_id: '12312012123120121231201212312012',
data: {},
start_timestamp: 0,
});
expect(getSamplingDecision(span.spanContext())).toBe(false);
expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
expect(spanToJSON(span)).toEqual({
span_id: '1121201211212012',
trace_id: '12312012123120121231201212312012',
data: {},
start_timestamp: 0,
});
expect(getSamplingDecision(span.spanContext())).toBe(true);
expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
expect(spanToJSON(span)).toEqual({
span_id: '1121201211212012',
trace_id: '12312012123120121231201212312012',
data: {},
start_timestamp: 0,
});
expect(getSamplingDecision(span.spanContext())).toBe(true);
expect(spanIsSampled(span)).toBe(true);
Expand Down
4 changes: 3 additions & 1 deletion packages/vue/test/router.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
getActiveSpan: vi.fn().mockReturnValue({}),
getActiveSpan: vi.fn().mockReturnValue({
spanContext: () => ({ traceId: '1234', spanId: '5678' }),
}),
};
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

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): Streamline SpanJSON type#14693

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 4 commits into

from

Dec 16, 2024
 Merged


feat(core): Streamline SpanJSON type
#14693
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
9a3dab1

feat(core): Streamline `SpanJSON` type


mydea Dec 13, 2024
c704a24

fix tests


mydea Dec 13, 2024
747adc1

fix more tests


mydea Dec 13, 2024
fb7efb9

fix node test?


mydea Dec 13, 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
dev-packages/node-integration-tests/suites/public-api/startSpan/with-nested-spans/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -30,10 +30,12 @@ test('should report finished spans as children of the root transaction.', done =
 {
 description: 'span_3',
 parent_span_id: rootSpanId,
 data: {},
 },
 {
 description: 'span_5',
 parent_span_id: span3Id,
 data: {},
 },
 ] as SpanJSON[],
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/core/src/types-hoist/span.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;

/** A JSON representation of a span. */
export interface SpanJSON {
 data?: { [key: string]: any };
 data: SpanAttributes;
 description?: string;
 op?: string;
 parent_span_id?: string;
Expand Down

55 changes: 27 additions & 28 deletions
packages/core/src/utils/spanUtils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
// Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
// This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
// And `spanToJSON` needs the Span class from `span.ts` to check here.
export function spanToJSON(span: Span): Partial<SpanJSON> {
export function spanToJSON(span: Span): SpanJSON {
 if (spanIsSentrySpan(span)) {
 return span.getSpanJSON();
 }

 try {
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }
 const { spanId: span_id, traceId: trace_id } = span.spanContext();

 // Finally, at least we have `spanContext()`....
 return {
 // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
 if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
 const { attributes, startTime, name, endTime, parentSpanId, status } = span;

 return dropUndefinedKeys({
 span_id,
 trace_id,
 };
 } catch {
 return {};
 data: attributes,
 description: name,
 parent_span_id: parentSpanId,
 start_timestamp: spanTimeInputToSeconds(startTime),
 // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
 timestamp: spanTimeInputToSeconds(endTime) || undefined,
 status: getStatusMessage(status),
 op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
 origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
 _metrics_summary: getMetricSummaryJsonForSpan(span),
 });
 }

 // Finally, at least we have `spanContext()`....
 // This should not actually happen in reality, but we need to handle it for type safety.
 return {
 span_id,
 trace_id,
 start_timestamp: 0,
 data: {},
 };
}

function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {
Expand Down

15 changes: 11 additions & 4 deletions
packages/core/test/lib/baseclient.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -938,14 +938,14 @@ describe('BaseClient', () => {
 event_id: '972f45b826a248bba98e990878a177e1',
 spans: [
 {
 data: { _sentry_extra_metrics: { M1: { value: 1 }, M2: { value: 2 } } },
 description: 'first-paint',
 timestamp: 1591603196.637835,
 op: 'paint',
 parent_span_id: 'a3df84a60c2e4e76',
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'first-contentful-paint',
Expand All@@ -955,6 +955,7 @@ describe('BaseClient', () => {
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 start_timestamp: 1591603196.614865,
Expand DownExpand Up@@ -1016,12 +1017,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1076,9 +1079,9 @@ describe('BaseClient', () => {
 transaction: '/dogs/are/great',
 type: 'transaction',
 spans: [
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234 },
 { span_id: 'span1', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span2', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 { span_id: 'span3', trace_id: 'trace1', start_timestamp: 1234, data: {} },
 ],
 });

Expand DownExpand Up@@ -1107,12 +1110,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand DownExpand Up@@ -1181,12 +1186,14 @@ describe('BaseClient', () => {
 span_id: '9e15bf99fbe4bc80',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 {
 description: 'second span',
 span_id: 'aa554c1f506b0783',
 start_timestamp: 1591603196.637835,
 trace_id: '86f39e84263a4de99c326acab3bfe3bd',
 data: {},
 },
 ],
 };
Expand Down

4 changes: 4 additions & 0 deletions
packages/core/test/lib/tracing/sentryNonRecordingSpan.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });

 // Ensure all methods work
Expand All@@ -32,6 +34,8 @@ describe('SentryNonRecordingSpan', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 data: {},
 start_timestamp: 0,
 });
 });
});

19 changes: 15 additions & 4 deletions
packages/core/test/lib/utils/spanUtils.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -287,10 +287,21 @@ describe('spanToJSON', () => {
 });
 });

 it('returns empty object for unknown span implementation', () => {
 const span = { other: 'other' };

 expect(spanToJSON(span as unknown as Span)).toEqual({});
 it('returns minimal object for unknown span implementation', () => {
 const span = {
 // This is the minimal interface we require from a span
 spanContext: () => ({
 spanId: 'SPAN-1',
 traceId: 'TRACE-1',
 }),
 };

 expect(spanToJSON(span as unknown as Span)).toEqual({
 span_id: 'SPAN-1',
 trace_id: 'TRACE-1',
 start_timestamp: 0,
 data: {},
 });
 });
});

Expand Down

4 changes: 2 additions & 2 deletions
packages/node/src/integrations/tracing/graphql.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
 // We keep track of each operation on the root span
 // This can either be a string, or an array of strings (if there are multiple operations)
 if (Array.isArray(existingOperations)) {
 existingOperations.push(newOperation);
(existingOperations as string[]).push(newOperation);
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
 } else if (existingOperations) {
 } else if (typeof existingOperations === 'string') {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
 } else {
 rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);
Expand Down

17 changes: 9 additions & 8 deletions
packages/node/src/integrations/tracing/vercelai/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
 span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
 }
 if (
 attributes['ai.usage.completionTokens'] != undefined &&
 attributes['ai.usage.promptTokens'] != undefined
typeof attributes['ai.usage.completionTokens'] == 'number' &&
typeof attributes['ai.usage.promptTokens'] == 'number'
 ) {
 span.data['ai.total_tokens.used'] =
 attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
Expand All@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
 }

 // The id of the model
 const aiModelId: string | undefined = attributes['ai.model.id'];
 const aiModelId = attributes['ai.model.id'];

 // the provider of the model
 const aiModelProvider: string | undefined = attributes['ai.model.provider'];
 const aiModelProvider = attributes['ai.model.provider'];

 // both of these must be defined for the integration to work
 if (!aiModelId || !aiModelProvider) {
 if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
 return;
 }

Expand DownExpand Up@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
 span.updateName(nameWthoutAi);

 // If a Telemetry name is set and it is a pipeline span, use that as the operation name
 if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
 span.updateName(attributes['ai.telemetry.functionId']);
 span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
 const functionId = attributes['ai.telemetry.functionId'];
 if (functionId && typeof functionId === 'string' && isPipelineSpan) {
 span.updateName(functionId);
 span.setAttribute('ai.pipeline.name', functionId);
 }

 if (attributes['ai.prompt']) {
Expand Down

2 changes: 1 addition & 1 deletion
packages/opentelemetry/src/propagator.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
 // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
 // eslint-disable-next-line deprecation/deprecation
 const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
 if (urlAttribute) {
 if (typeof urlAttribute === 'string') {
 return urlAttribute;
 }

Expand Down

6 changes: 6 additions & 0 deletions
packages/opentelemetry/test/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1565,6 +1565,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(false);
 expect(spanIsSampled(span)).toBe(false);
Expand DownExpand Up@@ -1596,6 +1598,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand DownExpand Up@@ -1630,6 +1634,8 @@ describe('continueTrace', () => {
 expect(spanToJSON(span)).toEqual({
 span_id: '1121201211212012',
 trace_id: '12312012123120121231201212312012',
 data: {},
 start_timestamp: 0,
 });
 expect(getSamplingDecision(span.spanContext())).toBe(true);
 expect(spanIsSampled(span)).toBe(true);
Expand Down

4 changes: 3 additions & 1 deletion
packages/vue/test/router.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@ vi.mock('@sentry/core', async () => {
 const actual = await vi.importActual('@sentry/core');
 return {
 ...actual,
 getActiveSpan: vi.fn().mockReturnValue({}),
 getActiveSpan: vi.fn().mockReturnValue({
 spanContext: () => ({ traceId: '1234', spanId: '5678' }),
 }),
 };
});

Expand Down