@sentry/svelte

Official Sentry SDK for Svelte

This SDK currently only supports Svelte apps in the browser. If you're using SvelteKit, we recommend using our dedicated Sentry SvelteKit SDK.

General

This package is a wrapper around @sentry/browser, providing error monitoring and basic performance monitoring features for Svelte.

To use the SDK, initialize Sentry in your Svelte entry point main.js before you bootstrap your Svelte app:

// main.js / main.ts

import App from './App.svelte';

import * as Sentry from '@sentry/svelte';

// Initialize the Sentry SDK here
Sentry.init({
  dsn: '__DSN__',
  release: 'my-project-name@2.3.12',
  integrations: [Sentry.browserTracingIntegration()],

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production
  tracesSampleRate: 1.0,
});

// Then bootstrap your Svelte app
const app = new App({
  target: document.getElementById('app'),
});

export default app;

The Sentry Svelte SDK supports all features from the @sentry/browser SDK. Until it becomes more stable, please refer to the Sentry Browser SDK documentation for more information and usage instructions.

Sourcemaps and Releases

To generate source maps of your Svelte app bundle, check our guide how to configure your bundler to emit source maps.

To create releases and upload source maps to Sentry, we recommend using sentry-cli. You can for instance create a bash script to take care of creating a release, uploading source maps and finalizing the release:

#!/bin/bash

VERSION=<your version>
ORG=<your org-slug>
PROJECT=<your project-slug>

SOURCEMAPS_PATH=./dist

sentry-cli releases new $VERSION --org $ORG --project $PROJECT
sentry-cli releases files $VERSION upload-sourcemaps $SOURCEMAPS_PATH --org $ORG --project $PROJECT
sentry-cli releases finalize $VERSION  --org $ORG --project $PROJECT

Please note that the paths provided in this example work for a typical Svelte project that adheres to the project structure set by create-vite with the svelte(-ts) template. If your project setup differs from this template, your configuration may need adjustments. Please refer to our documentation of Advanced sentry-cli Sourcemaps Options and to our Sourcemaps Troubleshooting Guide.

Check out our Svelte source maps uploading guide for more information.

Changelog

9.37.0

Important Changes

• feat(nuxt): Parametrize SSR routes (#16843)

  When requesting dynamic or catch-all routes in Nuxt, those will now be shown as parameterized routes in Sentry. For example, /users/123 will be shown as /users/:userId() in Sentry. This will make it easier to identify patterns and make grouping easier.

Other Changes

• feat(astro): Deprecate passing runtime config to astro integration (#16839)
• feat(browser): Add beforeStartNavigationSpan lifecycle hook (#16863)
• feat(browser): Detect redirects when emitting navigation spans (#16324)
• feat(cloudflare): Add option to opt out of capturing errors in wrapRequestHandler (#16852)
• feat(feedback): Return the eventId into the onSubmitSuccess callback (#16835)
• feat(vercel-edge): Do not vendor in all OpenTelemetry dependencies (#16841)
• fix(browser): Ensure standalone CLS and LCP spans have traceId of pageload span (#16864)
• fix(nextjs): Use value injection loader on instrumentation-client.ts|js (#16855)
• fix(sveltekit): Avoid capturing redirect() calls as errors in Cloudflare (#16853)
• docs(nextjs): Update deleteSourcemapsAfterUpload jsdoc default value (#16867)

Work in this release was contributed by @zachkirsch. Thank you for your contribution!