Skip to content

feat(js): Document how to disable tracing #14268

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

Merged
merged 3 commits into from
Jul 9, 2025
Merged

Conversation

mydea
Copy link
Member

@mydea mydea commented Jul 7, 2025

Closes #14267

This adds more explicit docs explaining how to disable tracing, as this sometimes is confusing for folks.

@mydea mydea requested review from Lms24, s1gr1d and a team July 7, 2025 10:43
@mydea mydea self-assigned this Jul 7, 2025
Copy link

vercel bot commented Jul 7, 2025

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 9, 2025 2:25pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 9, 2025 2:25pm

Copy link

codecov bot commented Jul 7, 2025

Bundle Report

Changes will decrease total bundle size by 14.2kB (-0.06%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.81MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.87MB -14.2kB (-0.12%) ⬇️

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 878.27kB -0.0%
static/chunks/1831-*.js -3 bytes 421.22kB -0.0%
static/BpOS1kXzMsgUXn9pIeOzL/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/BpOS1kXzMsgUXn9pIeOzL/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/0KRCRAGz7fdnSo7b_PlYi/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/0KRCRAGz7fdnSo7b_PlYi/_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.67MB -0.0%
../instrumentation.js -3 bytes 997.28kB -0.0%
9523.js -3 bytes 973.22kB -0.0%
../app/[[...path]]/page.js.nft.json -4.73kB 691.02kB -0.68%
../app/platform-redirect/page.js.nft.json -4.73kB 690.93kB -0.68%
../app/sitemap.xml/route.js.nft.json -4.73kB 688.9kB -0.68%

- <PlatformLink to="/tracing/instrumentation/">Instrumentation</PlatformLink>:
Find information about manual instrumentation with the Sentry SDK
- <PlatformLink to="/tracing/span-metrics/">Sending Span Metrics</PlatformLink>:
Learn how to capture metrics on your spans

## Disabling Tracing

If you want to disable tracing, you _should not_ set `tracesSampleRate` at
Copy link
Collaborator

Choose a reason for hiding this comment

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

On the options page we also say "Either this or tracesSampler must be defined to enable tracing." (where "this" refers to tracesSampleRate)

It would make sense to me to mention the tracesSampler option here too

mydea and others added 3 commits July 9, 2025 15:59
@mydea mydea merged commit ec4387d into master Jul 9, 2025
13 checks passed
@mydea mydea deleted the fn/docs-disable-tracing branch July 9, 2025 14:38
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.

Document how to disable tracing for Next.js
5 participants