Skip to content

feat(sveltekit): Add wrapServerRouteWithSentry wrapper #13247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 8, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Aug 6, 2024

Quick side-quest: This PR adds a wrapper for SvelteKit server routes. The reason is that some errors (e.g. sveltekit error() calls) are not caught within server (API) routes, as reported in #13224 because in contrast to load function we don't directly try/catch the function invokation.

For now, users will have to add this wrapper manually. At a later time we can think about auto instrumentation, similarly to load functions but for now this will remain manual.

This wrapper:

  • starts a span for the server route
  • captures "normal" Error-like errors
  • captures error() errors if the status is >=500

Usage example:

import { wrapServerRouteWithSentry } from '@sentry/sveltekit';
import { error } from '@sveltejs/kit';

export const GET = wrapServerRouteWithSentry(async () => {
  error(500, 'error() error');
});

Resulting span:

image

Related changes:

  • extracted sendErrorToSentry as it's universally used in server-side wrappers
  • added unit tests
  • added e2e test

closes #13224

docs PR: getsentry/sentry-docs#10990

@Lms24 Lms24 requested review from lforst and andreiborza August 6, 2024 08:37
@Lms24 Lms24 self-assigned this Aug 6, 2024
@Lms24 Lms24 enabled auto-merge (squash) August 8, 2024 12:44
Copy link
Contributor

github-actions bot commented Aug 8, 2024

size-limit report 📦

Path Size
@sentry/browser 22.47 KB (0%)
@sentry/browser (incl. Tracing) 34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay) 70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas) 74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback) 87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 89.16 KB (0%)
@sentry/browser (incl. metrics) 26.77 KB (0%)
@sentry/browser (incl. Feedback) 39.42 KB (0%)
@sentry/browser (incl. sendFeedback) 27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync) 31.75 KB (0%)
@sentry/react 25.24 KB (0%)
@sentry/react (incl. Tracing) 37.25 KB (0%)
@sentry/vue 26.62 KB (0%)
@sentry/vue (incl. Tracing) 36.1 KB (0%)
@sentry/svelte 22.61 KB (0%)
CDN Bundle 23.69 KB (0%)
CDN Bundle (incl. Tracing) 35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay) 70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) 75.61 KB (0%)
CDN Bundle - uncompressed 69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed 106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed 218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 231.16 KB (0%)
@sentry/nextjs (client) 37.1 KB (0%)
@sentry/sveltekit (client) 34.81 KB (0%)
@sentry/node 115.07 KB (-0.36% 🔽)
@sentry/node - without tracing 89.43 KB (-0.48% 🔽)
@sentry/aws-serverless 98.85 KB (-0.46% 🔽)

@Lms24 Lms24 merged commit a67a69e into develop Aug 8, 2024
124 checks passed
@Lms24 Lms24 deleted the lms/feat-sveltekit-wrapServerRouteWithSentry branch August 8, 2024 16:37
Lms24 added a commit to getsentry/sentry-docs that referenced this pull request Aug 9, 2024
…0990)

adds documentation for the new `wrapServerRouteWithSentry` function we added in getsentry/sentry-javascript#13247. 

---------

Co-authored-by: Nicolas Hrubec <nicolas.hrubec@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sveltekit errors are not captured by sentry
2 participants