getsentry · Lms24 · Sep 1, 2025 · Aug 27, 2025 · Aug 27, 2025 · Aug 28, 2025
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -148,7 +148,8 @@ jobs:
           - NextJS-15
           - Remix
           - React-Native
-          - Sveltekit
+          - Sveltekit-Hooks
+          - Sveltekit-Tracing
           - Help
           - Cloudflare-Wrangler-Sourcemaps
         os:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+- feat(sveltekit): Add support for SDK setup with `instrumentation.server.ts` ([#1077](https://github.com/getsentry/sentry-wizard/pull/1077))
+
+  This release adds support for setting up the SvelteKit SDK in SvelteKit versions 2.31.0 or higher.
+
 ## 6.3.0
 
 - feat(nextjs,remix,sveltekit,react-native,flutter,ios,angular,android,nuxt): add support to add MCP server during wizard based installlations ([#1063](https://github.com/getsentry/sentry-wizard/pull/1063))

diff --git a/...pplications/sveltekit-test-app/.gitignore → ...tions/sveltekit-hooks-test-app/.gitignore b/...pplications/sveltekit-test-app/.gitignore → ...tions/sveltekit-hooks-test-app/.gitignore
diff --git a/...st-applications/sveltekit-test-app/.npmrc → ...lications/sveltekit-hooks-test-app/.npmrc b/...st-applications/sveltekit-test-app/.npmrc → ...lications/sveltekit-hooks-test-app/.npmrc
diff --git a/...lications/sveltekit-test-app/package.json → ...ons/sveltekit-hooks-test-app/package.json b/...lications/sveltekit-test-app/package.json → ...ons/sveltekit-hooks-test-app/package.json
diff --git a/...lications/sveltekit-test-app/src/app.d.ts → ...ons/sveltekit-hooks-test-app/src/app.d.ts b/...lications/sveltekit-test-app/src/app.d.ts → ...ons/sveltekit-hooks-test-app/src/app.d.ts
diff --git a/...lications/sveltekit-test-app/src/app.html → ...ons/sveltekit-hooks-test-app/src/app.html b/...lications/sveltekit-test-app/src/app.html → ...ons/sveltekit-hooks-test-app/src/app.html
diff --git a/...tions/sveltekit-test-app/src/lib/index.ts → ...sveltekit-hooks-test-app/src/lib/index.ts b/...tions/sveltekit-test-app/src/lib/index.ts → ...sveltekit-hooks-test-app/src/lib/index.ts
diff --git a/...veltekit-test-app/src/routes/+page.svelte → ...it-hooks-test-app/src/routes/+page.svelte b/...veltekit-test-app/src/routes/+page.svelte → ...it-hooks-test-app/src/routes/+page.svelte
diff --git a/...tions/sveltekit-test-app/svelte.config.js → ...sveltekit-hooks-test-app/svelte.config.js b/...tions/sveltekit-test-app/svelte.config.js → ...sveltekit-hooks-test-app/svelte.config.js
diff --git a/...ications/sveltekit-test-app/tsconfig.json → ...ns/sveltekit-hooks-test-app/tsconfig.json b/...ications/sveltekit-test-app/tsconfig.json → ...ns/sveltekit-hooks-test-app/tsconfig.json
diff --git a/...cations/sveltekit-test-app/vite.config.ts → ...s/sveltekit-hooks-test-app/vite.config.ts b/...cations/sveltekit-test-app/vite.config.ts → ...s/sveltekit-hooks-test-app/vite.config.ts
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/.gitignore b/e2e-tests/test-applications/sveltekit-tracing-test-app/.gitignore
@@ -0,0 +1,21 @@
+node_modules
+
+# Output
+.output
+.vercel
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/.npmrc b/e2e-tests/test-applications/sveltekit-tracing-test-app/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/package.json b/e2e-tests/test-applications/sveltekit-tracing-test-app/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "sveltekit-test-app",
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "dev": "vite dev",
+    "build": "vite build",
+    "preview": "vite preview",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
+  },
+  "devDependencies": {
+    "@sveltejs/adapter-node": "^5.3.1",
+    "@sveltejs/kit": "2.31.0",
+    "@sveltejs/vite-plugin-svelte": "^4.0.0",
+    "svelte": "^5.0.0",
+    "svelte-check": "^4.0.0",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.3"
+  }
+}
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/src/app.d.ts b/e2e-tests/test-applications/sveltekit-tracing-test-app/src/app.d.ts
@@ -0,0 +1,13 @@
+// See https://svelte.dev/docs/kit/types#app
+// for information about these interfaces
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface PageState {}
+		// interface Platform {}
+	}
+}
+
+export {};
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/src/app.html b/e2e-tests/test-applications/sveltekit-tracing-test-app/src/app.html
@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		%sveltekit.head%
+	</head>
+	<body data-sveltekit-preload-data="hover">
+		<div style="display: contents">%sveltekit.body%</div>
+	</body>
+</html>
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/src/hooks.server.ts b/e2e-tests/test-applications/sveltekit-tracing-test-app/src/hooks.server.ts
@@ -0,0 +1,4 @@
+export const handle = async ({ event, resolve }) => {
+  const response = await resolve(event);
+  return response;
+};
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/src/lib/index.ts b/e2e-tests/test-applications/sveltekit-tracing-test-app/src/lib/index.ts
@@ -0,0 +1 @@
+// place files you want to import through the `$lib` alias in this folder.
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/src/routes/+page.svelte b/e2e-tests/test-applications/sveltekit-tracing-test-app/src/routes/+page.svelte
@@ -0,0 +1,2 @@
+<h1>Welcome to SvelteKit</h1>
+<p>Visit <a href="https://svelte.dev/docs/kit">svelte.dev/docs/kit</a> to read the documentation</p>
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/svelte.config.js b/e2e-tests/test-applications/sveltekit-tracing-test-app/svelte.config.js
@@ -0,0 +1,21 @@
+import adapter from '@sveltejs/adapter-node';
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+  // Consult https://svelte.dev/docs/kit/integrations#preprocessors
+  // for more information about preprocessors
+  preprocess: vitePreprocess(),
+
+  kit: {
+    // adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
+    // If your environment is not supported, or you settled on a specific environment, switch out the adapter.
+    // See https://svelte.dev/docs/kit/adapters for more information about adapters.
+    adapter: adapter(),
+    experimental: {
+      remoteFunctions: true,
+    },
+  },
+};
+
+export default config;
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/tsconfig.json b/e2e-tests/test-applications/sveltekit-tracing-test-app/tsconfig.json
@@ -0,0 +1,19 @@
+{
+	"extends": "./.svelte-kit/tsconfig.json",
+	"compilerOptions": {
+		"allowJs": true,
+		"checkJs": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"resolveJsonModule": true,
+		"skipLibCheck": true,
+		"sourceMap": true,
+		"strict": true,
+		"moduleResolution": "bundler"
+	}
+	// Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
+	// except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
+	//
+	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+	// from the referenced tsconfig.json - TypeScript does not merge them in
+}
diff --git a/e2e-tests/test-applications/sveltekit-tracing-test-app/vite.config.ts b/e2e-tests/test-applications/sveltekit-tracing-test-app/vite.config.ts
@@ -0,0 +1,6 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+	plugins: [sveltekit()]
+});
diff --git a/e2e-tests/tests/sveltekit-tracing.test.ts b/e2e-tests/tests/sveltekit-tracing.test.ts
@@ -0,0 +1,235 @@
+import * as path from 'node:path';
+import * as fs from 'node:fs';
+import { Integration } from '../../lib/Constants';
+import {
+  checkEnvBuildPlugin,
+  checkFileExists,
+  checkIfBuilds,
+  checkIfRunsOnDevMode,
+  checkIfRunsOnProdMode,
+  checkPackageJson,
+  cleanupGit,
+  getWizardCommand,
+  initGit,
+  revertLocalChanges,
+  TEST_ARGS,
+} from '../utils';
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+//@ts-expect-error - clifty is ESM only
+import { KEYS, withEnv } from 'clifty';
+
+describe('Sveltekit with instrumentation and tracing', () => {
+  describe('without existing files', () => {
+    const projectDir = path.resolve(
+      __dirname,
+      '../test-applications/sveltekit-tracing-test-app',
+    );
+
+    const integration = Integration.sveltekit;
+    let wizardExitCode: number;
+
+    beforeAll(async () => {
+      initGit(projectDir);
+      revertLocalChanges(projectDir);
+
+      wizardExitCode = await withEnv({
+        cwd: projectDir,
+      })
+        .defineInteraction()
+        .expectOutput(
+          'The Sentry SvelteKit Wizard will help you set up Sentry for your application',
+        )
+        .step('package installation', ({ expectOutput, whenAsked }) => {
+          whenAsked('Please select your package manager.').respondWith(
+            KEYS.DOWN,
+            KEYS.ENTER,
+          );
+          expectOutput('Installing @sentry/sveltekit');
+        })
+        .step('SDK setup', ({ whenAsked }) => {
+          whenAsked('Do you want to enable Tracing', {
+            timeout: 90_000, // package installation can take a while in CI
+          }).respondWith(KEYS.ENTER);
+          whenAsked('Do you want to enable Session Replay').respondWith(
+            KEYS.ENTER,
+          );
+          whenAsked('Do you want to enable Logs').respondWith(KEYS.ENTER);
+        })
+        .whenAsked('Do you want to create an example page')
+        .respondWith(KEYS.ENTER)
+        .whenAsked(
+          'Optionally add a project-scoped MCP server configuration for the Sentry MCP?',
+        )
+        .respondWith(KEYS.DOWN, KEYS.ENTER)
+        .expectOutput('Successfully installed the Sentry SvelteKit SDK!')
+        .run(getWizardCommand(integration));
+    });
+
+    afterAll(() => {
+      revertLocalChanges(projectDir);
+      cleanupGit(projectDir);
+    });
+
+    it('exits with exit code 0', () => {
+      expect(wizardExitCode).toBe(0);
+    });
+
+    it('adds the SDK dependency to package.json', () => {
+      checkPackageJson(projectDir, integration);
+    });
+
+    it('adds the .env.sentry-build-plugin', () => {
+      checkEnvBuildPlugin(projectDir);
+    });
+
+    it('adds the example page', () => {
+      checkFileExists(
+        path.resolve(projectDir, 'src/routes/sentry-example-page/+page.svelte'),
+      );
+      checkFileExists(
+        path.resolve(projectDir, 'src/routes/sentry-example-page/+server.js'),
+      );
+    });
+
+    it('adds the sentry plugin to vite.config.ts', () => {
+      const viteConfig = fs.readFileSync(
+        path.resolve(projectDir, 'vite.config.ts'),
+      );
+      expect(viteConfig.toString()).toMatchInlineSnapshot(`
+        "import { sentrySvelteKit } from "@sentry/sveltekit";
+        import { sveltekit } from '@sveltejs/kit/vite';
+        import { defineConfig } from 'vite';
+
+        export default defineConfig({
+        	plugins: [sentrySvelteKit({
+                sourceMapsUploadOptions: {
+                    org: "${TEST_ARGS.ORG_SLUG}",
+                    project: "${TEST_ARGS.PROJECT_SLUG}"
+                }
+            }), sveltekit()]
+        });"
+      `);
+    });
+
+    it('creates the hook files', () => {
+      const clientHooks = fs.readFileSync(
+        path.resolve(projectDir, 'src/hooks.client.ts'),
+      );
+      const serverHooks = fs.readFileSync(
+        path.resolve(projectDir, 'src/hooks.server.ts'),
+      );
+
+      expect(clientHooks.toString()).toMatchInlineSnapshot(`
+        "import { handleErrorWithSentry, replayIntegration } from "@sentry/sveltekit";
+        import * as Sentry from '@sentry/sveltekit';
+
+        Sentry.init({
+          dsn: '${TEST_ARGS.PROJECT_DSN}',
+
+          tracesSampleRate: 1.0,
+
+          // Enable logs to be sent to Sentry
+          enableLogs: true,
+
+          // This sets the sample rate to be 10%. You may want this to be 100% while
+          // in development and sample at a lower rate in production
+          replaysSessionSampleRate: 0.1,
+
+          // If the entire session is not sampled, use the below sample rate to sample
+          // sessions when an error occurs.
+          replaysOnErrorSampleRate: 1.0,
+
+          // If you don't want to use Session Replay, just remove the line below:
+          integrations: [replayIntegration()],
+        });
+
+        // If you have a custom error handler, pass it to \`handleErrorWithSentry\`
+        export const handleError = handleErrorWithSentry();
+        "
+      `);
+
+      expect(serverHooks.toString()).toMatchInlineSnapshot(`
+        "import {sequence} from "@sveltejs/kit/hooks";
+        import * as Sentry from "@sentry/sveltekit";
+        export const handle = sequence(Sentry.sentryHandle(), async ({ event, resolve }) => {
+          const response = await resolve(event);
+          return response;
+        });
+        export const handleError = Sentry.handleErrorWithSentry();"
+      `);
+    });
+
+    it('creates the insturmentation.server file', () => {
+      const instrumentationServer = fs.readFileSync(
+        path.resolve(projectDir, 'src/instrumentation.server.ts'),
+      );
+
+      expect(instrumentationServer.toString()).toMatchInlineSnapshot(`
+        "import * as Sentry from '@sentry/sveltekit';
+
+        Sentry.init({
+          dsn: '${TEST_ARGS.PROJECT_DSN}',
+
+          tracesSampleRate: 1.0,
+
+          // Enable logs to be sent to Sentry
+          enableLogs: true,
+
+          // uncomment the line below to enable Spotlight (https://spotlightjs.com)
+          // spotlight: import.meta.env.DEV,
+        });"
+      `);
+    });
+
+    it('enables tracing and instrumentation in svelte.config.js', () => {
+      const svelteConfig = fs.readFileSync(
+        path.resolve(projectDir, 'svelte.config.js'),
+      );
+      expect(svelteConfig.toString()).toMatchInlineSnapshot(`
+        "import adapter from '@sveltejs/adapter-node';
+        import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+
+        /** @type {import('@sveltejs/kit').Config} */
+        const config = {
+          // Consult https://svelte.dev/docs/kit/integrations#preprocessors
+          // for more information about preprocessors
+          preprocess: vitePreprocess(),
+
+          kit: {
+            // adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
+            // If your environment is not supported, or you settled on a specific environment, switch out the adapter.
+            // See https://svelte.dev/docs/kit/adapters for more information about adapters.
+            adapter: adapter(),
+            experimental: {
+              remoteFunctions: true,
+
+              tracing: {
+                server: true,
+              },
+
+              instrumentation: {
+                server: true,
+              },
+            },
+          },
+        };
+
+        export default config;"
+      `);
+    });
+
+    // checkSvelteKitProject(projectDir, integration);
+    it('builds successfully', async () => {
+      await checkIfBuilds(projectDir);
+    });
+
+    it('runs on dev mode correctly', async () => {
+      await checkIfRunsOnDevMode(projectDir, 'ready in');
+    });
+
+    it('runs on prod mode correctly', async () => {
+      await checkIfRunsOnProdMode(projectDir, 'to expose', 'preview');
+    });
+  });
+});
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		// place files you want to import through the `$lib` alias in this folder.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<h1>Welcome to SvelteKit</h1>
		<p>Visit <a href="https://svelte.dev/docs/kit">svelte.dev/docs/kit</a> to read the documentation</p>