[Call for Feedback] Road to Sentry JavaScript SDK v8 #9802
Replies: 5 comments 13 replies
-
|
With For reference, my old code is roughly something like this: Sentry.runWithAsyncContext(async () => {
const transaction = Sentry.startTransaction({ })
try {
// instrumented code
} finally {
transaction.finish()
}
}) |
Beta Was this translation helpful? Give feedback.
-
|
The way to do this is to create a new, detached scope, and pass it in: const scope = new Scope();
startSpan({ name: 'my detached span', scope }, (span) => {
// measure something in here
// `span` will get the active span from `scope` as parent
// as `scope` has no active span, it will thus have no parent!
});We haven't gotten around to document all of this properly, but LMK if that does not work as expected for you! You can also use this technique to force a span to be a child of a specific span. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks. That looks promising. I noticed that the new scope is not connected with the original trace (basically starts a new trace). Is there an easy way to get the two connected (through traceId/baggage)? I could convert the active span The bit of instrumented code is a kind of background job that should be largely independent of its "parent" (and run for much longer). That's why I want to treat it as separate transaction (and also so it shows up in the All Transactions view in the Sentry UI). but would be nice if both were connected to the same trace. |
Beta Was this translation helpful? Give feedback.
-
|
Right now everything is still a bit sucky but in the upcoming version ( app.get('/my-route', req => {
Sentry.withIsolationScope(isolationScope => {
Sentry.continueTrace(
{
sentryTrace: req.headers.get('sentry-trace'),
baggage: req.headers.get('baggage'),
},
() => {
// All spans started within this callback will be attached to the incoming trace, e.g:
Sentry.startSpan({ name: 'my attached span' }, async (span)=> {
await doExpensiveWork(),
});
},
);
});
}); |
Beta Was this translation helpful? Give feedback.
-
|
We are looking forward to the new version. A few words about the plan. Why not drop support for Node 14 and 16? It's deprecated. Although most likely, there is no specific code in Sentry for these versions.
It's hard to imagine anyone still using this version. Considering that the transition between versions in React is quite simple.
The transition from version 2 to version 3 is quite complicated. But maybe I’m wrong since I’m not a serious developer on Vue.
Setting up tracing was a little difficult; middleware names are not displayed correctly out of the box. The documentation does not explain very well the operation of the internal modules; in order to successfully configure all the data, we had to look at the code itself.
Node and express.js have to be separated. |
Beta Was this translation helpful? Give feedback.
-
|
Regarding the A valid question came here: Is there a way to send attachments (normal attachments, that take from the attachments quota) using this new API in v8? |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
I see that Serverless is included in this - are there plans to support Cloudflare? |
Beta Was this translation helpful? Give feedback.
-
|
@saturnonearth we'll be taking a look at cloudflare asap, just finishing clean up some leftover bugs from the Tracked with #2484 |
Beta Was this translation helpful? Give feedback.
-
|
Can not use I found it hard to do custom instrument with With |
Beta Was this translation helpful? Give feedback.
-
|
You'll have to keep track of the (inactive) spans somehow and wrap the code where you are running code that should be attached to it in let span;
function socketEventReceived() {
span = Sentry.startInactiveSpan({ ... });
}
function socketEventEnded() {
span?.end();
}
function doSomethingInside() {
return Sentry.withActiveSpan(span || null, () => {
// code in here will add things to span
});
}I understand that this is not ideal, but it's the only way that we can actually ensure that processes are isolated correctly and that children are attached to the actually correct span. Otherwise, when working with async code etc, it can become impossible to ensure that children are appened to the correct span, if multiple are open at the same time etc. |
Beta Was this translation helpful? Give feedback.
-
|
Thank @mydea, I'll definitely try that on my new projects. About what you said: And yes, it could be not safe if |
Beta Was this translation helpful? Give feedback.
-
|
If you manually start the span, all is good, you can still do that today via function startInactiveSpanChild(parent, spanOptions) {
return Sentry.withActiveSpan(parent, () => {
return Sentry.startInactiveSpan(spanOptions);
});
}
// somewhere else
const parent = Sentry.startInactiveSpan(...);
const child = startInactiveSpanChild(parent, ...);
child.end();
parent.end();The tricky thing is making a span active & ensuring that children created by auto-instrumentation are added correctly. This, today, is only possibly by wrapping the span that should be active in a callback with |
Beta Was this translation helpful? Give feedback.
-
|
Thank @mydea, that helper is really helpful. |
Beta Was this translation helpful? Give feedback.
-
|
you can def. use inactive spans for this - that should work just fine! |
Beta Was this translation helpful? Give feedback.
-
As we approach the start of 2024, the Sentry JavaScript team is looking at starting work on the next major version of it's JavaScript SDKs, v8, and we need help from you all to make our best one yet!
The theme of this major is to improve the SDK public API surface and try to eliminate confusing concepts in the SDK. This should reduce bundle size and make it way easier to use/write sdk integrations.
Via https://github.com/getsentry/sentry-migr8 we'll be providing a codemod that will automatically upgrade your app to v8 and fix all breaking changes.
The biggest breaking change with v8 will be the removal of
Sentry.startTransaction.startTransactionwill be replaced with our new APIs,startSpan,startInactiveSpan, andstartSpanManual.Big Goals:
Sentry.Hubclass), as per RFC 122@sentry/tracingand@sentry/hubpackages, and split up@sentry/tracing-internalinto runtime specific packages (@sentry/core,@sentry/browser).Planned Version support changes
instrument.ts)Although we have a general plan in mind, we need your feedback and thoughts to make sure we are covering everything we need to be:
What are the biggest pain points when using the SDK?
What features are you missing the most?
What would you like to be changed?
Thanks for your help!
Update: We've made a release plan based on these changes. See it here: #9508
Beta Was this translation helpful? Give feedback.
All reactions