docs(profiling): Add docs for Profiling API #15258
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.
1 Skipped Deployment
|
indragiek
approved these changes
Oct 20, 2025
| The definition of a profiling session depends on the profiling type: | ||
|
|
||
| - **Continuous Profiling**: The session starts when the Sentry SDK is configured and stops when the service terminates. `profile_session_sample_rate` controls the percentage of service instances that have profiling enabled. Sampling is re-evaluated on service restart or redeployment. | ||
| - **UI Profiling**: The session corresponds to a user session. A user session starts with a new SDK initialization and ends when the tab is closed or like a [Replay session](/product/explore/session-replay/web/) ends. `profile_session_sample_rate` sets the percentage of user sessions for which profiling is enabled. So this sampling decision is made once on SDK initialization. |
There was a problem hiding this comment.
there's a grammar issue here "ends when the tab is closed or like a Replay session ends"
coolguyzone
reviewed
Oct 21, 2025
| The definition of a profiling session depends on the profiling type: | ||
|
|
||
| - **Continuous Profiling**: The session starts when the Sentry SDK is configured and stops when the service terminates. `profile_session_sample_rate` controls the percentage of service instances that have profiling enabled. Sampling is re-evaluated on service restart or redeployment. | ||
| - **UI Profiling**: The session corresponds to a user session. A user session starts with a new SDK initialization and ends when the tab is closed or like a [Replay session](/product/explore/session-replay/web/) ends. `profile_session_sample_rate` sets the percentage of user sessions for which profiling is enabled. So this sampling decision is made once on SDK initialization. |
There was a problem hiding this comment.
Suggested change
| - **UI Profiling**: The session corresponds to a user session. A user session starts with a new SDK initialization and ends when the tab is closed or like a [Replay session](/product/explore/session-replay/web/) ends. `profile_session_sample_rate` sets the percentage of user sessions for which profiling is enabled. So this sampling decision is made once on SDK initialization. | |
| - **UI Profiling**: The session corresponds to a user session. A user session starts with a new SDK initialization and ends when the tab is closed or a [Replay session](/product/explore/session-replay/web/) ends. `profile_session_sample_rate` sets the percentage of user sessions for which profiling is enabled. So this sampling decision is made once on SDK initialization. |
There was a problem hiding this comment.
I wrote it a bit differently, as I wanted to say that it can end "like" a replay session. But the wording was indeed weird :D
A user session starts with a new SDK initialization. It ends when the browser tab is closed, or alternatively, under the same conditions that end a Replay session.
coolguyzone
reviewed
Oct 21, 2025
|
|
||
| ## Public API | ||
|
|
||
| The SDK should expose the following functions to control the profiler. |
There was a problem hiding this comment.
Suggested change
| The SDK should expose the following functions to control the profiler. | |
| The SDK should expose the following functions to control the profiler: |
codyde
added a commit
that referenced
this pull request
Oct 27, 2025
…s-examples * origin/master: (478 commits) docs(godot): Structured logging (#15287) fix(batch-processor): Don't enforce starting timer (#15309) feat(node): Add new options to nativeNodeFetchIntegration (#15282) Updated dotnet options to include all defaults (#15218) ref: add docs that logs channel is optional (#15172) docs(svelteKit): Update build-time options for source maps (#15283) fix(python): Fix paragraph order in Strawberry docs (#15301) Added docs explaining how to disable Sentry Native in the .NET SDK (#15293) Updated Unity options with missing defaults (#15219) docs(otlp): Update docs for client SDK w3c traceparent support (#15294) Adding defaults for Godot options (#15216) feat(crons): Document broken monitors feature (#15280) fix: Remove OTLP logs from EA list (#15288) Bump API schema to 06047b60 (#15276) ref(nextjs): Move manual instrumentation examples for ai into Edge section (#15284) docs(otlp): change status to open beta (#15285) Hono runtime and middleware doc updates (#14853) feat(logs): Clarify API for Hub/Scope and Client (#15281) docs(astro/nuxt): Remove `sourceMapsUploadOptions` option nesting (#14905) docs(profiling): Add docs for Profiling API (#15258) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Add docs for Profiling API based on those Notion docs: https://www.notion.so/sentry/Continuous-UI-Profiling-SDK-API-Spec-17e8b10e4b5d80c59a40c6e114470934?source=copy_link
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: