sentry-svelte-sdk

Full Sentry SDK setup for Svelte and SvelteKit. Use when asked to "add Sentry to Svelte", "add Sentry to SvelteKit", "install @sentry/sveltekit", or configure error monitoring, tracing, session replay, or logging for Svelte or SvelteKit applications.

By getsentry · 1,947 installs

npx skills add getsentry/sentry-for-ai --skill sentry-svelte-sdk

Source repository · Upstream listing

[All Skills](../../SKILL TREE.md) [SDK Setup](../sentry sdk setup/SKILL.md) Svelte SDK Sentry Svelte SDK Opinionated wizard that scans your project and guides you through complete Sentry setup for Svelte and SvelteKit. Invoke This Skill When User asks to "add Sentry to Svelte" or "set up Sentry" in a Svelte/SvelteKit app User wants error monitoring, tracing, session replay, or logging in Svelte or SvelteKit User mentions @sentry/svelte , @sentry/sveltekit , or Sentry SDK for Svelte Note: SDK versions and APIs below reflect current Sentry docs at time of writing ( @sentry/sveltekit ≥10.8.0, SvelteKit ≥2.31.0). Always verify against [docs.sentry.io/platforms/javascript/guides/sveltekit/](https://docs.sentry.io/platforms/javascript/guides/sveltekit/) before implementing. Phase 1: Detect Run these commands to understand the project before making any recommendations: What to determine: Question Impact @sveltejs/kit in package.json ? SvelteKit path vs. plain Svelte path SvelteKit ≥2.31.0? Modern ( instrumentation.server.ts ) vs. legacy setup @sentry/sveltekit already present? Skip install, go straight to feature config vite.config.ts present? Source map upload via Vite plugin available Backend directory found? Trigger Phase 4 cross link suggestion Phase 2: Recommend Present a concrete recommendation based on what you found. Don't ask open ended questions — lead with a proposal: Recommended (core coverage): ✅ Error Monitoring — always; auto captures unhandled errors on client and server ✅ Tracing — SvelteKit has both client side navigation spans and server side request spans; always recommend ✅ Session Replay — recommended for user facing SvelteKit apps (client side only) Optional (enhanced observability): ⚡ Logging — structured logs via Sentry.logger. ; recommend when app uses server side logging or needs log to trace correlation Recommendation logic: Feature Recommend when... Error Monitoring Always — non negotiable baseline Tracing Always for SvelteKit (client + server); for plain Svelte when calling APIs Session Replay User facing app, login flows, or checkout pages present Logging App already uses server side logging, or structured log search is needed Propose: "I recommend setting up Error Monitoring + Tracing + Session Replay. Want me to also add structured Logging?" Phase 3: Guide Determine Setup Path Your project Package Setup complexity SvelteKit (≥2.31.0) @sentry/sveltekit 5 files to create/modify SvelteKit (<2.31.0) @sentry/sveltekit 3 files (init in hooks.server.ts) Plain Svelte (no @sveltejs/kit ) @sentry/svelte Single entry point Path A: SvelteKit (Recommended — Modern, ≥2.31.0) Option 1: Wizard (Recommended) You need to run this yourself — the wizard opens a browser for login and requires interactive input that the agent can't handle. Copy paste into your terminal: It handles login, org/project selection, SDK installation, client/server hooks, Vite plugin config, source map upload, and adds a /sentry example page . Once it finishes, come back and skip to [Verification]( verification). If the user skips the wizard, proceed with Option 2 (Manual Setup) below. Option 2: Manual Setup Step 1 — Install Step 2 — svelte.config.js — Enable instrumentation Step 3 — src/instrumentation.server.ts — Server side init (runs once at startup) Step 4 — src/hooks.client.ts — Client side init Step 5 — src/hooks.server.ts — Server hooks (no init here in modern setup) Step 6 — vite.config.ts — Source maps (requires SENTRY AUTH TOKEN ) Add to .env (never commit): Path B: SvelteKit Legacy (<2.31.0 or @sentry/sveltekit <10.8.0) Skip instrumentation.server.ts and svelte.config.js changes. Instead, put Sentry.init() directly in hooks.server.ts : hooks.client.ts and vite.config.ts are identical to the modern path. Path C: Plain Svelte (no SvelteKit) Install: Configure in entry point ( src/main.ts or src/main.js ) before mounting the app: Optional: Svelte component tracking (auto injects tracking into all components): For Each Agreed Feature Walk through features one at a time. Load the reference file, follow its steps, then verify before moving on: Feature Reference Load when... Error Monitoring ${SKILL ROOT}/references/error monitoring.md Always (baseline) Tracing ${SKILL ROOT}/references/tracing.md API calls / distributed tracing needed Session Replay ${SKILL ROOT}/references/session replay.md User facing app Logging ${SKILL ROOT}/references/logging.md Structured logs / log to trace correlation For each feature: Read ${SKILL ROOT}/references/<feature .md , follow steps exactly, verify it works. Configuration Reference Key Sentry.init() Options Option Type Default Notes dsn string — Required. Use env var; SDK is disabled when empty environment string "production" e.g., "staging" , "development" release string — e.g., "my app@1.2.3" or git SHA dataCollection object — Control what data is collected (userInfo, cookies, headers, etc.) dataCollection.userInfo boolean true Auto populate user. fields from instrumentation dataCollection.cookies boolean\ object true Cookie collection and filtering dataCollection.httpHeaders object {request: true, response: true} HTTP header collection for requests/responses dataCollection.httpBodies string[] ["incomingRequest", "outgoingRequest", "incomingResponse", "outgoingResponse"] Which HTTP body types to collect dataCollection.queryParams boolean\ object true Query parameter collection and filtering tracesSampleRate number — 0–1; use 1.0 in dev, 0.1–0.2 in prod tracesSampler function — Per transaction sampling; overrides tracesSampleRate tracePropagationTargets (string\ RegExp)[] — URLs that receive distributed tracing headers replaysSessionSampleRate number — Fraction of all sessions recorded (client only) replaysOnErrorSampleRate number — Fraction of error sessions recorded (client only) enableLogs boolean false Enable Sentry.logger. API beforeSendLog function — Filter/modify logs before send debug boolean false Verbose SDK output to console Server Only Options ( instrumentation.server.ts / hooks.server.ts ) Option Type Notes serverName string Hostname tag on server events includeLocalVariables boolean Attach local vars to stack frames shutdownTimeout number ms to flush events before process exit (default: 2000) Adapter Compatibility Adapter Support @sveltejs/adapter auto / adapter vercel (Node) ✅ Full @sveltejs/adapter node ✅ Full @sveltejs/adapter cloudflare ⚠️ Partial — requires extra setup Vercel Edge Runtime ❌ Not supported SvelteKit File Summary File Purpose Modern Legacy src/instrumentation.server.ts Server Sentry.init() — runs once at startup ✅ Required ❌ src/hooks.client.ts Client Sentry.init() + handleError ✅ Required ✅ Required src/hooks.server.ts handleError + sentryHandle() (no init) ✅ Required ✅ Init goes here svelte.config.js Enable experimental.instrumentation.server ✅ Required ❌ vite.config.ts sentrySvelteKit() plugin for source maps ✅ Recommended ✅ Recommended .env SENTRY AUTH TOKEN , SENTRY ORG , SENTRY PROJECT ✅ For source maps ✅ For source maps Verification After setup, trigger test events to confirm Sentry is receiving data: Check the Sentry dashboard: Issues → both errors should appear within seconds Traces → look for route based transactions Replays → session recording visible after page interaction Logs → structured log entries (if logging enabled) If nothing appears, set debug: true in Sentry.init() and check the browser/server console for SDK output. Phase 4: Cross Link After completing Svelte/SvelteKit setup, check for a companion backend missing Sentry coverage: If a backend exists without Sentry configured, suggest the matching skill: Backend detected Suggest skill Go ( go.mod ) sentry go sdk Python ( requirements.txt , pyproject.toml ) sentry python sdk Ruby ( Gemfile ) sentry ruby sdk Node.js (Express, Fastify, etc.) Use @sentry/node — see [docs.sentry.io/platforms/javascript/guides/express/](https://docs.sentry.io/platforms/javascript/guides/express/) Troubleshooting Issue Solution Events not appearing Set debug: true , check DSN, open browser console for SDK errors Source maps not working Run npm run build (not dev ), verify SENTRY AUTH TOKEN is set Server errors not captured Ensure handleErrorWithSentry() is exported from hooks.server.ts Client errors not captured Ensure handleErrorWithSentry() is exported from hooks.client.ts Session replay not recording Confirm replayIntegration() is in client init only (never server) sentryHandle() + other handles not composing Wrap with sequence(Sentry.sentryHandle(), myHandle) Ad blocker blocking events Set tunnel: "/sentry tunnel" and add a server side relay endpoint SvelteKit instrumentation not activating Confirm experimental.instrumentation.server: true in svelte.config.js Cloudflare adapter issues Consult [docs.sentry.io/platforms/javascript/guides/sveltekit/](https://docs.sentry.io/platforms/javascript/guides/sveltekit/) for adapter specific notes wrapLoadWithSentry / wrapServerLoadWithSentry errors These are legacy wrappers — remove them; sentryHandle() instruments load functions automatically in ≥10.8.0