Support getTraceData for custom scope

[jkjustjoshing]

Problem Statement

I'm building a browser extension with a content script, service worker, and side panel. I'd like to capture a trace that starts with a span for a click on the browser page from the content script, and includes spans from the service worker and side panel. To do this, I need to pass the sentry-trace and baggage values from the content script to the service worker, and from the service worker to the side panel.

To avoid conflicts with the base website's Sentry instance, I'm following the instructions for a shared environment. I'm having trouble getting trace data in this context, and I suspect it's because traces aren't working correctly in the shared environment.

Based on the lack of ability to pass scope to some of the trace methods, I suspect this may not be possible with the current SDK. I'd like to see this supported, and either way some documentation added to clarify the limits to how/where the tracing methods work.

Solution Brainstorm

getTraceData(), startSpan(), and startNewTrace() should be callable on a scope. startSpan() already supports passing a scope in the options, maybe the other 2 should support that. I'm not sure what needs to happen under-the-hood to get this working (if anything).

[mydea]

Hey, I think it is reasonable to allow to pass a scope & client directly to getTraceData!

startNewTrace is trickier because this by design forks a new scope for the active one. I think for this case, it is easier to re-implement this yourself:

function startNewTrace<T>(scope: Scope, callback: () => T): T {
    scope.setPropagationContext({
      traceId: generateTraceId(),
      sampleRand: Math.random(),
    });
    return withActiveSpan(null, callback);
}

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #16633, which was included in the 9.31.0 release.