Skip to content

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Sep 22, 2025

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 the availableSince prop on the SdkApi 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.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

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

Copy link

vercel bot commented Sep 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Sep 26, 2025 5:01pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Sep 26, 2025 5:01pm

Copy link

linear bot commented Sep 22, 2025

@Lms24 Lms24 requested review from a team, mydea and s1gr1d and removed request for a team September 22, 2025 14:51
@Lms24 Lms24 self-assigned this Sep 22, 2025
Copy link

codecov bot commented Sep 22, 2025

Bundle Report

Changes will increase total bundle size by 960 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 10.13MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 12.87MB 966 bytes (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
server/middleware-*.js 6.46kB 7.46kB 645.5% ⚠️
server/middleware-*.js -6.46kB 1.0kB -86.59%
static/2MbOsBZoXOy48Nim4jWW6/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/2MbOsBZoXOy48Nim4jWW6/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/xhCiGLnCakcwwMLfNybxs/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/xhCiGLnCakcwwMLfNybxs/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.78MB -0.0%
../instrumentation.js -3 bytes 1.1MB -0.0%
9523.js -3 bytes 1.08MB -0.0%
../app/[[...path]]/page.js.nft.json 325 bytes 826.42kB 0.04%
../app/platform-redirect/page.js.nft.json 325 bytes 826.33kB 0.04%
../app/sitemap.xml/route.js.nft.json 325 bytes 823.56kB 0.04%

Comment on lines 111 to 112
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.
Copy link
Member

@s1gr1d s1gr1d Sep 22, 2025

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."

Copy link
Member Author

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 :)

@Lms24 Lms24 changed the base branch from master to lms/feat-js-browser-reportPageLoaded September 22, 2025 15:53
@Lms24 Lms24 requested a review from s1gr1d September 23, 2025 09:01
@Lms24 Lms24 changed the title feat(js): Add documentation for setSpanActive(span: Span) feat(js): Add documentation for setActiveSpanInBrowser(span: Span) Sep 23, 2025
Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay! Looks good.

Base automatically changed from lms/feat-js-browser-reportPageLoaded to master September 25, 2025 08:11
@Lms24 Lms24 force-pushed the lms/feat-js-browser-setSpanActive branch from c71d55c to e016711 Compare September 26, 2025 16:30
@Lms24 Lms24 enabled auto-merge (squash) September 26, 2025 16:30
@Lms24 Lms24 merged commit 06a9927 into master Sep 26, 2025
13 checks passed
@Lms24 Lms24 deleted the lms/feat-js-browser-setSpanActive branch September 26, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants