Nuxt

Learn how to set up and configure Sentry in your Nuxt application using the installation wizard, capture your first errors, and view them in Sentry.

You need:

  • A Sentry account and project
  • Your application up and running
  • Nuxt version 3.7.0 or above (3.14.0+ recommended)

To install Sentry using the installation wizard, run the following command within your project:

Copied
npx @sentry/wizard@latest -i nuxt

The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring.

Want to learn more about these features?
  • Issues (always enabled): Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and unhandled rejections. If you have something that looks like an exception, Sentry can capture it.
  • Tracing: Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back.
  • Session Replay: Get to the root cause of an issue faster by viewing a video-like reproduction of what was happening in the user's browser before, during, and after the problem.

This guide assumes that you enable all features and allow the wizard to create an example page or component. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later.

What does the installation wizard change inside your application?
  • Creates sentry.(client|server).config.ts to initialize the SDK
  • Creates or updates your nuxt.config.ts to add build options to add source maps upload and auto-instrumentation via Vite plugins
  • Creates .env.sentry-build-plugin with an auth token to upload source maps (this file is automatically added to .gitignore)
  • Adds an example page and route to your application to help verify your Sentry setup
    • If it couldn't create a page, the wizard adds an example component instead

If you haven't tested your Sentry configuration yet, let's do it now. You can confirm that Sentry is working properly and sending data to your Sentry project by using the example page created by the installation wizard.

The wizard created an example component instead of a page.

The wizard creates a SentryErrorButton component when it fails to add an example page to your project. This usually happens if you don't have a app.vue file or if that file does not contain the NuxtPage component. To verify your setup, follow these steps before continuing with the next section, "View Captured Data in Sentry":

  1. Add the SentryErrorButton component to a page and open it in your browser. For most Nuxt applications, this will be at localhost.
  2. Click the "Throw Sample Error" button, which triggers an error and starts a performance trace on the client side.

To test the server side as well, refer to the "Verify" section in the Manual setup guide.

To test Sentry on the server side, you first need to build your project since Sentry's server-side monitoring doesn't work in development mode.
Then run your project and make sure to load Sentry on the server side by explicitly adding it via --import:

Copied
# Start your app after building your project with `nuxi build`
node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs

After building and running your project:

  1. Open the example page /sentry-example-page in your browser. For most Nuxt applications, this will be at localhost.
  2. Click the "Throw sample error" button. This triggers two errors:
    • a frontend error
    • an error within the API route

Sentry captures both of these errors for you. Additionally, the button click starts a performance trace to measure the time it takes for the API request to complete.

Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).

Need help locating the captured errors in your Sentry project?
  1. Open the Issues page and select an error from the issues list to view the full details and context of this error. For an interactive UI walkthrough, click here.
  2. Open the Traces page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click here.
  3. Open the Replays page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot.

At this point, you should have integrated Sentry into your Nuxt application and should already be sending error and performance data to your Sentry project.

Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:

Are you having problems setting up the SDK?
Previous
Welcome to Sentry
Next
Manual Setup
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").