feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into from
Jun 20, 2024
Merged

feat(core): Add parentSpan option to startSpan* APIs #12567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
211 changes: 122 additions & 89 deletions packages/core/src/tracing/trace.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
* You'll always get a span passed to the callback,
* it may just be a non-recording span if the span is not sampled or if tracing is disabled.
*/
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
const acs = getAcs();
if (acs.startSpan) {
return acs.startSpan(context, callback);
return acs.startSpan(options, callback);
}

const spanContext = normalizeContext(context);

return withScope(context.scope, scope => {
const parentSpan = getParentSpan(scope);

const shouldSkipSpan = context.onlyIfParent && !parentSpan;
const activeSpan = shouldSkipSpan
? new SentryNonRecordingSpan()
: createChildOrRootSpan({
parentSpan,
spanContext,
forceTransaction: context.forceTransaction,
scope,
});

_setSpanForScope(scope, activeSpan);

return handleCallbackErrors(
() => callback(activeSpan),
() => {
// Only update the span status if it hasn't been changed yet, and the span is not yet finished
const { status } = spanToJSON(activeSpan);
if (activeSpan.isRecording() && (!status || status === 'ok')) {
activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
},
() => activeSpan.end(),
);
const spanArguments = parseSentrySpanArguments(options);
const { forceTransaction, parentSpan: customParentSpan } = options;

return withScope(options.scope, () => {
// If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
const wrapper = getActiveSpanWrapper<T>(customParentSpan);

return wrapper(() => {
const scope = getCurrentScope();
const parentSpan = getParentSpan(scope);

const shouldSkipSpan = options.onlyIfParent && !parentSpan;
const activeSpan = shouldSkipSpan
? new SentryNonRecordingSpan()
: createChildOrRootSpan({
parentSpan,
spanArguments,
forceTransaction,
scope,
});

_setSpanForScope(scope, activeSpan);

return handleCallbackErrors(
() => callback(activeSpan),
() => {
// Only update the span status if it hasn't been changed yet, and the span is not yet finished
const { status } = spanToJSON(activeSpan);
if (activeSpan.isRecording() && (!status || status === 'ok')) {
activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
},
() => activeSpan.end(),
);
});
});
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
* You'll always get a span passed to the callback,
* it may just be a non-recording span if the span is not sampled or if tracing is disabled.
*/
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
const acs = getAcs();
if (acs.startSpanManual) {
return acs.startSpanManual(context, callback);
return acs.startSpanManual(options, callback);
}

const spanContext = normalizeContext(context);

return withScope(context.scope, scope => {
const parentSpan = getParentSpan(scope);

const shouldSkipSpan = context.onlyIfParent && !parentSpan;
const activeSpan = shouldSkipSpan
? new SentryNonRecordingSpan()
: createChildOrRootSpan({
parentSpan,
spanContext,
forceTransaction: context.forceTransaction,
scope,
});

_setSpanForScope(scope, activeSpan);

function finishAndSetSpan(): void {
activeSpan.end();
}

return handleCallbackErrors(
() => callback(activeSpan, finishAndSetSpan),
() => {
// Only update the span status if it hasn't been changed yet, and the span is not yet finished
const { status } = spanToJSON(activeSpan);
if (activeSpan.isRecording() && (!status || status === 'ok')) {
activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
},
);
const spanArguments = parseSentrySpanArguments(options);
const { forceTransaction, parentSpan: customParentSpan } = options;

return withScope(options.scope, () => {
// If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
const wrapper = getActiveSpanWrapper<T>(customParentSpan);

return wrapper(() => {
const scope = getCurrentScope();
const parentSpan = getParentSpan(scope);

const shouldSkipSpan = options.onlyIfParent && !parentSpan;
const activeSpan = shouldSkipSpan
? new SentryNonRecordingSpan()
: createChildOrRootSpan({
parentSpan,
spanArguments,
forceTransaction,
scope,
});

_setSpanForScope(scope, activeSpan);

function finishAndSetSpan(): void {
activeSpan.end();
}

return handleCallbackErrors(
() => callback(activeSpan, finishAndSetSpan),
() => {
// Only update the span status if it hasn't been changed yet, and the span is not yet finished
const { status } = spanToJSON(activeSpan);
if (activeSpan.isRecording() && (!status || status === 'ok')) {
activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
},
);
});
});
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
* This function will always return a span,
* it may just be a non-recording span if the span is not sampled or if tracing is disabled.
*/
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
const acs = getAcs();
if (acs.startInactiveSpan) {
return acs.startInactiveSpan(context);
return acs.startInactiveSpan(options);
}

const spanContext = normalizeContext(context);
const spanArguments = parseSentrySpanArguments(options);
const { forceTransaction, parentSpan: customParentSpan } = options;

const scope = context.scope || getCurrentScope();
const parentSpan = getParentSpan(scope);
// If `options.scope` is defined, we use this as as a wrapper,
// If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
const wrapper = options.scope
? (callback: () => Span) => withScope(options.scope, callback)
: customParentSpan
? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
: (callback: () => Span) => callback();

const shouldSkipSpan = context.onlyIfParent && !parentSpan;
return wrapper(() => {
const scope = getCurrentScope();
const parentSpan = getParentSpan(scope);

if (shouldSkipSpan) {
return new SentryNonRecordingSpan();
}
const shouldSkipSpan = options.onlyIfParent && !parentSpan;

if (shouldSkipSpan) {
return new SentryNonRecordingSpan();
}

return createChildOrRootSpan({
parentSpan,
spanContext,
forceTransaction: context.forceTransaction,
scope,
return createChildOrRootSpan({
parentSpan,
spanArguments,
forceTransaction,
scope,
});
});
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
parentSpan,
spanContext,
spanArguments,
forceTransaction,
scope,
}: {
parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
forceTransaction?: boolean;
scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

let span: Span;
if (parentSpan && !forceTransaction) {
span = _startChildSpan(parentSpan, scope, spanContext);
span = _startChildSpan(parentSpan, scope, spanArguments);
addChildSpanToSpan(parentSpan, span);
} else if (parentSpan) {
// If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
{
traceId,
parentSpanId,
...spanContext,
...spanArguments,
},
scope,
parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
{
traceId,
parentSpanId,
...spanContext,
...spanArguments,
},
scope,
parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
* This converts StartSpanOptions to SentrySpanArguments.
* For the most part (for now) we accept the same options,
* but some of them need to be transformed.
*
* Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
*/
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
const exp = options.experimental || {};
const initialCtx: SentrySpanArguments = {
isStandalone: exp.standalone,
...context,
...options,
};

if (context.startTime) {
if (options.startTime) {
const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
delete ctx.startTime;
return ctx;
}
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
return parentSpan
? (callback: () => T) => {
return withActiveSpan(parentSpan, callback);
}
: (callback: () => T) => callback();
}
41 changes: 39 additions & 2 deletions packages/core/test/lib/tracing/trace.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
expect(getActiveSpan()).toBe(undefined);
});

it('allows to pass a parentSpan', () => {
const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

startSpan({ name: 'GET users/[id]', parentSpan }, span => {
expect(getActiveSpan()).toBe(span);
expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
});

expect(getActiveSpan()).toBe(undefined);
});

it('allows to force a transaction with forceTransaction=true', async () => {
const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
_setSpanForScope(manualScope, parentSpan);

startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
expect(getCurrentScope()).not.toBe(initialScope);
expect(getCurrentScope()).toBe(manualScope);
expect(getActiveSpan()).toBe(span);
expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

// Is still the active span
expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
expect(getActiveSpan()).toBe(undefined);
});

it('allows to pass a parentSpan', () => {
const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
expect(getActiveSpan()).toBe(span);
expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

span.end();
});

expect(getActiveSpan()).toBe(undefined);
});

it('allows to force a transaction with forceTransaction=true', async () => {
const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
expect(getActiveSpan()).toBeUndefined();
});

it('allows to pass a parentSpan', () => {
const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
expect(getActiveSpan()).toBe(undefined);

span.end();

expect(getActiveSpan()).toBeUndefined();
});

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading

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

Skip to content
feat(core): Add parentSpan option to startSpan* APIs#12567

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 1 commit into

from

Jun 20, 2024
 Merged


feat(core): Add parentSpan option to startSpan* APIs
#12567
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


211 changes: 122 additions & 89 deletions
packages/core/src/tracing/trace.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
/* eslint-disable max-lines */

import type { ClientOptions, Scope, SentrySpanArguments, Span, SpanTimeInput, StartSpanOptions } from '@sentry/types';
import { generatePropagationContext, logger, propagationContextFromHeaders } from '@sentry/utils';
import type { AsyncContextStrategy } from '../asyncContext/types';
Expand DownExpand Up@@ -32,40 +34,47 @@ const SUPPRESS_TRACING_KEY = '__SENTRY_SUPPRESS_TRACING__';
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) => T): T {
export function startSpan<T>(options: StartSpanOptions, callback: (span: Span) => T): T {
 const acs = getAcs();
 if (acs.startSpan) {
 return acs.startSpan(context, callback);
 return acs.startSpan(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 return handleCallbackErrors(
 () => callback(activeSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 () => activeSpan.end(),
 );
 });
 });
}

Expand All@@ -79,43 +88,50 @@ export function startSpan<T>(context: StartSpanOptions, callback: (span: Span) =
 * You'll always get a span passed to the callback,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startSpanManual<T>(context: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
export function startSpanManual<T>(options: StartSpanOptions, callback: (span: Span, finish: () => void) => T): T {
 const acs = getAcs();
 if (acs.startSpanManual) {
 return acs.startSpanManual(context, callback);
 return acs.startSpanManual(options, callback);
 }

 const spanContext = normalizeContext(context);

 return withScope(context.scope, scope => {
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 return withScope(options.scope, () => {
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = getActiveSpanWrapper<T>(customParentSpan);

 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 const shouldSkipSpan = options.onlyIfParent && !parentSpan;
 const activeSpan = shouldSkipSpan
 ? new SentryNonRecordingSpan()
 : createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });

 _setSpanForScope(scope, activeSpan);

 function finishAndSetSpan(): void {
 activeSpan.end();
 }

 return handleCallbackErrors(
 () => callback(activeSpan, finishAndSetSpan),
 () => {
 // Only update the span status if it hasn't been changed yet, and the span is not yet finished
 const { status } = spanToJSON(activeSpan);
 if (activeSpan.isRecording() && (!status || status === 'ok')) {
 activeSpan.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
 }
 },
 );
 });
 });
}

Expand All@@ -128,28 +144,39 @@ export function startSpanManual<T>(context: StartSpanOptions, callback: (span: S
 * This function will always return a span,
 * it may just be a non-recording span if the span is not sampled or if tracing is disabled.
 */
export function startInactiveSpan(context: StartSpanOptions): Span {
export function startInactiveSpan(options: StartSpanOptions): Span {
 const acs = getAcs();
 if (acs.startInactiveSpan) {
 return acs.startInactiveSpan(context);
 return acs.startInactiveSpan(options);
 }

 const spanContext = normalizeContext(context);
 const spanArguments = parseSentrySpanArguments(options);
 const { forceTransaction, parentSpan: customParentSpan } = options;

 const scope = context.scope || getCurrentScope();
 const parentSpan = getParentSpan(scope);
 // If `options.scope` is defined, we use this as as a wrapper,
 // If `options.parentSpan` is defined, we want to wrap the callback in `withActiveSpan`
 const wrapper = options.scope
 ? (callback: () => Span) => withScope(options.scope, callback)
 : customParentSpan
 ? (callback: () => Span) => withActiveSpan(customParentSpan, callback)
 : (callback: () => Span) => callback();

 const shouldSkipSpan = context.onlyIfParent && !parentSpan;
 return wrapper(() => {
 const scope = getCurrentScope();
 const parentSpan = getParentSpan(scope);

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }
 const shouldSkipSpan = options.onlyIfParent && !parentSpan;

 if (shouldSkipSpan) {
 return new SentryNonRecordingSpan();
 }

 return createChildOrRootSpan({
 parentSpan,
 spanContext,
 forceTransaction: context.forceTransaction,
 scope,
 return createChildOrRootSpan({
 parentSpan,
 spanArguments,
 forceTransaction,
 scope,
 });
 });
}

Expand DownExpand Up@@ -239,12 +266,12 @@ export function startNewTrace<T>(callback: () => T): T {

function createChildOrRootSpan({
 parentSpan,
spanContext,
spanArguments,
 forceTransaction,
 scope,
}: {
 parentSpan: SentrySpan | undefined;
spanContext: SentrySpanArguments;
spanArguments: SentrySpanArguments;
 forceTransaction?: boolean;
 scope: Scope;
}): Span {
Expand All@@ -256,7 +283,7 @@ function createChildOrRootSpan({

 let span: Span;
 if (parentSpan && !forceTransaction) {
 span = _startChildSpan(parentSpan, scope, spanContext);
 span = _startChildSpan(parentSpan, scope, spanArguments);
 addChildSpanToSpan(parentSpan, span);
 } else if (parentSpan) {
 // If we forced a transaction but have a parent span, make sure to continue from the parent span, not the scope
Expand All@@ -268,7 +295,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -290,7 +317,7 @@ function createChildOrRootSpan({
 {
 traceId,
 parentSpanId,
 ...spanContext,
 ...spanArguments,
 },
 scope,
 parentSampled,
Expand All@@ -312,19 +339,17 @@ function createChildOrRootSpan({
 * This converts StartSpanOptions to SentrySpanArguments.
 * For the most part (for now) we accept the same options,
 * but some of them need to be transformed.
 *
 * Eventually the StartSpanOptions will be more aligned with OpenTelemetry.
 */
function normalizeContext(context: StartSpanOptions): SentrySpanArguments {
 const exp = context.experimental || {};
function parseSentrySpanArguments(options: StartSpanOptions): SentrySpanArguments {
 const exp = options.experimental || {};
 const initialCtx: SentrySpanArguments = {
 isStandalone: exp.standalone,
 ...context,
 ...options,
 };

 if (context.startTime) {
 if (options.startTime) {
 const ctx: SentrySpanArguments & { startTime?: SpanTimeInput } = { ...initialCtx };
 ctx.startTimestamp = spanTimeInputToSeconds(context.startTime);
 ctx.startTimestamp = spanTimeInputToSeconds(options.startTime);
 delete ctx.startTime;
 return ctx;
 }
Expand DownExpand Up@@ -419,3 +444,11 @@ function getParentSpan(scope: Scope): SentrySpan | undefined {

 return span;
}

function getActiveSpanWrapper<T>(parentSpan?: Span): (callback: () => T) => T {
 return parentSpan
 ? (callback: () => T) => {
 return withActiveSpan(parentSpan, callback);
 }
 : (callback: () => T) => callback();
}

41 changes: 39 additions & 2 deletions
packages/core/test/lib/tracing/trace.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -271,6 +271,17 @@ describe('startSpan', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpan({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -653,13 +664,13 @@ describe('startSpanManual', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true });
 _setSpanForScope(manualScope, parentSpan);

 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, (span, finish) => {
 startSpanManual({ name: 'GET users/[id]', scope: manualScope }, span => {
 expect(getCurrentScope()).not.toBe(initialScope);
 expect(getCurrentScope()).toBe(manualScope);
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

finish();
span.end();

 // Is still the active span
 expect(getActiveSpan()).toBe(span);
Expand All@@ -669,6 +680,19 @@ describe('startSpanManual', () => {
 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 startSpanManual({ name: 'GET users/[id]', parentSpan }, span => {
 expect(getActiveSpan()).toBe(span);
 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');

 span.end();
 });

 expect(getActiveSpan()).toBe(undefined);
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand DownExpand Up@@ -977,6 +1001,19 @@ describe('startInactiveSpan', () => {
 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to pass a parentSpan', () => {
 const parentSpan = new SentrySpan({ spanId: 'parent-span-id', sampled: true, name: 'parent-span' });

 const span = startInactiveSpan({ name: 'GET users/[id]', parentSpan });

 expect(spanToJSON(span).parent_span_id).toBe('parent-span-id');
 expect(getActiveSpan()).toBe(undefined);

 span.end();

 expect(getActiveSpan()).toBeUndefined();
 });

 it('allows to force a transaction with forceTransaction=true', async () => {
 const options = getDefaultTestClientOptions({ tracesSampleRate: 1.0 });
 client = new TestClient(options);
Expand Down
Loading