-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(js): Add documentation for setActiveSpanInBrowser(span: Span)
#15007
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.
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
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 960 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
In contrast to [startSpanManual](#starting-an-active-span-with-manual-end-startspanmanual), the period for which | ||
the span is active is not bound to the callback. Instead, it will remain active until you manually end the span. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure if this is correct. startSpanManual
also needs to be manually ended, right? Or do I get this sentence wrong 🤔
After reading it some times again I think you mean that startSpanManual
is only an active span during the callback, even though it can be ended after the callback. Maybe we can write that a bit differently.
"Even though a span can be ended outside the callback of startSpanManual
, the span continues as inactive outside of the callback. With setActiveSpan
a span can be set active until you manually end the span."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for calling this out! I reworded this entire section. Hope it reads a bit better now :)
setSpanActive(span: Span)
setActiveSpanInBrowser(span: Span)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yay! Looks good.
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
c71d55c
to
e016711
Compare
DESCRIBE YOUR PR
Adds documentation for
Sentry. setActiveSpanInBrowser(span)
which is added via getsentry/sentry-javascript#17714. To be merged only after the feature was released. This is still based on #15006 because I need theavailableSince
prop on theSdkApi
component.closes https://linear.app/getsentry/issue/FE-608/docs-for-setspanactive
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES