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 ❌ Failed (Inspect) Jun 13, 2025 3:34pm
sentry-docs ❌ Failed (Inspect) Jun 13, 2025 3:34pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jun 13, 2025 3:34pm

@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 426.46kB (2.03%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.32MB 405.76kB (3.72%) ⬆️
sentry-docs-edge-server-array-push 381.81kB 10.44kB (2.81%) ⬆️
sentry-docs-client-array-push 9.78MB 10.27kB (0.11%) ⬆️

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 -1.26kB 871.98kB -0.14%
static/chunks/2828-*.js (New) 413.36kB 413.36kB 100.0% 🚀
server/app/api/ip-*.js 2 bytes 258.49kB 0.0%
server/app/_not-*.js 2 bytes 258.48kB 0.0%
server/app/[[...path]]/page_client-*.js 2 bytes 258.44kB 0.0%
server/app/platform-*.js 2 bytes 243.98kB 0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/chunks/pages/_error-*.js -3 bytes 2.64kB -0.11%
static/12_n2iXs3Is_1ZkZ8VMUC/_buildManifest.js (New) 616 bytes 616 bytes 100.0% 🚀
static/12_n2iXs3Is_1ZkZ8VMUC/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/chunks/7750-*.js (Deleted) -401.83kB 0 bytes -100.0% 🗑️
static/DlK6avAYR7I-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
static/DlK6avAYR7I-*.js (Deleted) -616 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js 135.21kB 1.78MB 8.23% ⚠️
../instrumentation.js 135.2kB 1.11MB 13.89% ⚠️
9523.js 135.18kB 1.08MB 14.24% ⚠️
../app/[[...path]]/page.js 148 bytes 587.64kB 0.03%
8049.js 3 bytes 520.29kB 0.0%
4217.js 1 bytes 191.77kB 0.0%
9273.js 1 bytes 83.11kB 0.0%
1419.js 1 bytes 57.65kB 0.0%
5103.js 1 bytes 37.06kB 0.0%
5207.js 1 bytes 32.21kB 0.0%
../app/platform-redirect/page.js 1 bytes 31.36kB 0.0%
2638.js 1 bytes 26.24kB 0.0%
8327.js 2 bytes 11.9kB 0.02%
8440.js 2 bytes 11.84kB 0.02%
4846.js 1 bytes 1.16kB 0.09%
5225.js 1 bytes 1.16kB 0.09%
678.js 1 bytes 1.15kB 0.09%

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

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

App Routes Affected:

App Route Size Change Total Size Change (%)
/ 14 bytes 2.61MB 0.0%
/platform-redirect 15 bytes 2.58MB 0.0%
/[[...path]] 162 bytes 3.14MB 0.01%
view changes for bundle: sentry-docs-edge-server-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
src/middleware.js -458 bytes 206.91kB -0.22%
edge-instrumentation.js 10.89kB 165.46kB 7.05% ⚠️

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

Copy link
Member

Choose a reason for hiding this comment

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

I think this link is fine.

@@ -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

Choose a reason for hiding this comment

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

I think this link is fine.

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.

2 participants