Nuxt on Cloudflare

Learn how to instrument your Nuxt app on Cloudflare Pages and capture your first errors with Sentry.

This guide will show you how to set up the SDK with Nitro's cloudflare-pages deployment preset.

You need:

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

Are you using Nuxt version < 3.14.0?

Add the following overrides:

package.json

Copied

"overrides": {
  "ofetch": "^1.4.0",
  "@vercel/nft": "^0.27.4"
}

Choose the features you want to configure, and this guide will show you how:

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.
Logs: Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications.

Run the command for your preferred package manager to add the Sentry SDK to your application:

Copied

npm install @sentry/nuxt --save

Add the Sentry Nuxt module to your nuxt.config.ts file:

nuxt.config.ts

Copied

export default defineNuxtConfig({
  modules: ["@sentry/nuxt/module"],
});

Add a sentry.client.config.ts file to the root of your project (this is probably the same level as the package.json). In this file, import and initialize Sentry, specifying any SDK options for the client:

sentry.client.config.ts

Copied

import * as Sentry from "@sentry/nuxt";

Sentry.init({
  // If set up, you can use the Nuxt runtime config here
  // dsn: useRuntimeConfig().public.sentry.dsn
  // modify depending on your custom runtime config
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0example-org / example-project",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/nuxt/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  //  session-replay

  // Replay may only be enabled for the client-side
  integrations: [
    Sentry.replayIntegration(),
    //  user-feedback
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      colorScheme: "system",
    }),
    //  user-feedback
  ],
  //  session-replay
  //  performance

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for tracing.
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  //  performance
  //  session-replay

  // Capture Replay for 10% of all sessions,
  // plus for 100% of sessions with an error
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/session-replay/configuration/#general-integration-configuration
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
  //  session-replay
  //  logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  //  logs
});

We recommend you store your Sentry Data Source Name (DSN) in an environment variable and configure it via the Nuxt runtime config like so:

nuxt.config.ts

Copied

export default defineNuxtConfig({
  modules: ["@sentry/nuxt"],
  runtimeConfig: {
    public: {
      sentry: {
        dsn: process.env.SENTRY_DSN_PUBLIC, // Use a public environment variable for the DSN
      },
    },
  },
});

This allows you to access the DSN using useRuntimeConfig().public.sentry.dsn.

Since the SDK needs access to the AsyncLocalStorage API, you need to set either the nodejs_compat or nodejs_als compatibility flags in your wrangler.(jsonc|toml) configuration file:

wrangler.jsonc

Copied

{
  "compatibility_flags": [
    "nodejs_als",
    // "nodejs_compat"
  ],
}

Additionally, add the CF_VERSION_METADATA binding in the same file:

wrangler.jsonc

Copied

{
  // ...
  "version_metadata": {
    "binding": "CF_VERSION_METADATA",
  },
}

Important

If you have an existing sentry.server.config.ts file, delete it, as it will conflict with the Cloudflare setup.

To enable Sentry for your Nuxt app on Cloudflare, create a new file in server/plugins and add the following code to it:

server/plugins/sentry-cloudflare-plugin.ts

Copied

import { sentryCloudflareNitroPlugin } from '@sentry/nuxt/module/plugins'

export default defineNitroPlugin(sentryCloudflareNitroPlugin({
  dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0example-org / example-project',
  tracesSampleRate: 1.0,
}))

Or, if you need access to nitroApp:

server/plugins/sentry-cloudflare-plugin.ts

Copied

import { sentryCloudflareNitroPlugin } from '@sentry/nuxt/module/plugins'

export default defineNitroPlugin(sentryCloudflareNitroPlugin((nitroApp: NitroApp) => {
  // You can access `nitroApp` here if needed
  return {
    dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0example-org / example-project',
    tracesSampleRate: 1.0,
  }
}))

To upload source maps for clear error stack traces, add your Sentry auth token, organization, and project slugs in the sentry.sourceMapsUploadOptions inside your configuration file:

These sentry options only affect the build time of the SDK.

nuxt.config.ts

Copied

export default defineNuxtConfig({
  modules: ["@sentry/nuxt/module"],
  sentry: {
    sourceMapsUploadOptions: {
      org: "example-org",
      project: "example-project",
      // store your auth token in an environment variable
      authToken: process.env.SENTRY_AUTH_TOKEN,
    },
  },
});

To keep your auth token secure, always store it in an environment variable instead of directly in your files:

.env

Copied

SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE

While Nuxt generates source maps on the server side by default, you need to explicitly enable client-side source maps in your Nuxt configuration:

nuxt.config.ts

Copied

export default defineNuxtConfig({
  sourcemap: { client: "hidden" },
});

The hidden option enables source map generation while preventing source map reference comments that would normally appear at the end of each generated file in the build output.

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

To verify that Sentry captures errors and creates issues in your Sentry project, create a test page with a button:

pages/example-error.vue

Copied

<script setup>
  import * as Sentry from "@sentry/nuxt";

  function triggerClientError() {
    throw new Error("Nuxt Button Error");
  }
</script>

<template>
  <button id="errorBtn" @click="triggerClientError">
    Throw Client Error
  </button>
</template>

Important

Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring.

To test tracing, create a test API route server/api/sentry-example.get.ts:

server/api/sentry-example.get.ts

Copied

export default defineEventHandler((event) => {
  throw new Error("Sentry Example API Route Error");
});

Then update the test page by including a new button that executes a function to fetch your API route:

pages/example-error.vue

Copied

<script setup>
  import * as Sentry from "@sentry/nuxt";

  function triggerClientError() {
    throw new Error("Nuxt Button Error");
  }

  function getSentryData() {
    Sentry.startSpan(
      {
        name: "Example Frontend Span",
        op: "test",
      },
      async () => {
        await $fetch("/api/sentry-example");
      },
    );
  }
</script>

<template>
  <button id="errorBtn" @click="triggerClientError">
    Throw Client Error
  </button>
  <button type="button" @click="getSentryData">Throw Server Error</button>
</template>

Once you have your test code in place, you need to build your project since Sentry's server-side monitoring doesn't work in development mode.

After running your project:

Open your test page in a browser (for most Nuxt applications, this will be at localhost:3000)
Click the "Throw Client Error" button to trigger an error in the frontend
Click the "Throw Server Error" button to trigger an error within the API route and start 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?

Open the Issues page and select an error from the issues list to view the full details and context of this error. For more details, see this interactive walkthrough.
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.
Open the Logs page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click here.

At this point, you should have integrated Sentry into your Nuxt application and should already be sending 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:

Learn how to manually capture errors
Continue to customize your configuration
Get familiar with Sentry's product features like tracing, insights, and alerts
Learn how to track your Vue components or your Pinia store

Are you having problems setting up the SDK?

Find various support topics in Cloudflare troubleshooting and Nuxt troubleshooting
Get support

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").

How to contribute | Edit this page | Create a docs issue | Get support