@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.29.0

Important Changes

• Beta releases of official Solid and SolidStart Sentry SDKs

This release marks the beta releases of the @sentry/solid and @sentry/solidstart Sentry SDKs. For details on how to use them, check out the Sentry Solid SDK README and the Sentry SolidStart SDK README respectively. Please reach out on GitHub if you have any feedback or concerns.

• feat(node): Option to only wrap instrumented modules (#13139)

Adds the SDK option to only wrap ES modules with import-in-the-middle that specifically need to be instrumented.

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

Sentry.init({
  dsn: '__PUBLIC_DSN__',
  registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true },
});

• feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 (#13587)

All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode.

Other Changes

• feat(nextjs): Emit warning when using turbopack (#13566)
• feat(nextjs): Future-proof Next.js config options overriding (#13586)
• feat(node): Add generic-pool integration (#13465)
• feat(nuxt): Upload sourcemaps generated by Nitro (#13382)
• feat(solidstart): Add browserTracingIntegration by default (#13561)
• feat(solidstart): Add sentrySolidStartVite plugin to simplify source maps upload (#13493)
• feat(vue): Only start UI spans if parent is available (#13568)
• fix(cloudflare): Guard context.waitUntil call in request handler (#13549)
• fix(gatsby): Fix assets path for sourcemaps upload (#13592)
• fix(nextjs): Use posix paths for sourcemap uploads (#13603)
• fix(node-fetch): Use stringified origin url (#13581)
• fix(node): Replace dashes in generic-pool span origins with underscores (#13579)
• fix(replay): Fix types in WebVitalData (#13573)
• fix(replay): Improve replay web vital types (#13602)
• fix(utils): Keep logger on carrier (#13570)

Work in this release was contributed by @Zen-cronic. Thank you for your contribution!