Skip to content

docs(js): Adapt react router instrumentation docs to new api#17643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chargome merged 1 commit into from
May 6, 2026
Merged

docs(js): Adapt react router instrumentation docs to new api #17643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions docs/platforms/javascript/guides/react-router/features/instrumentation-api.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,21 +4,15 @@ description: "Automatic tracing for loaders, actions, middleware, navigations, f
sidebar_order: 10
---

<Alert level="warning" title="Experimental">

React Router's instrumentation API is experimental and uses the `unstable_instrumentations` name. The `unstable_` prefix indicates the API may change in minor releases.

</Alert>

React Router 7.9.5+ provides an [instrumentation API](https://reactrouter.com/how-to/instrumentation) that enables automatic span creation for loaders, actions, middleware, navigations, fetchers, lazy routes, and request handlers without the need for manual wrapper functions. Transaction names (for HTTP requests, pageloads, and navigations) use parameterized route patterns, such as `/users/:id`, and errors are automatically captured with proper context.
React Router 7.15+ provides an [instrumentation API](https://reactrouter.com/how-to/instrumentation) that enables automatic span creation for loaders, actions, middleware, navigations, fetchers, lazy routes, and request handlers without the need for manual wrapper functions. Transaction names (for HTTP requests, pageloads, and navigations) use parameterized route patterns, such as `/users/:id`, and errors are automatically captured with proper context.

## Server-Side Setup

<SplitLayout>
<SplitSection>
<SplitSectionText>

Export `unstable_instrumentations` from your `entry.server.tsx` to enable automatic server-side tracing.
Export `instrumentations` from your `entry.server.tsx` to enable automatic server-side tracing.

The `createSentryServerInstrumentation()` function creates spans for:

Expand DownExpand Up@@ -46,7 +40,7 @@ export default Sentry.createSentryHandleRequest({
export const handleError = Sentry.createSentryHandleError();

// Enable automatic server-side instrumentation
export const unstable_instrumentations = [
export const instrumentations = [
Sentry.createSentryServerInstrumentation(),
];
```
Expand DownExpand Up@@ -120,7 +114,7 @@ startTransition(() => {
document,
<StrictMode>
<HydratedRouter
unstable_instrumentations={[tracing.clientInstrumentation]}
instrumentations={[tracing.clientInstrumentation]}
/>
</StrictMode>
);
Expand DownExpand Up@@ -204,7 +198,7 @@ export async function action({ request }) {
If you're not seeing spans for your loaders and actions:

1. Check that the React Router version is 7.9.5 or later

@sentrysentryBotMay 6, 2026

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.

Bug: The troubleshooting section incorrectly states the required React Router version is 7.9.5+, but the documented instrumentations API requires version 7.15+.
Severity: LOW

Suggested Fix

Update the React Router version mentioned in the troubleshooting section from 7.9.5 or later to 7.15+ to align with the requirements of the stable instrumentations API.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location:
docs/platforms/javascript/guides/react-router/features/instrumentation-api.mdx#L200
Potential issue: The documentation was updated to use the stable `instrumentations` API,
which was introduced in React Router version 7.15+. However, the troubleshooting section
still advises users to ensure their React Router version is 7.9.5 or later. This is
incorrect because the stable `instrumentations` export is only available from version
7.15 onwards. Users following the troubleshooting guide with a React Router version
between 7.9.5 and 7.14.x will be confused when the documented API does not work for
them.

Did we get this right? 👍 / 👎 to inform future reviews.

2. Make sure `unstable_instrumentations` is exported from `entry.server.tsx`
2. Make sure `instrumentations` is exported from `entry.server.tsx`
3. Verify `tracesSampleRate` is set in your server configuration

</Expandable>
Expand Down
Loading