---
title: "Manual Setup"
description: "Learn how to manually set up Sentry in your SvelteKit app and capture your first events."
url: https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/
---

# Manual Setup for SvelteKit

Runtime

* [Node.js (current page)](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md)
* [Cloudflare](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/cloudflare.md)

Looking for automatic setup with `sentry init` or the SvelteKit wizard? Follow the [SvelteKit quickstart](https://docs.sentry.io/platforms/javascript/guides/sveltekit.md) instead. Continue with this guide to set up Sentry manually.

This guide covers manual setup for **SvelteKit on Node.js**. For other setups, see:

* [SvelteKit on Cloudflare](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/cloudflare.md)

## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.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
* SvelteKit version `2.0.0`+ (we recommend `2.31.0` or higher for best support)
* Vite version `4.2`+

I'm on an older SvelteKit version than 2.31.0

Version `2.31.0` of SvelteKit introduces [official support for observability and tracing](https://svelte.dev/docs/kit/observability). This means that Sentry can now follow the official best practice for how the SDK should be set up:

* The Sentry SDK will be initialized at the correct, earliest possible time on the server, allowing for all its auto-instrumentation to work correctly. This means, you will now get spans from auto instrumentation (e.g. database queries) automatically.
* The Sentry SDK picks up spans emitted from SvelteKit directly. You'll get more accurate insights into the performance of your handlers, server actions, `load`, and remote functions.

SvelteKit observability is still an experimental feature in SvelteKit 2.x, but we recommend giving it a try. The Sentry wizard, as well as this guide, will use it as the default way of setting up the SDK.

If you've already set up the SDK and don't want to migrate to the new setup, or don't want to upgrade to SvelteKit `2.31.0` or higher, that's fine too. Just follow [this guide](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup__v10.7.0) instead. However, note that auto instrumentation (e.g. for database queries) will not work.

Notes on SvelteKit adapter compatibility

The SvelteKit Sentry SDK is designed to work out of the box with several SvelteKit adapters and their underlying server runtimes. Here's an overview of the current support:

* **Fully supported Node.js runtimes**

  * [Adapter-auto](https://kit.svelte.dev/docs/adapter-auto) for Vercel; other Node.js-based platforms might work, but we don't guarantee compatibility at this time
  * [Adapter-vercel](https://kit.svelte.dev/docs/adapter-vercel) when used with Vercel's Node.js Lambda runtime
  * [Adapter-node](https://kit.svelte.dev/docs/adapter-node)

* **Supported non-Node.js runtimes**
  * [Adapter-cloudflare](https://kit.svelte.dev/docs/adapter-cloudflare) requires [additional setup](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/cloudflare.md)

* **Currently not supported**
  * Non-Node.js server runtimes, such as Vercel's edge runtime, are not yet supported.

* **Other adapters**
  * Other SvelteKit adapters might work, but they're not currently officially supported. We're looking into extending first-class support to more adapters in the future.

## [Install](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md#install)

If you're updating your Sentry SDK to the latest version, check out our [migration guide](https://docs.sentry.io/platforms/javascript/guides/sveltekit/migration/v10-to-v11.md) to learn more about breaking changes.

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

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

*Other available variations of the above snippet: yarn, pnpm*

## [Configure](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md#configure)

You need to initialize and configure the Sentry SDK in three places: the client side, the server side, and your Vite config.

**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/sveltekit/manual-setup.md#send-logs) and [#4](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.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.
* [**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.
* [**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.

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

Create a client hooks file `src/hooks.client.(js|ts)` in your project if you don't have one already. In this file, import and initialize the Sentry SDK and add the `handleErrorWithSentry` function to the [`handleError` hook](https://svelte.dev/docs/kit/hooks#Shared-hooks-handleError).

The snippet also turns on:

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

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

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

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,
  integrations: [
    // Registers the Replay integration
    Sentry.replayIntegration(),
    // Enables User Feedback
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
  ],

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

const myErrorHandler = ({ error, event }) => {
  console.error("An error occurred on the client side:", error, event);
};

export const handleError = Sentry.handleErrorWithSentry(myErrorHandler);

// or alternatively, if you don't have a custom error handler:
// export const handleError = handleErrorWithSentry();
```

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

*Requires SvelteKit `2.31.0` or higher and `@sentry/sveltekit` `10.8.0` or higher.* If you're using older versions, check out [this guide](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup__v10.7.0#configure-server-side-sentry) instead.

Configure server-side instrumentation and tracing. Where this config lives depends on your SvelteKit version — SvelteKit 2 uses `svelte.config.js`, while SvelteKit 3 moved it into the `sveltekit()` Vite plugin options in `vite.config.(js|ts)` instead (see [Configure Vite](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md#configure-vite) below). SvelteKit 3 no longer needs an instrumentation flag, so the only option to set there is `tracing`.

**\[SvelteKit 2] svelte.config.js**

```js
const config = {
  kit: {
    experimental: {
      instrumentation: {
        server: true,
      },
      tracing: {
        server: true,
      },
    },
  },
};

export default config;
```

**\[SvelteKit 3] vite.config.(js|ts)**

```js
import { sveltekit } from "@sveltejs/kit/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    sveltekit({
      tracing: {
        server: true,
      },
      // ... rest of your SvelteKit config
    }),
  ],
  // ... rest of your Vite config
});
```

Create a `src/instrumentation.server.(js|ts)` file (if you don't have one already) to initialize the server-side SDK.

The snippet also turns on:

* Tracing: via [`tracesSampleRate`](https://docs.sentry.io/platforms/javascript/guides/sveltekit/configuration/options.md#tracesSampleRate)

```js
import * as Sentry from "@sentry/sveltekit";

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,
});
```

Create a server hooks file `src/hooks.server.(js|ts)` in your project if you don't have one already. In this file, add the `handleErrorWithSentry` function to the [`handleError` hook](https://svelte.dev/docs/kit/hooks#Shared-hooks-handleError) and the Sentry request handler to the [`handle` hook](https://kit.svelte.dev/docs/hooks#server-hooks-handle).

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

const myErrorHandler = ({ error, event }) => {
  console.error("An error occurred on the server side:", error, event);
};

export const handleError = Sentry.handleErrorWithSentry(myErrorHandler);
// or alternatively, if you don't have a custom error handler:
// export const handleError = handleErrorWithSentry();

export const handle = Sentry.sentryHandle();
// Or use `sequence` if you're using your own handler(s):
// export const handle = sequence(Sentry.sentryHandle(), yourHandler());
```

Having CSP issues with \`fetch\` instrumentation on older SvelteKit versions?

If you're using SvelteKit versions older than `2.16.0` and encounter Content Security Policy (CSP) errors related to Sentry's `fetch` instrumentation, you can find support in our [Troubleshooting guide](https://docs.sentry.io/platforms/javascript/guides/sveltekit/troubleshooting.md#configure-csp-for-client-side-fetch-instrumentation).

### [Configure Vite](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md#configure-vite)

Add the `sentrySvelteKit` plugin **before** `sveltekit` in your `vite.config.(js|ts)` file to automatically upload source maps to Sentry and instrument `load` functions for tracing if it's configured.

```javascript
import { sveltekit } from "@sveltejs/kit/vite";
import { sentrySvelteKit } from "@sentry/sveltekit/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [sentrySvelteKit(), sveltekit()],
  // ... rest of your Vite config
});
```

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

To upload source maps for clear error stack traces, add your Sentry auth token, organization, and project slug in your `vite.config.(js|ts)` file:

```javascript
import { sveltekit } from "@sveltejs/kit/vite";
import { sentrySvelteKit } from "@sentry/sveltekit/vite";

export default {
  plugins: [
    sentrySvelteKit({
      org: "<your-org-slug>",
      project: "<your-project-slug>",
      // store your auth token in an environment variable
      authToken: process.env.SENTRY_AUTH_TOKEN,
    }),
    sveltekit(),
  ],
  // ... rest of your Vite 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,
        // ...
      }),
    ],
  };
});
```

### [Override Adapter Detection](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.md#override-adapter-detection)

`sentrySvelteKit` tries to auto-detect your SvelteKit adapter to configure source maps upload correctly. If you're using an unsupported adapter or the wrong one is detected, set it using the `adapter` option:

```javascript
import { sveltekit } from "@sveltejs/kit/vite";
import { sentrySvelteKit } from "@sentry/sveltekit/vite";

export default {
  plugins: [
    sentrySvelteKit({
      adapter: "vercel",
    }),
    sveltekit(),
  ],
  // ... rest of your Vite config
};
```

### [Control the Data You Send to Sentry](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.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/sveltekit/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/sveltekit/manual-setup.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/sveltekit/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",
});
```

If you already use `console`, capture those calls as Sentry Logs with [`consoleLoggingIntegration`](https://docs.sentry.io/platforms/javascript/guides/sveltekit/logs.md#console-integration). We also provide integrations for:

* [Consola](https://docs.sentry.io/platforms/javascript/guides/sveltekit/logs.md#console-integration)
* [Pino](https://docs.sentry.io/platforms/javascript/guides/sveltekit/configuration/integrations/pino.md)

## [Send Application Metrics NEW](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup.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/sveltekit/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" },
});
```

On Node.js, [`nodeRuntimeMetricsIntegration`](https://docs.sentry.io/platforms/javascript/guides/sveltekit/configuration/integrations/noderuntimemetrics.md) also collects runtime health metrics automatically.

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

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

Add a test button to one of your pages that throws an error when clicked:

```javascript
<button
  type="button"
  onClick={() => {
    throw new Error("Sentry Example Frontend Error");
  }}
>
  <span>Throw Sample Error</span>
</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/sveltekit/manual-setup.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 captured data 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 [**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).
* 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/sveltekit/manual-setup.md#next-steps)

At this point, you should have integrated Sentry into your SvelteKit application. 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 Agent Tracing](https://docs.sentry.io/platforms/javascript/guides/sveltekit/agent-tracing.md) to monitor your AI systems
* [Set up tunneling](https://docs.sentry.io/platforms/javascript/guides/sveltekit/troubleshooting.md#dealing-with-ad-blockers) to avoid ad blockers from blocking Sentry events
* Learn more about [deploying SvelteKit apps to Cloudflare Workers and Pages](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/cloudflare.md)

Are you having problems setting up the SDK?

* If you encountered issues with setting up Sentry manually, [try our installation wizard](https://docs.sentry.io/platforms/javascript/guides/sveltekit.md)
* Find various topics in [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/sveltekit/troubleshooting.md)
* [Get support](https://www.sentry.help/en/)

## Pages in this section

- [Cloudflare](https://docs.sentry.io/platforms/javascript/guides/sveltekit/manual-setup/cloudflare.md)
