feat(react-router): Add support for React Router instrumentation API - #18580

Merged
chargome merged 19 commits into
developfrom
react-router-8-instrumentation-api
Jan 26, 2026
Merged

feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom
react-router-8-instrumentation-api

Conversation

@onurtemizkan

@onurtemizkanonurtemizkan commented Dec 19, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.

Resolves: #18127
Resolves: #18121
Ref: remix-run/react-router#13749
Ref: remix-run/react-router#14412

React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.

Server-side

Added createSentryServerInstrumentation():

  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];

Client-side

Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):

  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>

Backward compatibility

When the instrumentation API is used:

  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped

Also:

  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation

Notes

  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.

Docs: getsentry/sentry-docs#16171

@onurtemizkan
onurtemizkanforce-pushed the react-router-8-instrumentation-api branch from ad33e6c to e8d11d1CompareDecember 22, 2025 10:04
CopilotAI reviewed Dec 22, 2025
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).

Key Changes:

  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage

Reviewed changes

Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.

Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx Outdated
Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx Outdated
CopilotAI reviewed Dec 22, 2025
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@onurtemizkan
onurtemizkanforce-pushed the react-router-8-instrumentation-api branch from 883f798 to 75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan marked this pull request as ready for review December 23, 2025 10:36
sentry[bot]
sentryBot reviewed Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Comment on lines +45 to +49

return {
router(router: InstrumentableRouter) {
router.instrument({
async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view

cursor[bot]
cursorBot reviewed Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts Outdated
sentry[bot]
sentryBot reviewed Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan mentioned this pull request Dec 23, 2025
Merged
cursor[bot]
cursorBot reviewed Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions

github-actionsBot commented Dec 23, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--

View base workflow run

@github-actions

github-actionsBot commented Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%

View base workflow run

Lms24 pushed a commit that referenced this pull request Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI reviewed Dec 29, 2025
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadpackages/react-router/src/server/createServerInstrumentation.ts Outdated
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot reviewed Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome approved these changes Jan 8, 2026
View reviewed changes

@chargomechargome 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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!

Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Comment on lines +37 to +41
/**
* Whether to capture errors from loaders/actions automatically.
* @default true
*/
captureErrors?: boolean;

@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?

@onurtemizkanonurtemizkanJan 8, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.

Comment threadpackages/react-router/src/client/createClientInstrumentation.ts Outdated
Comment on lines +104 to +111
// navigate(0) triggers a page reload - skip span creation
if (info.to === 0) {
const result = await callNavigate();
captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
'http.url': info.currentUrl,
});
return;
}

@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?

@onurtemizkanonurtemizkanJan 8, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍

Comment threadpackages/react-router/src/server/createServerInstrumentation.ts Outdated
Comment on lines +131 to +134
captureInstrumentationError(result, captureErrors, 'react_router.loader', {
'http.method': info.request.method,
'http.url': urlPath,
});

@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?

@onurtemizkanonurtemizkanJan 8, 2026

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Updated all uses of this 👍

sentry[bot]
sentryBot reviewed Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts Outdated
// (navigation can be rejected before reload, e.g., by a navigation guard)
if (info.to === 0) {
const result = await callNavigate();
captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view

cursor[bot]
cursorBot reviewed Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome merged commit 75f0e20 into developJan 26, 2026
41 checks passed
@chargome
chargome deleted the react-router-8-instrumentation-api branch January 26, 2026 14:24
This was referenced Jan 27, 2026
Closed
Closed
@onurtemizkanonurtemizkan mentioned this pull request Jan 27, 2026
Merged
6 tasks
s1gr1d pushed a commit to getsentry/sentry-docs that referenced this pull request Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit to getsentry/sentry-docs that referenced this pull request Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan mentioned this pull request Feb 18, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support Instrumentation API React Router Instrumentation

3 participants

@onurtemizkan@chargome
, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome

, '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(react-router): Add support for React Router instrumentation API - #18580
Merged
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Jan 26, 2026
Merged
feat(react-router): Add support for React Router instrumentation API#18580
chargome merged 19 commits into
developfrom 
react-router-8-instrumentation-api
Conversation
@onurtemizkan
@onurtemizkanonurtemizkan
commented
Dec 19, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
Adds support for React Router's unstable_instrumentations API for automatic performance monitoring.
Resolves: #18127
Resolves: #18121

Ref: remix-run/react-router#13749

Ref: remix-run/react-router#14412
React Router 7.9.5 introduced the unstable_instrumentations API, which provides hooks for instrumenting request handlers, loaders, actions, middleware, and lazy routes. This enables automatic span creation without requiring manual wrapper functions.
Server-side
Added createSentryServerInstrumentation():
  • handler.request - Creates root HTTP server span with parameterized route names
  • route.loader - Automatic loader span creation
  • route.action - Automatic action span creation
  • route.middleware - Automatic middleware span creation
  • route.lazy - Lazy route loading spans
// entry.server.tsximport*asSentryfrom'@sentry/react-router';exportdefaultSentry.createSentryHandleRequest({/* ... */});exportconsthandleError=Sentry.createSentryHandleError();exportconstunstable_instrumentations=[Sentry.createSentryServerInstrumentation()];
Client-side
Added client instrumentation via reactRouterTracingIntegration({ useInstrumentationAPI: true }):
  • router.navigate - Navigation transaction creation
  • router.fetch - Fetcher span creation
  • route.loader/action/middleware/lazy - Client-side route handler spans
// entry.client.tsxconsttracing=Sentry.reactRouterTracingIntegration({useInstrumentationAPI: true});Sentry.init({integrations: [tracing],});<HydratedRouterunstable_instrumentations={[tracing.clientInstrumentation]}/>
Backward compatibility
When the instrumentation API is used:
  • wrapServerLoader and wrapServerAction skip creating spans and emit a warning in debug mode
  • Legacy navigation patching in instrumentHydratedRouter checks if instrumentation API handled it
  • Server-side OTEL instrumentation for loaders/actions is skipped
Also:
  • Created serverGlobals.ts to isolate flag handling (avoids pulling OpenTelemetry deps in Cloudflare builds)
  • Updated wrapSentryHandleRequest to explicitly set parameterized transaction names (improves Hydrogen parameterization)
  • Added E2E test application react-router-7-framework-instrumentation
Notes
  • Client-side limitation: As of React Router 7.x, HydratedRouter does not invoke client instrumentation hooks in Framework Mode. Client-side navigation is handled by existing instrumentHydratedRouter(). The client instrumentation is prepared for when React Router adds support. See Observability: Server-side instrumentation remix-run/react-router#13749.
  • Lazy routes limitation: In Framework Mode, route.lazy hooks are not triggered because the bundler handles code-splitting.
Docs: getsentry/sentry-docs#16171
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
ad33e6c to
e8d11d1CompareDecember 22, 2025 10:04
CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
This PR adds comprehensive support for React Router's instrumentation API, enabling automatic performance monitoring and error tracking for React Router v7.x applications. The implementation provides both server-side and client-side instrumentation that integrates with React Router's unstable_instrumentations API (planned to become stable in v8).
Key Changes:
  • Server and client instrumentation API implementations with automatic span creation for loaders, actions, middleware, and lazy routes
  • Backward compatibility mechanisms to prevent duplicate instrumentation when using both legacy wrappers and the new API
  • Comprehensive E2E test application demonstrating real-world usage
Reviewed changes
Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
FileDescription
packages/react-router/src/server/createServerInstrumentation.tsNew server instrumentation implementation with handler and route hooks
packages/react-router/src/client/createClientInstrumentation.tsNew client instrumentation implementation for router navigation and route handlers
packages/react-router/src/common/utils.tsShared utility functions for URL parsing, pattern extraction, and error capture
packages/react-router/src/common/types.tsTypeScript type definitions for React Router's instrumentation API
packages/react-router/src/server/serverGlobals.tsGlobal flag management to detect instrumentation API usage
packages/react-router/src/server/wrapServerLoader.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapServerAction.tsUpdated to skip instrumentation when API is active, with deprecation warning
packages/react-router/src/server/wrapSentryHandleRequest.tsEnhanced to work alongside instrumentation API, preserving origin attributes
packages/react-router/src/client/tracingIntegration.tsExtended with lazy-loaded clientInstrumentation getter and options support
packages/react-router/src/client/hydratedRouter.tsUpdated to avoid double-counting navigation when API handles it
packages/react-router/src/server/integration/reactRouterServer.tsUpdated to skip OTEL patching when instrumentation API is used
packages/react-router/src/server/instrumentation/reactRouter.tsUpdated to skip OTEL instrumentation for loaders/actions when API is active
packages/react-router/test/server/createServerInstrumentation.test.tsComprehensive unit tests for server instrumentation API
packages/react-router/test/client/createClientInstrumentation.test.tsComprehensive unit tests for client instrumentation API
packages/react-router/test/common/utils.test.tsUnit tests for shared utility functions
dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/*Complete E2E test application with performance and error tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread.../test-applications/react-router-7-framework-instrumentation/app/routes/performance/index.tsx
Comment thread...plications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx
Outdated

Comment thread...ges/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx
Outdated

CopilotAI
reviewed
Dec 22, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 55 out of 55 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
@onurtemizkan
onurtemizkanforce-pushed
the
react-router-8-instrumentation-api
branch
from
883f798 to
75374f3CompareDecember 23, 2025 10:36
@onurtemizkan
onurtemizkan
marked this pull request as ready for review
December 23, 2025 10:36
sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+45
 to 
+49


 return {
 router(router: InstrumentableRouter) {
 router.instrument({
 async navigate(callNavigate, info) {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

sentry[bot]
sentryBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@onurtemizkanonurtemizkan
mentioned this pull request
Dec 23, 2025
 Merged

cursor[bot]
cursorBot
reviewed
Dec 23, 2025
View reviewed changes
Comment threadpackages/react-router/src/common/utils.ts
@github-actions
github-actionsBot
commented
Dec 23, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
⚠️Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.
PathSize% ChangeChange
@sentry/browser25.32 kB--
@sentry/browser - with treeshaking flags23.83 kB--
@sentry/browser (incl. Tracing)42.14 kB--
@sentry/browser (incl. Tracing, Profiling)46.78 kB--
@sentry/browser (incl. Tracing, Replay)80.75 kB--
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags70.4 kB--
@sentry/browser (incl. Tracing, Replay with Canvas)85.47 kB--
@sentry/browser (incl. Tracing, Replay, Feedback)97.65 kB--
@sentry/browser (incl. Feedback)42.04 kB--
@sentry/browser (incl. sendFeedback)30.01 kB--
@sentry/browser (incl. FeedbackAsync)35.01 kB--
@sentry/browser (incl. Metrics)26.43 kB--
@sentry/browser (incl. Logs)26.57 kB--
@sentry/browser (incl. Metrics & Logs)27.24 kB--
@sentry/react27.05 kB--
@sentry/react (incl. Tracing)44.37 kB+0.01%+2 B 🔺
@sentry/vue29.76 kB--
@sentry/vue (incl. Tracing)43.93 kB--
@sentry/svelte25.33 kB--
CDN Bundle27.89 kB--
CDN Bundle (incl. Tracing)42.93 kB--
CDN Bundle (incl. Tracing, Logs, Metrics)43.75 kB--
CDN Bundle (incl. Tracing, Replay)79.68 kB--
CDN Bundle (incl. Tracing, Replay, Feedback)85.11 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics)86.03 kB--
CDN Bundle - uncompressed81.6 kB--
CDN Bundle (incl. Tracing) - uncompressed127.14 kB--
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed129.97 kB--
CDN Bundle (incl. Tracing, Replay) - uncompressed243.74 kB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed256.54 kB--
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed259.35 kB--
@sentry/nextjs (client)46.73 kB--
@sentry/sveltekit (client)42.51 kB--
@sentry/node-core52.02 kB--
@sentry/node165.74 kB-0.01%-1 B 🔽
@sentry/node - without tracing93.79 kB--
@sentry/aws-serverless109.31 kB--
View base workflow run
@github-actions
github-actionsBot
commented
Dec 23, 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,622-10,769-20%
GET With Sentry1,72320%1,658+4%
GET With Sentry (error only)5,94569%7,175-17%
POST Baseline1,182-1,061+11%
POST With Sentry59650%491+21%
POST With Sentry (error only)1,03588%961+8%
MYSQL Baseline3,292-3,653-10%
MYSQL With Sentry44614%403+11%
MYSQL With Sentry (error only)2,68382%2,915-8%
View base workflow run
Lms24 pushed a commit
that referenced
this pull request
Dec 29, 2025
@onurtemizkan
ref(react-router): Use snake_case for span op names (#18617)
8787a87
This came up while working on #18580
The span ops should be using snake_case as per our spec:
https://develop.sentry.dev/sdk/telemetry/traces/span-operations/
@onurtemizkan
Merge remote-tracking branch 'origin/develop' into react-router-8-ins…
9b756ae
…trumentation-api
# Conflicts:
#	packages/react-router/src/server/wrapServerAction.ts
#	packages/react-router/src/server/wrapServerLoader.ts
@onurtemizkan
Prevent Framework Mode navigation span regression
0c84709
CopilotAI
reviewed
Dec 29, 2025
View reviewed changes
CopilotAI
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Pull request overview
Copilot reviewed 59 out of 59 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated

Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
Comment thread...cations/react-router-7-framework-instrumentation/tests/performance/navigation.client.test.ts
cursor[bot]
cursorBot
reviewed
Dec 30, 2025
View reviewed changes
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
chargome
chargome
approved these changes
Jan 8, 2026
View reviewed changes
@chargomechargome
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.

That's great! We just need a good way of documenting the client-side setup as this could be prone to errors. Let's also modify the wizard right away once this is released!
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts

Comment on lines

+37
 to 
+41

 /**
 * Whether to capture errors from loaders/actions automatically.
 * @default true
 */
 captureErrors?: boolean;
@chargomechargomeJan 8, 2026

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.

Why would we need to opt out here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This is just here to be able to prevent duplication if there is custom error handling defined elsewhere.
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated


Comment on lines

+104
 to 
+111

 // navigate(0) triggers a page reload - skip span creation
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {
 'http.url': info.currentUrl,
 });
 return;
 }
@chargomechargomeJan 8, 2026

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.

Why does this trigger an error? Could you add a comment why we need to capture here?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This had internal guards to conditionally capture errors from result objects. Updated the uses to extract the error guards so it's more readable now 👍
Comment threadpackages/react-router/src/server/createServerInstrumentation.ts
Outdated


Comment on lines

+131
 to 
+134

 captureInstrumentationError(result, captureErrors, 'react_router.loader', {
 'http.method': info.request.method,
 'http.url': urlPath,
 });
@chargomechargomeJan 8, 2026

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.

Shouldn't this be inside the if statement above?
@onurtemizkanonurtemizkanJan 8, 2026

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Updated all uses of this 👍
sentry[bot]
sentryBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
Outdated

 // (navigation can be rejected before reload, e.g., by a navigation guard)
 if (info.to === 0) {
 const result = await callNavigate();
 captureInstrumentationError(result, captureErrors, 'react_router.navigate', {

This comment was marked as outdated.

Sign in to view
cursor[bot]
cursorBot
reviewed
Jan 8, 2026
View reviewed changes
Comment threadpackages/react-router/src/client/createClientInstrumentation.ts
@chargome
chargome
merged commit 75f0e20
into
developJan 26, 2026

41 checks passed

@chargome
chargome
deleted the

react-router-8-instrumentation-api

branch
January 26, 2026 14:24

This was referenced Jan 27, 2026

Closed


Closed

@onurtemizkanonurtemizkan
mentioned this pull request
Jan 27, 2026
 Merged

6 tasks
s1gr1d pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan
feat(react-router): Add Instrumentation API guide (#16171)
3c7aa9b
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
jaffrepaul pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Feb 9, 2026
@onurtemizkan@jaffrepaul
feat(react-router): Add Instrumentation API guide (#16171)
affe373
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
Documents: getsentry/sentry-javascript#18580
## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs
to go live.
- [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE -->
- [ ] Other deadline: <!-- ENTER DATE HERE -->
- [ ] None: Not urgent, can wait up to 1 week+
## SLA
- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
## EXTRA RESOURCES
- [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
@onurtemizkanonurtemizkan
mentioned this pull request
Feb 18, 2026
 Merged

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

Reviewers

@sentrysentry[bot]sentry[bot] left review comments
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@cursorcursor[bot]cursor[bot] left review comments
@chargomechargomechargome approved these changes
@s1gr1ds1gr1dAwaiting requested review from s1gr1d

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support Instrumentation API

React Router Instrumentation


3 participants

@onurtemizkan@chargome