-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
base: master
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 130 bytes (0.0%) ⬆️. 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:
|
@@ -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` |
There was a problem hiding this comment.
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.
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.
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