feat(js): Add reportPageLoaded() documentation
#15006
Merged
+47
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Lms24
requested review from
a team,
chargome and
andreiborza
and removed request for
a team
Bundle ReportChanges will increase total bundle size by 10.03kB (0.04%) ⬆️. 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:
Files in
App Routes Affected:
|
6 tasks
coolguyzone
reviewed
Sep 23, 2025
coolguyzone
reviewed
Sep 23, 2025
| Signals to the Sentry SDK that the initial page was fully loaded. | ||
| Requires the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#enableReportPageLoaded">`enableReportPageLoaded` option</PlatformLink> in `browserTracingIntegration` to | ||
| be set to `true`. Once called, the SDK ends the pageload span explicitly. | ||
| By default, the SDK takes care of ending the pageload span automatically, based on |
There was a problem hiding this comment.
Suggested change
| By default, the SDK takes care of ending the pageload span automatically, based on | |
| based on |
There was a problem hiding this comment.
Not fully sure I get this suggestion correctly because the goal here was to explain what the SDK does by default (i.e. when reportPageLoaded() is not used). I think though it's better to join this sentence with the paragraph below instead (see #15006 (comment))
coolguyzone
approved these changes
Sep 23, 2025
Co-authored-by: Alex Krawiec <[email protected]>
Lms24
commented
Sep 24, 2025
Lms24
added a commit
that referenced
this pull request
Sep 26, 2025
…15007) <!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## 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.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] 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](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> 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 - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Shannon Anahata <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
This PR adds documentation for the new
reportPageLoaded()API which is coupled to the newenableReportPageLoadedoption in thebrowserTracingIntegration. Both have been added via getsentry/sentry-javascript#17724 and released in 10.13.0.Also added a new
availableSinceprop to theSdkApicomponent.closes https://linear.app/getsentry/issue/FE-607/docs-for-reportpageloaded
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