@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

8.22.0

Important Changes

• feat(cloudflare): Add plugin for cloudflare pages (#13123)

This release adds support for Cloudflare Pages to @sentry/cloudflare, our SDK for the Cloudflare Workers JavaScript Runtime! For details on how to use it, please see the README. Any feedback/bug reports are greatly appreciated, please reach out on GitHub.

// functions/_middleware.js
import * as Sentry from '@sentry/cloudflare';

export const onRequest = Sentry.sentryPagesPlugin({
  dsn: __PUBLIC_DSN__,
  // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
  tracesSampleRate: 1.0,
});

Other Changes

• feat(meta-sdks): Remove runtime tags (#13105)
• feat(nestjs): Automatic instrumentation of nestjs guards (#13129)
• feat(nestjs): Filter all HttpExceptions (#13120)
• feat(replay): Capture exception when internal_sdk_error client report happens (#13072)
• fix: Use globalThis for code injection (#13132)