Skip to content

feat(js): Add documentation for new browserTracingIntegration options #13943

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Jun 6, 2025

This PR adds documentation for new options available in browserTracingIntegration:

  • ignorePerformanceApiSpans
  • ignoreResourceSpans
  • onRequestSpanStart (this has been around for some time but we never documented it, oops)

Furthermore, I decided to give this page a little face lift by using the <SdkOption> component for a unified appearance of options. This also included adding a table row for "Available Since" to the <SdkOption> component, since a lot of these option descriptions previously used texts or alerts to specify the min SDK version.

Also made some minor adjustments to outdated documentation on related pages.

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

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 Jun 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 9:54am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 9:54am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jun 6, 2025 9:54am

@codeowner-assignment codeowner-assignment bot requested a review from a team June 6, 2025 09:18
@Lms24 Lms24 requested review from a team, AbhiPrasad, RulaKhaled and bcoe and removed request for a team June 6, 2025 09:20
Copy link

codecov bot commented Jun 6, 2025

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.22MB 136 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.77MB -6 bytes (-0.0%) ⬇️

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 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/ucsshNT36UE_M7LbGzaFt/_buildManifest.js (New) 616 bytes 616 bytes 100.0% 🚀
static/ucsshNT36UE_M7LbGzaFt/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/7ehbufhtx0AqKtzsIFH0i/_buildManifest.js (Deleted) -616 bytes 0 bytes -100.0% 🗑️
static/7ehbufhtx0AqKtzsIFH0i/_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.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
../app/[[...path]]/page.js 145 bytes 586.28kB 0.02%

Files in ../app/[[...path]]/page.js:

  • ./src/components/sdkOption.tsx → Total Size: 5.1kB

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 145 bytes 3.13MB 0.0%

@@ -38,3 +38,5 @@ Sentry.init({
integrations: [Sentry.browserTracingIntegration()],
});
```

See <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#configuration-options">Configuration Options</PlatformLink> for a full list of availalable options for `browserTracingIntegration`
Copy link
Member Author

Choose a reason for hiding this comment

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

kinda awkward that this page doesn't show the options. We can also think about moving all the options to this page from the tracing docs if reviewers prefer this.

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.

1 participant