---
title: "SolidStart"
description: "Learn how to set up Sentry in your SolidStart application and capture your first errors."
url: https://docs.sentry.io/platforms/javascript/guides/solidstart/
---

# SolidStart | Sentry for SolidStart

##### Important

This SDK is currently in **beta**. Beta features are still in progress and may have bugs. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.

This SDK guide is specifically for SolidStart. For instrumenting your Solid app, see our [Solid SDK](https://docs.sentry.io/platforms/javascript/guides/solid.md).

## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#prerequisites)

You need:

* A Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects.md)
* Your application up and running

## [Step 1: Install](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-1-install)

Choose the features you want to configure, and this guide will show you how:

Error Monitoring\[ ]Tracing\[ ]Session Replay\[ ]Logs\[ ]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 unhandled rejections. 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.
* [**Session Replay**](https://docs.sentry.io/product/explore/session-replay/web.md):
  <!-- -->
  Get to the root cause of an issue faster by viewing a video-like reproduction of what was happening in the user's browser before, during, and after the problem.
* [**Logs**](https://docs.sentry.io/product/explore/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.

### [Install the Sentry SDK](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#install-the-sentry-sdk)

Run the command for your preferred package manager to add the Sentry SDK to your application:

```bash
npm install @sentry/solidstart --save
```

## [Step 2: Configure](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-2-configure)

You need to initialize and configure the Sentry SDK in two places: the client side and the server side.

The examples in this guide will use TypeScript with a `src` folder structure. Make sure to adjust the file paths and extensions (`.js`, `.jsx`, `.ts`, `.tsx`) to match your project setup.

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

Import and initialize the Sentry SDK in your `/src/entry-client.tsx` file.

If you're using Solid Router, make sure to import and add the `solidRouterBrowserTracingIntegration` to enable tracing in your app:

`src/entry-client.tsx`

```jsx
import * as Sentry from "@sentry/solidstart";
// ___PRODUCT_OPTION_START___ performance
// import solidRouterBrowserTracingIntegration if you're using Solid Router
import { solidRouterBrowserTracingIntegration } from "@sentry/solidstart/solidrouter";
// ___PRODUCT_OPTION_END___ performance
import { mount, StartClient } from "@solidjs/start/client";

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/solidstart/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  integrations: [
    // ___PRODUCT_OPTION_START___ performance
    // add solidRouterBrowserTracingIntegration if you're using Solid Router
    solidRouterBrowserTracingIntegration(),
    // ___PRODUCT_OPTION_END___ performance
    // ___PRODUCT_OPTION_START___ session-replay
    // Replay may only be enabled for the client-side
    Sentry.replayIntegration(),
    // ___PRODUCT_OPTION_END___ session-replay
    // ___PRODUCT_OPTION_START___ user-feedback
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
    // ___PRODUCT_OPTION_END___ user-feedback
  ],
  // ___PRODUCT_OPTION_START___ performance

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ session-replay

  // Capture Replay for 10% of all sessions,
  // plus for 100% of sessions with an error
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/session-replay/configuration/#general-integration-configuration
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ session-replay
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});

mount(() => <StartClient />, document.getElementById("app"));
```

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

Create a file named `instrument.server.ts` in your `src` folder. In this file, initialize and import Sentry for your server:

`src/instrument.server.ts`

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

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/solidstart/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  // ___PRODUCT_OPTION_START___ performance

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});
```

### [Server Instrumentation](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#server-instrumentation)

The Sentry SDK provides [middleware lifecycle](https://docs.solidjs.com/solid-start/advanced/middleware) handlers that enhance the data collected by Sentry on the server side, enabling distributed tracing between the client and server.

Create or update your `src/middleware.ts` file and add the `sentryBeforeResponseMiddleware` handler:

`src/middleware.ts`

```typescript
import { sentryBeforeResponseMiddleware } from "@sentry/solidstart";
import { createMiddleware } from "@solidjs/start/middleware";

export default createMiddleware({
  onBeforeResponse: [

    sentryBeforeResponseMiddleware(),

    // Add your other middleware handlers after `sentryBeforeResponseMiddleware`
  ],
});
```

Wrap your SolidStart config in `app.config.ts` with `withSentry` so that the instrumentation file gets included in your build output. Then, specify the middleware that you've just created:

`app.config.ts`

```javascript
import { withSentry } from "@sentry/solidstart";
import { defineConfig } from "@solidjs/start/config";

export default defineConfig(

  withSentry(
    {
      // other SolidStart config options...
      middleware: "./src/middleware.ts",
    },
    {
      // Your Sentry build-time config (such as source map upload options)
      // optional: if your `instrument.server.ts` file is not located inside `src`
      instrumentation: "./mypath/instrument.server.ts",
    },
  ),

);
```

### [Configure Solid Router](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#configure-solid-router)

If you're using Solid Router and the Sentry `solidRouterBrowserTracingIntegration` integration, wrap your Solid Router with `withSentryRouterRouting` to enable Sentry to collect navigation spans:

`app.tsx`

```tsx
import { Router } from "@solidjs/router";
import { FileRoutes } from "@solidjs/start/router";
import { withSentryRouterRouting } from "@sentry/solidstart/solidrouter";


const SentryRouter = withSentryRouterRouting(Router);


export default function App() {
  return (

    <SentryRouter>

      <FileRoutes />

    </SentryRouter>

  );
}
```

### [Run Your Application](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#run-your-application)

Instrumentation needs to happen as early as possible to make sure Sentry works as intended. To do this, add an `--import` flag to the `NODE_OPTIONS` environment variable when you run your application and set it to import the instrumentation file created by the build output: `.output/server/instrument.server.mjs`.

Run your build command to generate the `instrument.server.mjs` file before running your app. Depending on your build preset, the location of the file can differ. To find out where the file is located, monitor the build log output for:

`[Sentry SolidStart withSentry] Successfully created /my/project/path/.output/server/instrument.server.mjs.`

For example, update your scripts in `package.json`.

`package.json`

```json
{
  "scripts": {
    "start:vinxi": "NODE_OPTIONS='--import ./.output/server/instrument.server.mjs ' vinxi start",
    "start:node": "node --import ./.output/server/instrument.server.mjs .output/server/index.mjs"
  }
}
```

If you're not able to use the `--import` flag, check the alternative [installation methods](https://docs.sentry.io/platforms/javascript/guides/solidstart/install.md).

## [Step 3: Capture Solid Errors](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-3-capture-solid-errors)

To automatically report exceptions from inside a component tree to Sentry, wrap Solid's `ErrorBoundary` with Sentry's helper function:

```jsx
import * as Sentry from "@sentry/solidstart";
import { ErrorBoundary } from "solid-js";

// Wrap Solid"s ErrorBoundary to automatically capture exceptions
const SentryErrorBoundary = Sentry.withSentryErrorBoundary(ErrorBoundary);

export default function SomeComponent() {
  return (
    <SentryErrorBoundary
      fallback={(err) => <div>Error: {err.message}</div>}
    >
      <div>Some Component</div>
    </SentryErrorBoundary>
  );
}
```

## [Step 4: Add Readable Stack Traces With Source Maps (Optional)](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-4-add-readable-stack-traces-with-source-maps-optional)

To upload source maps for clear error stack traces, add your Sentry auth token, organization, and project slug in your SolidStart configuration:

`app.config.ts`

```TypeScript
import { withSentry } from '@sentry/solidstart';
import { defineConfig } from '@solidjs/start/config';

export default defineConfig(
  withSentry(
    {
      /* Your SolidStart config */
    },
    {
      org: "___ORG_SLUG___",
      project: "___PROJECT_SLUG___",
      // store your auth token in an environment variable
      authToken: process.env.SENTRY_AUTH_TOKEN,
    }
  ),
);
```

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

`.env`

```bash
SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___
```

Alternatively, you can create a `.env.sentry-build-plugin` file:

`.env.sentry-build-plugin`

```bash
SENTRY_ORG="___ORG_SLUG___"
SENTRY_PROJECT="___PROJECT_SLUG___"
SENTRY_AUTH_TOKEN="___ORG_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:

`vite.config.js`

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

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

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

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

## [Step 5: Avoid Ad Blockers With Tunneling (Optional)](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-5-avoid-ad-blockers-with-tunneling-optional)

You can prevent ad blockers from blocking Sentry events using tunneling. Use the `tunnel` option to add an API endpoint in your application that forwards Sentry events to Sentry servers.

To enable tunneling, update `Sentry.init` with the following option:

```javascript
Sentry.init({
  dsn: "___PUBLIC_DSN___",

  tunnel: "/tunnel",

});
```

This will send all events to the `tunnel` endpoint. However, the events need to be parsed and redirected to Sentry, so you'll need to do additional configuration on the server. You can find a detailed explanation on how to do this on our [Troubleshooting page](https://docs.sentry.io/platforms/javascript/guides/solidstart/troubleshooting.md#using-the-tunnel-option).

## [Step 6: Verify Your Setup](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#step-6-verify-your-setup)

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

### [Issues](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#issues)

To verify that Sentry captures errors and creates issues in your Sentry project, add a test button to an existing page or create a new one:

```javascript
<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Test Error");
  }}
>
  Break the world
</button>;
```

Open the page in a browser and click the button to trigger a frontend error.

##### 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.

### [Tracing](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#tracing)

To test tracing, create a test API route like `src/routes/sentry-test.tsx`:

`sentry-test.tsx`

```javascript
export async function GET() {
  throw new Error("Sentry Example API Route Error");
}
```

Next, update your test button to call this route and throw an error if the response isn't `ok`:

```javascript
<button
  type="button"
  onClick={() => {
    Sentry.startSpan(
      {
        op: "test",
        name: "My First Test Transaction",
      },
      async () => {
        const res = await fetch("/sentry-test");
        if (!res.ok) {
          throw new Error("Sentry Test Error");
        }
      },
    );
  }}
>
  Break the world
</button>;
```

Open the page in the browser and click the button to trigger a frontend error, an error in the API route, and a trace to measure the time it takes for the API request to complete.

### [Logs NEW](https://docs.sentry.io/platforms/javascript/guides/solidstart.md#logs-)

To verify that Sentry catches your logs, add some log statements to your application:

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

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

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

### [View Captured Data in Sentry](https://docs.sentry.io/platforms/javascript/guides/solidstart.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 this
  <!-- -->
  [interactive walkthrough](https://docs.sentry.io/product/sentry-basics/integrate-frontend/generate-first-error.md#ui-walkthrough).
* 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/distributed-tracing/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/explore/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).

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

At this point, you should have integrated Sentry into your SolidStart application and should already be sending data to your Sentry project.

Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:

* Explore [practical guides](https://docs.sentry.io/guides.md) on what to monitor, log, track, and investigate after setup
* Learn how to [manually capture errors](https://docs.sentry.io/platforms/javascript/guides/solidstart/usage.md)
* Continue to [customize your configuration](https://docs.sentry.io/platforms/javascript/guides/solidstart/configuration.md)
* Learn how to make use of [SolidStart-specific features](https://docs.sentry.io/platforms/javascript/guides/solidstart/features.md)
* Get familiar with [Sentry's product features](https://docs.sentry.io/.md) like tracing, insights, and alerts

Are you having problems setting up the SDK?

* If you encountered issues with setting up Sentry, [review alternative installation methods](https://docs.sentry.io/platforms/javascript/guides/solidstart/install.md)
* Find various topics in [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/solidstart/troubleshooting.md)
* [Get support](https://sentry.zendesk.com/hc/en-us/)

## Other JavaScript Frameworks

- [Angular](https://docs.sentry.io/platforms/javascript/guides/angular.md)
- [Astro](https://docs.sentry.io/platforms/javascript/guides/astro.md)
- [AWS Lambda](https://docs.sentry.io/platforms/javascript/guides/aws-lambda.md)
- [Azure Functions](https://docs.sentry.io/platforms/javascript/guides/azure-functions.md)
- [Bun](https://docs.sentry.io/platforms/javascript/guides/bun.md)
- [Capacitor](https://docs.sentry.io/platforms/javascript/guides/capacitor.md)
- [Cloud Functions for Firebase](https://docs.sentry.io/platforms/javascript/guides/firebase.md)
- [Cloudflare](https://docs.sentry.io/platforms/javascript/guides/cloudflare.md)
- [Connect](https://docs.sentry.io/platforms/javascript/guides/connect.md)
- [Cordova](https://docs.sentry.io/platforms/javascript/guides/cordova.md)
- [Deno](https://docs.sentry.io/platforms/javascript/guides/deno.md)
- [Effect](https://docs.sentry.io/platforms/javascript/guides/effect.md)
- [Electron](https://docs.sentry.io/platforms/javascript/guides/electron.md)
- [Elysia](https://docs.sentry.io/platforms/javascript/guides/elysia.md)
- [Ember](https://docs.sentry.io/platforms/javascript/guides/ember.md)
- [Express](https://docs.sentry.io/platforms/javascript/guides/express.md)
- [Fastify](https://docs.sentry.io/platforms/javascript/guides/fastify.md)
- [Gatsby](https://docs.sentry.io/platforms/javascript/guides/gatsby.md)
- [Google Cloud Functions](https://docs.sentry.io/platforms/javascript/guides/gcp-functions.md)
- [Hapi](https://docs.sentry.io/platforms/javascript/guides/hapi.md)
- [Hono](https://docs.sentry.io/platforms/javascript/guides/hono.md)
- [Koa](https://docs.sentry.io/platforms/javascript/guides/koa.md)
- [Nest.js](https://docs.sentry.io/platforms/javascript/guides/nestjs.md)
- [Next.js](https://docs.sentry.io/platforms/javascript/guides/nextjs.md)
- [Node.js](https://docs.sentry.io/platforms/javascript/guides/node.md)
- [Nuxt](https://docs.sentry.io/platforms/javascript/guides/nuxt.md)
- [React](https://docs.sentry.io/platforms/javascript/guides/react.md)
- [React Router Framework](https://docs.sentry.io/platforms/javascript/guides/react-router.md)
- [Remix](https://docs.sentry.io/platforms/javascript/guides/remix.md)
- [Solid](https://docs.sentry.io/platforms/javascript/guides/solid.md)
- [Svelte](https://docs.sentry.io/platforms/javascript/guides/svelte.md)
- [SvelteKit](https://docs.sentry.io/platforms/javascript/guides/sveltekit.md)
- [TanStack Start React](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react.md)
- [Vue](https://docs.sentry.io/platforms/javascript/guides/vue.md)
- [Wasm](https://docs.sentry.io/platforms/javascript/guides/wasm.md)

## Topics

- [Installation Methods](https://docs.sentry.io/platforms/javascript/guides/solidstart/install.md)
- [Capturing Errors](https://docs.sentry.io/platforms/javascript/guides/solidstart/usage.md)
- [Source Maps](https://docs.sentry.io/platforms/javascript/guides/solidstart/sourcemaps.md)
- [Logs](https://docs.sentry.io/platforms/javascript/guides/solidstart/logs.md)
- [Session Replay](https://docs.sentry.io/platforms/javascript/guides/solidstart/session-replay.md)
- [Tracing](https://docs.sentry.io/platforms/javascript/guides/solidstart/tracing.md)
- [AI Agent Monitoring](https://docs.sentry.io/platforms/javascript/guides/solidstart/ai-agent-monitoring.md)
- [Metrics](https://docs.sentry.io/platforms/javascript/guides/solidstart/metrics.md)
- [Profiling](https://docs.sentry.io/platforms/javascript/guides/solidstart/profiling.md)
- [User Feedback](https://docs.sentry.io/platforms/javascript/guides/solidstart/user-feedback.md)
- [Sampling](https://docs.sentry.io/platforms/javascript/guides/solidstart/sampling.md)
- [Enriching Events](https://docs.sentry.io/platforms/javascript/guides/solidstart/enriching-events.md)
- [Extended Configuration](https://docs.sentry.io/platforms/javascript/guides/solidstart/configuration.md)
- [OpenTelemetry Support](https://docs.sentry.io/platforms/javascript/guides/solidstart/opentelemetry.md)
- [Feature Flags](https://docs.sentry.io/platforms/javascript/guides/solidstart/feature-flags.md)
- [Data Management](https://docs.sentry.io/platforms/javascript/guides/solidstart/data-management.md)
- [Security Policy Reporting](https://docs.sentry.io/platforms/javascript/guides/solidstart/security-policy-reporting.md)
- [Special Use Cases](https://docs.sentry.io/platforms/javascript/guides/solidstart/best-practices.md)
- [Migration Guide](https://docs.sentry.io/platforms/javascript/guides/solidstart/migration.md)
- [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/solidstart/troubleshooting.md)
- [SolidStart Features](https://docs.sentry.io/platforms/javascript/guides/solidstart/features.md)