docs(profiling): Add docs for UI profiling (Browser JS) #15611
Merged
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.
|
AbhiPrasad
approved these changes
Nov 24, 2025
|
|
||
| <SdkOption name="profileSessionSampleRate" type='number'> | ||
|
|
||
| A number between `0` and `1` that sets the percentage of how many sessions should have profiling enabled. `1.0` enables profiling in every session, `0.5` enables profiling for 50% of the sessions, and `0` enables it for none. The sampling decision is made once at the beginning of a session. This option is required to enable profiling. |
Member
There was a problem hiding this comment.
I wonder if we should include a minimum version note for these options.
Collaborator
There was a problem hiding this comment.
Yes, I also think that would be helpful information to provide
Bundle ReportChanges will increase total bundle size by 55.78kB (0.24%) ⬆️. 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:
|
inventarSarah
approved these changes
Nov 25, 2025
Collaborator
inventarSarah
left a comment
inventarSarah
left a comment
There was a problem hiding this comment.
Looks great, thank you 🍪
|
|
||
| ## Profiling Modes | ||
|
|
||
| Profiling supports two modes - `manual` and `trace`. The two modes are mutually exclusive, and cannot be used at the same time. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Profiling supports two modes - `manual` and `trace`. The two modes are mutually exclusive, and cannot be used at the same time. | |
| Profiling supports two modes: `manual` and `trace`. These modes are mutually exclusive and cannot be used at the same time. |
|
|
||
| Profiling supports two modes - `manual` and `trace`. The two modes are mutually exclusive, and cannot be used at the same time. | ||
|
|
||
| In `manual` mode, the profiling data collection can be managed via calls to `Sentry.uiProfiler.startProfiler` and `Sentry.uiProfiler.stopProfiler`. You are entirely in the in control of when the profiler runs. |
Collaborator
There was a problem hiding this comment.
Suggested change
| In `manual` mode, the profiling data collection can be managed via calls to `Sentry.uiProfiler.startProfiler` and `Sentry.uiProfiler.stopProfiler`. You are entirely in the in control of when the profiler runs. | |
| In `manual` mode, you can manage the profiling data collection via calls to `Sentry.uiProfiler.startProfiler` and `Sentry.uiProfiler.stopProfiler`. You have full control over when the profiler runs. |
|
|
||
| In `manual` mode, the profiling data collection can be managed via calls to `Sentry.uiProfiler.startProfiler` and `Sentry.uiProfiler.stopProfiler`. You are entirely in the in control of when the profiler runs. | ||
|
|
||
| In `trace` mode, the profiler manages its own start and stop calls, which are based on spans: the profiler continues to run while there is at least one active span, and stops when there are no active spans. |
Collaborator
There was a problem hiding this comment.
Suggested change
| In `trace` mode, the profiler manages its own start and stop calls, which are based on spans: the profiler continues to run while there is at least one active span, and stops when there are no active spans. | |
| In `trace` mode, the profiler manages its own start and stop calls based on spans. It continues to run while at least one span is active, and stops when there are no active spans. |
| - Profiling respects **both** `profile_session_sample_rate` and the tracing sampling configuration (`traces_sample_rate` or `traces_sampler`). | ||
| - `profile_session_sample_rate` is checked first. If the session is not sampled, no profiling will occur. | ||
| - If the session is sampled, `traces_sample_rate` / `traces_sampler` is evaluated for each root span to determine if it should be profiled. | ||
| - Only if a root span is sampled (this is based on `traces_sample_rate` / `traces_sampler`), profiling will start. Therefore, profile sampling is re-evaluated on each root span. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Only if a root span is sampled (this is based on `traces_sample_rate` / `traces_sampler`), profiling will start. Therefore, profile sampling is re-evaluated on each root span. | |
| - Only if a root span is sampled (this is based on `traces_sample_rate` / `traces_sampler`), profiling will start. Therefore, profile sampling is re-evaluated for each root span. |
|
|
||
| <SdkOption name="profileSessionSampleRate" type='number'> | ||
|
|
||
| A number between `0` and `1` that sets the percentage of how many sessions should have profiling enabled. `1.0` enables profiling in every session, `0.5` enables profiling for 50% of the sessions, and `0` enables it for none. The sampling decision is made once at the beginning of a session. This option is required to enable profiling. |
Collaborator
There was a problem hiding this comment.
Yes, I also think that would be helpful information to provide
| <SdkOption name="profilesSampleRate" type='number'> | ||
|
|
||
| A number between `0` and `1`, controlling the percentage chance a given sampled transaction will be profiled. (`0` represents 0% while `1` represents 100%.) Applies equally to all transactions created in the app. This is relative to the tracing sample rate - e.g. `0.5` means 50% of sampled transactions will be profiled. | ||
| **Deprecated:** Use `profileSessionSampleRate` instead to configure continuous profiling. |
Collaborator
There was a problem hiding this comment.
If we add a minimum version note above, we could also add the version here
| // For example, a tracesSampleRate of 0.5 and profilesSampleRate of 0.5 would | ||
| // result in 25% of transactions being profiled (0.5*0.5=0.25) | ||
| profilesSampleRate: 1.0, | ||
| // Set profileSessionSampleRate to 1.0 to enable profiling during every user session. |
Collaborator
There was a problem hiding this comment.
Here we only have one comment line -- the other SDKs have two. Not sure if this is on purpose :)
philipphofmann
pushed a commit
that referenced
this pull request
Nov 28, 2025
## DESCRIBE YOUR PR Adds docs for the new UI Profiling APIs in the browser. part of getsentry/sentry-javascript#17279 ## 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)
philprime
pushed a commit
that referenced
this pull request
Nov 28, 2025
## DESCRIBE YOUR PR Adds docs for the new UI Profiling APIs in the browser. part of getsentry/sentry-javascript#17279 ## 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)
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
Adds docs for the new UI Profiling APIs in the browser.
part of getsentry/sentry-javascript#17279
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: