feat(browserprofiling): Add manual mode and deprecate old profiling - #18189

Merged
s1gr1d merged 20 commits into
developfrom
sig/profiling-manual-mode
Nov 24, 2025
Merged

feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom
sig/profiling-manual-mode

Conversation

@s1gr1d

@s1gr1ds1gr1d commented Nov 12, 2025•
edited
Loading

Copy link
Copy Markdown
Member

Adds the manual mode for profiling and browser integration tests.

  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.

Closes#17279

@github-actions

github-actionsBot commented Nov 12, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽

View base workflow run

@github-actions

github-actionsBot commented Nov 14, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

node-overhead report 🧳

Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.

ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%

View base workflow run

s1gr1d
s1gr1d commented Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts Outdated
this._sessionSampled = sessionSampled;
this._lifecycleMode = lifecycleMode;

client.on('spanStart', span => {

@s1gr1ds1gr1dNov 17, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.

@s1gr1ds1gr1d mentioned this pull request Nov 17, 2025
Merged
s1gr1d added a commit that referenced this pull request Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d marked this pull request as ready for review November 17, 2025 13:29
cursor[bot]
cursorBot reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts Outdated
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts Outdated
s1gr1d
s1gr1d commented Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts

@s1gr1ds1gr1dNov 17, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)

cursor[bot]
cursorBot reviewed Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts Outdated
cursor[bot]
cursorBot reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot reviewed Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
// Trace: Profile context is kept as long as there is an active root span
if (this._lifecycleMode === 'manual') {
getGlobalScope().setContext('profile', {});
}

@cursorcursorBotNov 17, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.

In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.

Fix in CursorFix in Web

@s1gr1ds1gr1dNov 17, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.

Lms24
Lms24 reviewed Nov 17, 2025
View reviewed changes

@Lms24Lms24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!

Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Comment on lines +36 to +37
// In manual mode we start and stop once -> expect exactly one chunk
const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(

@Lms24Lms24Nov 17, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?

@s1gr1ds1gr1dNov 18, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk

Comment threadpackages/browser/src/profiling/integration.ts Outdated
const _browserProfilingIntegration = (() => {
return {
name: INTEGRATION_NAME,
_profiler: new UIProfiler(),

@Lms24Lms24Nov 17, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.

We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!

@s1gr1ds1gr1dNov 18, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.

cursor[bot]
cursorBot reviewed Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);

@cursorcursorBotNov 21, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle

The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.

Fix in CursorFix in Web

@s1gr1ds1gr1dNov 24, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The SDK will log a warning in this case

@s1gr1d
s1gr1d requested a review from Lms24November 24, 2025 08:45
Lms24
Lms24 approved these changes Nov 24, 2025
View reviewed changes

@Lms24Lms24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)

Comment threadpackages/browser/src/profiling/integration.ts
Comment on lines +55 to +57
// Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
client.on('startUIProfiler', () => profiler.start());
client.on('stopUIProfiler', () => profiler.stop());

@Lms24Lms24Nov 24, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice!

@s1gr1d
s1gr1d merged commit 1525603 into developNov 24, 2025
199 checks passed
@s1gr1d
s1gr1d deleted the sig/profiling-manual-mode branch November 24, 2025 13:59
@github-actionsgithub-actionsBot mentioned this pull request Nov 24, 2025
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)

2 participants

@s1gr1d@Lms24
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(browserprofiling): Add manual mode and deprecate old profiling - #18189
Merged
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Nov 24, 2025
Merged
feat(browserprofiling): Add manual mode and deprecate old profiling#18189
s1gr1d merged 20 commits into
developfrom 
sig/profiling-manual-mode
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Member
Adds the manual mode for profiling and browser integration tests.
  • adds deprecation note for old option
  • adds some JSDoc comments to public-facing API to make the difference between Node and UI profiling better visible.
Closes#17279
@github-actions
github-actionsBot
commented
Nov 12, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser24.78 kB--
@sentry/browser - with treeshaking flags23.27 kB--
@sentry/browser (incl. Tracing)41.51 kB--
@sentry/browser (incl. Tracing, Profiling)46.1 kB+0.59%+269 B 🔺
@sentry/browser (incl. Tracing, Replay)79.92 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags69.65 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)84.6 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)96.85 kB--
@sentry/browser (incl. Feedback)41.45 kB--
@sentry/browser (incl. sendFeedback)29.46 kB--
@sentry/browser (incl. FeedbackAsync)34.4 kB--
@sentry/react26.49 kB--
@sentry/react (incl. Tracing)43.51 kB--
@sentry/vue29.22 kB--
@sentry/vue (incl. Tracing)43.31 kB--
@sentry/svelte24.79 kB--
CDN Bundle27.14 kB+0.2%+52 B 🔺
CDN Bundle (incl. Tracing)42.14 kB+0.16%+64 B 🔺
CDN Bundle (incl. Tracing, Replay)78.67 kB+0.11%+79 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback)84.13 kB+0.07%+53 B 🔺
CDN Bundle - uncompressed79.71 kB+0.32%+249 B 🔺
CDN Bundle (incl. Tracing) - uncompressed125.08 kB+0.2%+249 B 🔺
CDN Bundle (incl. Tracing, Replay) - uncompressed241.11 kB+0.11%+249 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed253.87 kB+0.1%+249 B 🔺
@sentry/nextjs (client)45.93 kB--
@sentry/sveltekit (client)41.87 kB--
@sentry/node-core51.15 kB-0.01%-1 B 🔽
@sentry/node159.46 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.02 kB-0.01%-1 B 🔽
@sentry/aws-serverless106.78 kB-0.01%-1 B 🔽
View base workflow run
@github-actions
github-actionsBot
commented
Nov 14, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
node-overhead report 🧳
Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
ScenarioRequests/s% of BaselinePrev. Requests/sChange %
GET Baseline8,859-8,762+1%
GET With Sentry1,79920%1,719+5%
GET With Sentry (error only)6,22670%6,107+2%
POST Baseline1,223-1,194+2%
POST With Sentry61450%593+4%
POST With Sentry (error only)1,08288%1,073+1%
MYSQL Baseline3,355-3,366-0%
MYSQL With Sentry52216%470+11%
MYSQL With Sentry (error only)2,73281%2,717+1%
View base workflow run
s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

 this._sessionSampled = sessionSampled;
 this._lifecycleMode = lifecycleMode;

 client.on('spanStart', span => {
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The client.on calls (spanStart, spanEnd) are now added in the _setupTraceLifecycleListeners function.
@s1gr1ds1gr1d
mentioned this pull request
Nov 17, 2025
 Merged

s1gr1d added a commit
that referenced
this pull request
Nov 17, 2025
@s1gr1d
ref(browser): Move trace lifecycle listeners to class function (#18231)
5a5e091
This PR was factored out of another PR to make reviewing easier. The
other PR: #18189
Moved the `spanStart` and `spanEnd` listeners into an extra function
(`_setupTraceLifecycleListeners`) to be able to only call it depending
on the lifecycle (used in another PR).
Part of #17279
@s1gr1d
Merge branch 'develop' into sig/profiling-manual-mode
373a1ed
# Conflicts:
#	packages/browser/src/profiling/UIProfiler.ts
@s1gr1d
s1gr1d
marked this pull request as ready for review
November 17, 2025 13:29
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Outdated

Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

s1gr1d
s1gr1d
commented
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/index.ts
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

This file is similar to the Node profiling one: packages/core/src/profiling.ts (can be seen at the end of this diff page)
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
Outdated

cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
Comment threadpackages/browser/src/profiling/UIProfiler.ts
cursor[bot]
cursorBot
reviewed
Nov 17, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/UIProfiler.ts
 // Trace: Profile context is kept as long as there is an active root span
 if (this._lifecycleMode === 'manual') {
 getGlobalScope().setContext('profile', {});
 }
@cursorcursorBotNov 17, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiling state leaks after trace completion.
In trace mode, when _endProfiling is called after the last root span ends, the profile context is not cleared. The condition if (this._lifecycleMode === 'manual') prevents clearing the context in trace mode, but when there are no active root spans (which is when _endProfiling is called from spanEnd), the context should be cleared to prevent subsequent transactions from being incorrectly marked as profiled. The profile context persists even though profiling has stopped, causing spans created after profiling ends to incorrectly appear as profiled.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 17, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The profiler context will stay the same for the whole profiling session as the profiler cannot be just stopped like in manual profiling, where there might be spans that are not profiled anymore.
Lms24
Lms24
reviewed
Nov 17, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice work! Had one thought about the public API <> integration interaction but otherwise LGTM!
Comment threaddev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

Comment on lines

+36
 to 
+37

 // In manual mode we start and stop once -> expect exactly one chunk
 const profileChunkEnvelopes = await getMultipleSentryEnvelopeRequests<ProfileChunkEnvelope>(
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: the code suggests we get two envelopes/chunks. Should we update/remove the comment?
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

oh good that you spot that! A leftover from when I only tested it with one chunk
Comment threadpackages/browser/src/profiling/integration.ts
Outdated

const _browserProfilingIntegration = (() => {
 return {
 name: INTEGRATION_NAME,
 _profiler: new UIProfiler(),
@Lms24Lms24Nov 17, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l/m: In case the CDN bundle tests fail, this is likely the reason why: _profiler is mangled by our terser config (makeTerserPlugin()) because it is not excluded from the ignore list of private properties.
We can either opt out of mangling this field, make it "public" (i.e. remove the leading underscore), or add client hooks instead of exposing any additional field. I'd personally prefer using client hooks because it makes the binding very loose and also removes the need for the isProfilingIntegrationWithProfiler type predicate. Happy to leave this up to you though!
@s1gr1ds1gr1dNov 18, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I used the approach from node-profiling here for consistency, but that's a very valid reason to use a different approach. I'm gonna add client hooks.
cursor[bot]
cursorBot
reviewed
Nov 21, 2025
View reviewed changes
Comment threadpackages/browser/src/profiling/integration.ts
 const laterRootSpan = laterActiveSpan && getRootSpan(laterActiveSpan);
 if (laterRootSpan) {
traceLifecycleProfiler.notifyRootSpanActive(laterRootSpan);
profiler.notifyRootSpanActive(laterRootSpan);
@cursorcursorBotNov 21, 2025

Copy link


Copy Markdown

Choose a reason for hiding this comment

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

Bug: Profiler hooks registered without initialization for invalid lifecycle
The profiler hooks startUIProfiler and stopUIProfiler are registered before checking if the lifecycle mode is valid. If profileLifecycle is set to an invalid value (not 'manual' or 'trace'), the hooks get registered but profiler.initialize() is never called. This causes the profiler to be in an uninitialized state when users call uiProfiler.startProfiler() or uiProfiler.stopProfiler(), leading to undefined behavior since _lifecycleMode, _sessionSampled, and other fields remain undefined.
Fix in CursorFix in Web
@s1gr1ds1gr1dNov 24, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

The SDK will log a warning in this case
@s1gr1d
s1gr1d
requested a review
from Lms24November 24, 2025 08:45
Lms24
Lms24
approved these changes
Nov 24, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Thanks for making the hooks-based changes! :)
Comment threadpackages/browser/src/profiling/integration.ts

Comment on lines

+55
 to 
+57

 // Registering hooks in all lifecycle modes to be able to notify users in case they want to start/stop the profiler manually in `trace` mode
 client.on('startUIProfiler', () => profiler.start());
 client.on('stopUIProfiler', () => profiler.stop());
@Lms24Lms24Nov 24, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

nice!
@s1gr1d
s1gr1d
merged commit 1525603
into
developNov 24, 2025

199 checks passed

@s1gr1d
s1gr1d
deleted the

sig/profiling-manual-mode

branch
November 24, 2025 13:59
@github-actionsgithub-actionsBot
mentioned this pull request
Nov 24, 2025

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cursorcursor[bot]cursor[bot] left review comments
@Lms24Lms24Lms24 approved these changes
@JPeer264JPeer264Awaiting requested review from JPeer264
@andreiborzaandreiborzaAwaiting requested review from andreiborza

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[Browser]: Implement new Profiling API spec (UI Profiling)


2 participants

@s1gr1d@Lms24