---
title: "Quick Start (Bun)"
description: "Learn how to set up Sentry in your React Router app (v7.15+) that runs on Bun and capture your first errors and traces."
url: https://docs.sentry.io/platforms/javascript/guides/react-router/bun/
---

# React Router Framework on Bun

Runtime

* [Node.js](https://docs.sentry.io/platforms/javascript/guides/react-router.md)
* [Cloudflare](https://docs.sentry.io/platforms/javascript/guides/react-router/cloudflare.md)
* [Deno](https://docs.sentry.io/platforms/javascript/guides/react-router/deno.md)
* [Bun (current page)](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md)

This guide sets up Sentry in a React Router app in framework mode that you build with Vite and serve with `react-router-serve` on Bun. At the end, your app sends errors, traces, logs, and session replays to Sentry.

## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#prerequisites)

You need:

* A Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects.md)
* A React Router app in framework mode, version `7.15.0` or above
* [Bun](https://bun.sh/)

## [Install](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#install)

Add the Sentry React Router SDK for your app and the Sentry Bun SDK for your server:

```bash
bun add @sentry/react-router @sentry/bun
```

## [Configure](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#configure)

**Error Monitoring** starts working as soon as you call `Sentry.init()`. **Logs** and **Application Metrics** need no extra configuration, and you'll learn how to send them in steps [#3](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#send-logs) and [#4](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#send-application-metrics-). This guide also enables **Tracing**, **Session Replay**, and **User Feedback**.

Want to learn more about these features?

* [**Issues**](https://docs.sentry.io/product/issues.md) (always enabled): Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and crashes. If you have something that looks like an exception, Sentry can capture it.
* [**Tracing**](https://docs.sentry.io/product/tracing.md): Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back. On the server, this includes [Agent Tracing](https://docs.sentry.io/product/agents.md): supported AI libraries are instrumented automatically, so you can see model calls, tool executions, and token usage.
* [**Session Replay**](https://docs.sentry.io/product/session-replay.md): Get to the root cause of an issue faster by viewing a video-like reproduction of what users saw in your app before, during, and after the problem.
* [**Logs**](https://docs.sentry.io/product/logs.md): Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications.
* [**User Feedback**](https://docs.sentry.io/product/user-feedback.md): Collect feedback directly from users when they encounter errors, allowing them to describe what happened and provide context that helps you understand and resolve issues faster.
* [**Application Metrics**](https://docs.sentry.io/product/metrics.md) (always enabled): Track and analyze custom application metrics, such as response times and database query durations, to understand trends and patterns in your application's performance and behavior over time.

### [Expose Entry Point Files](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#expose-entry-point-files)

Before configuring Sentry, you need to make React Router's entry files (`entry.client.tsx` and `entry.server.tsx`) visible in your project. Run this command to expose them:

```bash
npx react-router reveal
```

### [Configure Client-Side Sentry](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#configure-client-side-sentry)

Initialize Sentry in your `entry.client.tsx` file. This code runs in the browser, so it's the same on every server runtime.

The snippet also turns on:

* Tracing: via [`tracesSampleRate`](https://docs.sentry.io/platforms/javascript/guides/react-router/configuration/options.md#tracesSampleRate) and `reactRouterTracingIntegration()`
* Session Replay: via `replayIntegration()`, sampled with [`replaysSessionSampleRate`](https://docs.sentry.io/platforms/javascript/guides/react-router/configuration/options.md#replaysSessionSampleRate) and [`replaysOnErrorSampleRate`](https://docs.sentry.io/platforms/javascript/guides/react-router/configuration/options.md#replaysOnErrorSampleRate)
* User Feedback: via [`feedbackIntegration()`](https://docs.sentry.io/platforms/javascript/guides/react-router/user-feedback/configuration.md)

Don't need a feature? Remove its integration and options from the snippet.

The `sentryOnError` handler integrates with React Router's [`onError` hook](https://reactrouter.com/how-to/error-reporting) to automatically capture and report client-side errors to Sentry.

```tsx
import * as Sentry from "@sentry/react-router";
import { startTransition, StrictMode } from "react";
import { hydrateRoot } from "react-dom/client";
import { HydratedRouter } from "react-router/dom";

Sentry.init({
  dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",

  integrations: [
    // Registers and configures the Tracing integration,
    // which automatically instruments your application to monitor its
    // performance, including custom React Router routing instrumentation
    Sentry.reactRouterTracingIntegration(),
    // Registers the Replay integration,
    // which automatically captures Session Replays
    Sentry.replayIntegration(),
    // Registers the User Feedback integration
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
  ],

  // Enables Tracing.
  // Set to 1.0 to capture 100% of spans for tracing.
  // We recommend reducing this value in production.
  tracesSampleRate: 1.0,

  // Set `tracePropagationTargets` to declare which URL(s) should have trace propagation enabled
  tracePropagationTargets: [/^\//, /^https:\/\/yourserver\.io\/api/],

  // Capture replays for 10% of all sessions,
  // plus for 100% of sessions with an error
  // Requires Sentry.replayIntegration()
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
});

startTransition(() => {
  hydrateRoot(
    document,
    <StrictMode>
      <HydratedRouter onError={Sentry.sentryOnError} />
    </StrictMode>,
  );
});
```

### [Configure Server-Side Sentry](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#configure-server-side-sentry)

Create a file called `instrument.server.mjs` in the root of your project, and initialize Sentry with the Bun SDK. Don't use `Sentry.init()` from `@sentry/react-router` on the server: it's made for Node.js.

```javascript
import * as Sentry from "@sentry/bun";

Sentry.init({
  dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
  // Enables Tracing.
  // Set to 1.0 to capture 100% of spans for tracing.
  // We recommend reducing this value in production.
  tracesSampleRate: 1.0,
});
```

Next, replace the default `handleRequest` and `handleError` functions in your `entry.server.tsx` file with Sentry's versions, and export `instrumentations`.

`handleError` sends server errors to Sentry. `instrumentations` uses React Router's [instrumentation API](https://reactrouter.com/how-to/instrumentation) to create spans for all loaders, actions, middleware, and request handlers, and names each request after its route, for example `GET /users/:id`.

```tsx
+import * as Sentry from "@sentry/react-router";
 import { createReadableStreamFromReadable } from "@react-router/node";
 import { renderToPipeableStream } from "react-dom/server";
 import { ServerRouter, type HandleErrorFunction } from "react-router";

+const handleRequest = Sentry.createSentryHandleRequest({
+  ServerRouter,
+  renderToPipeableStream,
+  createReadableStreamFromReadable,
+});

 export default handleRequest;

+export const handleError: HandleErrorFunction = Sentry.createSentryHandleError({
+  logErrors: false,
+});

+export const instrumentations = [Sentry.createSentryServerInstrumentation()];

 // ... rest of your server entry
```

To use a Content Security Policy nonce or your own `handleRequest` or `handleError` logic, see the [manual setup](https://docs.sentry.io/platforms/javascript/guides/react-router/manual-setup.md#configure-server-side-sentry).

### [Add Readable Stack Traces With Source Maps](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#add-readable-stack-traces-with-source-maps)

The `sentryReactRouter` Vite plugin uploads your source maps, so stack traces in Sentry show your original code. It also instruments supported packages that your server code imports, such as database clients, when Vite builds your app.

Add the plugin to your `vite.config.ts`, and pass both the Sentry options and the Vite configuration to it:

```typescript
import { reactRouter } from "@react-router/dev/vite";
+import {
+  sentryReactRouter,
+  type SentryReactRouterBuildOptions,
+} from "@sentry/react-router/vite";
import { defineConfig } from "vite";

+const sentryConfig: SentryReactRouterBuildOptions = {
+  org: "<your-org-slug>",
+  project: "<your-project-slug>",
+
+  // An auth token is required for uploading source maps;
+  // store it in an environment variable to keep it secure.
+  authToken: process.env.SENTRY_AUTH_TOKEN,
+};

export default defineConfig((config) => {
  return {
-   plugins: [reactRouter()],
+   plugins: [reactRouter(), sentryReactRouter(sentryConfig, config)],
  };
});
```

To keep your auth token secure, always store it in an environment variable instead of directly in your files:

```bash
SENTRY_AUTH_TOKEN=<your-sentry-auth-token>
```

Using environment variables in Vite configs

Vite doesn't automatically load `.env` files into `process.env` when evaluating the config file. If you store your auth token in a `.env` file and want to access it via `process.env.SENTRY_AUTH_TOKEN`, use Vite's [`loadEnv`](https://vite.dev/guide/api-javascript#loadenv) helper.

Alternatively, use a `.env.sentry-build-plugin` file, which the Sentry plugin reads automatically.

```javascript
import { defineConfig, loadEnv } from "vite";

export default defineConfig(({ mode }) => {
  const env = loadEnv(mode, process.cwd(), "");

  return {
    plugins: [
      sentryVitePlugin({
        authToken: env.SENTRY_AUTH_TOKEN,
        // ...
      }),
    ],
  };
});
```

Next, call `sentryOnBuildEnd` in the `buildEnd` hook of your `react-router.config.ts`. It adds debug IDs to your build output and uploads the source maps:

```typescript
import type { Config } from "@react-router/dev/config";
+import { sentryOnBuildEnd } from "@sentry/react-router/vite";

export default {
  ssr: true,
+ buildEnd: async ({ viteConfig, reactRouterConfig, buildManifest }) => {
+   // ...
+   // Call this at the end of the hook
+   await sentryOnBuildEnd({ viteConfig, reactRouterConfig, buildManifest });
+ },
} satisfies Config;
```

Keep the plugin even if you don't upload source maps: on Bun, it's the only way to get spans for packages such as database clients. You don't need `sentryBunPlugin` from the [Bun guide](https://docs.sentry.io/platforms/javascript/guides/bun.md). That plugin is for apps that you build with `Bun.build()`, and Vite builds your React Router app.

### [Start Your App](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#start-your-app)

Preload `instrument.server.mjs` and run the `react-router-serve` script with Bun. Update the `start` script in your `package.json`:

```json
"scripts": {
  "start": "bun --preload ./instrument.server.mjs ./node_modules/@react-router/serve/bin.cjs ./build/server/index.js"
}
```

Use the path of the script file, not the `react-router-serve` command. With the command, the preloaded file doesn't apply to the server, and Sentry receives no data.

When the server starts, Bun shows the message `[Sentry] No diagnostics-channel injection detected`. You can ignore it: the Sentry Vite plugin instruments the packages in your server build.

On Bun, you get no spans for the Express middleware of `react-router-serve`, because Express isn't part of your server build. Errors, request spans, spans for loaders and actions, and outgoing `fetch` requests work.

### [Control the Data You Send to Sentry](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#control-the-data-you-send-to-sentry)

By default, the SDK sends user identity data (IP address, ID, and similar) and other data like HTTP bodies and URL query parameters. This will give you rich debugging context.

The SDK always filters sensitive values whose keys match a built-in denylist, such as `auth` or `password`, and sends `[Filtered]` instead.

To send less data, turn off the categories you don't need in the `dataCollection` option. For the full list of categories and their defaults, [see the `dataCollection` options](https://docs.sentry.io/platforms/javascript/guides/react-router/configuration/options.md#dataCollection).

```javascript
Sentry.init({
  dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
  dataCollection: {
    userInfo: false,
    // other categories
  },
});
```

## [Send Logs](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#send-logs)

Use `Sentry.logger` to send logs at different levels, such as `info`, `warn`, or `error`. You can pass any attributes you want and search or filter by them later. See [Set Up Logs](https://docs.sentry.io/platforms/javascript/guides/react-router/logs.md) for all available logging methods and the syntax for formatting messages.

```javascript
Sentry.logger.info("User example action completed");

Sentry.logger.warn("Slow operation detected", {
  operation: "data_fetch",
  duration: 3500,
});

Sentry.logger.error("Validation failed", {
  form_field: "email",
  reason: "Invalid email",
});
```

## [Send Application Metrics NEW](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#send-application-metrics-)

Use `Sentry.metrics` to send counters, gauges, and distributions from your app to Sentry. You can pass any attributes you want and search or filter by them later. See [Set Up Metrics](https://docs.sentry.io/platforms/javascript/guides/react-router/metrics.md) for all available metric types and configuration options.

```javascript
Sentry.metrics.count("checkout.failed", 1);

Sentry.metrics.gauge("time_since_refresh", 4, { unit: "hour" });

Sentry.metrics.distribution("api_latency", 187, {
  unit: "millisecond",
  attributes: { endpoint: "/api/orders" },
});
```

## [Verify Your Setup](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#verify-your-setup)

To confirm that Sentry captures errors on the server, add a route whose loader throws an error:

```tsx
export function loader() {
  throw new Error("Sentry Example Server Error");
}

export default function SentryExample() {
  return <div>This page throws an error on the server.</div>;
}
```

Add the route to your `app/routes.ts`:

```typescript
import { type RouteConfig, index, route } from "@react-router/dev/routes";

export default [
  index("routes/home.tsx"),
+ route("sentry-example", "routes/sentry-example.tsx"),
] satisfies RouteConfig;
```

Build and start your app, then open `/sentry-example` in your browser. Sentry receives the error and a trace of the request. Sentry names both after the route, for example `GET /sentry-example`.

To test the client side too, add a button to one of your pages and click it:

```tsx
<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Test Error");
  }}
>
  Test Sentry Error
</button>;
```

##### Important

Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring.

### [View Captured Data in Sentry](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#view-captured-data-in-sentry)

Now, head over to your project on [Sentry.io](https://sentry.io) to view the collected data (it takes a couple of moments for the data to appear).

Need help locating the captured errors in your Sentry project?

* Open the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page and select an error from the issues list to view the full details and context of this error. For more details, see the [Issue Details documentation](https://docs.sentry.io/product/issues/issue-details.md).
* Open the [**Traces**](https://sentry.io/orgredirect/organizations/:orgslug/explore/traces/) page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/sentry-basics/getting-started-tutorial/generate-first-error.md#ui-walkthrough).
* Open the [**Replays**](https://sentry.io/orgredirect/organizations/:orgslug/replays/) page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot.
* Open the [**Logs**](https://sentry.io/orgredirect/organizations/:orgslug/explore/logs/) page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/logs.md#overview).
* Open the [**User Feedback**](https://sentry.io/orgredirect/organizations/:orgslug/feedback/) page and click on individual feedback to see more details all in one view. For more information, click [here](https://docs.sentry.io/product/user-feedback.md).
* Open the [**Application Metrics**](https://sentry.io/orgredirect/organizations/:orgslug/explore/metrics) page to view and analyze your metrics. For more details, see this [interactive walkthrough](https://docs.sentry.io/product/metrics.md#overview).

## [Next Steps](https://docs.sentry.io/platforms/javascript/guides/react-router/bun.md#next-steps)

At this point, you should have integrated Sentry into your React Router Framework application on Bun. Here's what to explore next:

* Explore [practical guides](https://docs.sentry.io/get-started/guides.md) on what to monitor, log, track, and investigate after setup
* [Set up tunneling](https://docs.sentry.io/platforms/javascript/guides/react-router/troubleshooting.md#dealing-with-ad-blockers) to avoid ad blockers blocking Sentry events
* Learn more about the [Sentry Bun SDK](https://docs.sentry.io/platforms/javascript/guides/bun.md)

Are you having problems setting up the SDK?

* Find various topics in [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/react-router/troubleshooting.md)
* [Get support](https://www.sentry.help/en/)
