[JavaScript] Nuxt SDK

[stephanie-anderson]

Important

This issue is tracking progress on the Nuxt SDK. If you find bugs or problems with the @sentry/nuxt package please open a separate issue. Thank you!

New SDK for https://nuxt.com/

There is an existing discussion: Sentry SDK for Nuxt

Nuxt uses nitro as their server, this means we'll need to have nitro support. It might make sense for us to create an OpenTelemetry instrumentation for nitro. It will also be valuable to add similar instrumentation for the other libraries Nuxt relies on:

• crossws: their websocket wrapper: https://crossws.unjs.io/
• db0: their database wrapper: https://github.com/unjs/db0
• unstorage: their key/value storage wrapper: https://github.com/unjs/unstorage

Alpha

Beta Give feedback

1. Add Nuxt SDK package boilerplate #12572
   Package: nuxt +1
2. Add client (vue) instrumentation
3. sentryNuxtPlugin for error handling
4. Add server (nitro) instrumentation #12795
   +0
5. Add side effect import of sentry config to Nuxt app #12759
   Package: nuxt +1
6. Add E2E tests
7. Add craft entry for Nuxt SDK
8. Nuxt: Add source maps support #13017
   +0
9. Nuxt: Route Parametrization #13067
   +0
10. Nuxt: Connected traces #13097
    +0

Beta

Beta Give feedback

1. Create Nuxt Platfrom in Sentry
2. Nuxt: Source Maps support for server-side #13383
   +0
3. Create Docs for Nuxt #13239
   +0
4. Add icon for Nuxt platformicons#174
   +0
5. [Nuxt] Cannot set release name used by sentry-vite-plugin #13380
   Package: nuxt +1
   
6. feat(nuxt): Add server config to root folder #13583
   Package: nuxt +1
7. Nuxt: Vue component tracking test(nuxt): Add tests for Vue component tracking #13633
8. [Nuxt] Improve tracing functionality in ESM #13943
   Package: nuxt +1
   
9. Vercel Function Deployment: feat(nuxt): Add Http responseHook with waitUntil #13986
10. Sourcemaps and events with debug ids are not matching #13997
    Package: nuxt +1
    

Stable Release

Beta Give feedback

1. Nuxt 4 Support feat(nuxt): Add E2E test for Nuxt 4 preview #13799
2. [nuxt] Error in pnpm nuxt dev mode: Cannot use import statement outside a module #13917
   Package: nuxt +1
   
3. Nuxt: Compatibility with different Deployment Platforms #14029
   11 of 18
   +0
   
4. Nuxt: Make use of Pinia Plugin in Nuxt #14039
   +0
   

TODO but not necessary for stable

Beta Give feedback

1. Nitro Route Parametrization
2. Wizard
3. Nuxt: Server side works in development mode

Nice to have/Stretch Goals

Beta Give feedback

1. Add Nuxt pages router instrumentation
2. Add Nuxt pages router unit tests #13813
   Package: nuxt Type: Tests +2
3. Add support for Nuxt Layers
4. Add worker runtime support
5. (if needed) Add native Nitro server engine support
6. (if needed) Instrument Nuxt $fetch
7. Instrument useError composable
8. Nuxt vs Cloudflare interop #13949
   Package: cloudflare Package: nuxt +2
9. Nuxt (optional): Make it possible to use runtime config in external file #13341
   Package: nuxt +1

[AbhiPrasad]

See #6929

[manniL]

If you need insights from the Nuxt team at any time, please don't hesitate to reach out! 🙏

[cosbgn]

This is such a great news!

It would be ideal that it would work on all envs.
Nuxt works very well on the edge (cloudflare workers, netlify edge, etc), however not all libraries are compatible as there are some restrictions (no eval, no new Function(), etc).

It would be great if sentry/nuxt would work everywhere from day one.

[s1gr1d]

@cosbgn Thanks for the input! Which libraries do you mean with "not all libraries are compatible"?

[cosbgn]

@cosbgn Thanks for the input! Which libraries do you mean with "not all libraries are compatible"?

Hi @s1gr1d, I don't have an extensive list, but for example AJV doesn't work. Workers don't use node, they use their own runtime (workerd) which is limited to web standards (similarly to deno).

I think if you use only sentry/core it should work as it's used by toucan-js which is an unofficial client for cloudflare workers. I think sentry/node won't work by default, but I might be wrong here.

[cosbgn]

This is of course for the backend part of nuxt, i.e. nitro. On the frontend sentry/vue should work perfectly.

[alexcroox]

I use Sentry on my APIs (fullstack Nuxt 3 deployment to Cloudflare pages) with the sentry/browser package on the API side to get around edge restrictions.

The context Sentry devs, for cosbgn's comment, is that Nuxt 3 was built with the "deploy anywhere" ethos, so all the core packages and (new) community modules are designed to be runtime agnostic. That's where https://unjs.io/ was born from.

I initially followed this guide if it helps at all with the PR in general https://www.lichter.io/articles/nuxt3-sentry-recipe (written by a core Nuxt 3 dev)

[lforst]

While we may not support worker (WinterCG) runtimes from the start we will look into it eventually. We are planning to release the SDK iteratively and in stages. Prioritization of worker runtime support depends of course a bit on the demand. I added an item to the list to track. Technically we have all the building blocks available.

[cosbgn]

I don't have any specific data, but from my understanding a big percent of nuxt apps are deployed on the edge (vercel-edge, workers, netlify edge, etc) as you get better performance for lower costs, and Nuxt pretty much "guarantees" that it will work on the edge, so it's an obvious solution.

I understand if you decide not to prioritize it, I just wanted to let you know that it would be great to have it from day one. It might be as simple as using sentry/core rather than sentry/node (I don't know, just an example).

Anyways, thanks for the first party package, love sentry and I would love to be able to add it to Nuxt easily!

[gloompiq]

Great initiative!

Could we also make sure that errors before the hydration are also handled?

[s1gr1d]

We want to monitor as many as possible. The first release of the SDK will cover monitoring the majority of errors and we will definitely improve it over time

[s1gr1d]

@BlazingTide If there is an issue with the experimental SDK feel free to open a new issue in our repository as it makes it easier to keep track of things 🙌

I am not sure what you mean with "sitemaps" - we don't generate sitemaps. In case you mean source maps: Yes, they are generated and uploaded automatically if you provide the sourceMapsUploadOptions and you don't need another command :)

[ps-20x]

Thanks for the input! I'm not quite sure how nuxt scripts can be used here. Perhaps you could explain a little more about how you thought this could be used in the SDK :)

So the idea is to optimize the page loading performance by using nuxt scripts and prevent possible errors with SSR. For example it provides a proxy object to track events and will fire them when it is fully set up.
The slogan on the page says

Nuxt Scripts lets you load third-party scripts with better performance, privacy, security and DX

and

Nuxt Scripts provides an abstraction layer on top of third-party scripts, providing SSR support and type-safety and while still giving you full low-level control over how a script is loaded.

But as mentioned before: I am not sure if it would be possible to adapt the logic so it could be integrated.

[lforst]

@ps-20x Re: nuxt scripts. I think we need to look into it a bit further. Superficially I can say that the upside it gives is probably very slim since the Sentry SDK needs to load very early on in the pageload for a bunch of important features (errors, performance, replay). The DX is definitely an argument.

For now, I think we'll try to focus on shipping a robust SDK without using nuxt scripts but there is nothing that prevents us from migrating to that pattern later on. (also note that nuxt scripts are in beta - to some degree atleast)

[s1gr1d]

The Beta Version of the Sentry Nuxt SDK is released with v8.35.0 🎉

Please make sure to check out the readme and the docs as there are breaking changes (no --import CLI flag needed anymore)

[daniluk4000]

@s1gr1d are breaking changes still expected or can we work on implementation now?

[s1gr1d]

Beta means no breaking changes to the API, but it could include behavioral changes.

[darthf1]

Is it possible to inject the Sentry's Pinia plugin via a flag in the nuxt config as well?

Looking at https://github.com/prazdevs/pinia-plugin-persistedstate/blob/main/src/runtime/plugin.ts, it looks like you need create a nuxt plugin and then add the sentry plugin to pinia in there. (And of course check first if pinia is installed, and if Sentry is enabled).

[luc122c]

Hi, there is a typo in the readme:

sentry-javascript/packages/nuxt/README.md

Line 78 in 146e7dc

Add an `sentry.client.config.ts` file to the root of your project:

It should say sentry.server.config.ts like in the docs.

[rocketiscool]

Getting

node:internal/modules/esm/resolve:265
throw new ERR_MODULE_NOT_FOUND(
^

Error [ERR_MODULE_NOT_FOUND]: Cannot find module 'web/apps/web/.output/server/node_modules/import-in-the-middle/hook.mjs' imported from web/apps/web/.output/server/index.mjs

When following the installation instructions even with

"overrides": {
"@vercel/nft": "^0.27.4"
}

Update: Turns out in pnpm workspaces, you have to put

"pnpm": {
"overrides": {
"@vercel/nft": "0.27.4"
}
}

in the root package.json instead

[s1gr1d]

Thanks for trying out the beta, will update this in the docs and the readme! :)

[asokawotulo]

I'm not sure if I should leave a comment here or open a new issue, but I'm getting the following error when using this with @nuxt/content and running npm run build

[plugin inject] .nuxt/snapshot/cache/content/parsed/content/document.md: rollup-plugin-inject: failed to parse /home/projects/nuxt-starter-ye7qhs/.nuxt/snapshot/cache/content/parsed/content/document.md. Consider restricting the plugin to particular files via options.include

I made a reproduction here. You can toggle the module in the nuxt.config.ts file and run npm run build

[s1gr1d]

In general, its better to create a new issue as it's more organized and we have a better overview :)
Thanks for the reproduction! This could be a problem between rollup plugins (as we added one in v8.35.0). I'll take a look into this and created an issue here: #14057

As a temporary workaround, you can disable this with dynamicImportForServerEntry like documented in the changelog.

[ThibaultVlacich]

Currently if the sentry server is down, it crashes the build completely:

[error] x Build failed in 51.44s
[error] Nuxt Build Error: [sentry-debug-id-upload-plugin] Command failed: /home/vsts/work/1/s/node_modules/@sentry/cli-linux-x64/bin/sentry-cli releases finalize 219448[...]74188
error: API request failed

Caused by:
    sentry reported an error: gateway timeout (http status: 504)

Any way to make it just a warning?

[mydea]

Currently if the sentry server is down, it crashes the build completely:

[error] x Build failed in 51.44s
[error] Nuxt Build Error: [sentry-debug-id-upload-plugin] Command failed: /home/vsts/work/1/s/node_modules/@sentry/cli-linux-x64/bin/sentry-cli releases finalize 219448[...]74188
error: API request failed

Caused by:
    sentry reported an error: gateway timeout (http status: 504)

Any way to make it just a warning?

You can configure a custom errorHandler in the sentry vite plugin that nuxt adds like this:
https://www.npmjs.com/package/@sentry/vite-plugin#errorhandler

[chargome]

@ThibaultVlacich in your case you would need to add this to your nuxt config:

sentry: {
    unstable_sentryBundlerPluginOptions: {
      errorHandler: // handle your error
    }
  }

If you face any other problems please open up a new issue directly 🙏