Setup
Check the Nuxt.js documentation for more information about installing and using modules in Nuxt.js.
Nuxt.js v2.4.0+ is required, earlier versions are not supported
Installation
Add @nuxtjs/sentry
dependency to your project:
yarn add @nuxtjs/sentry
npm install @nuxtjs/sentry
Then, add @nuxtjs/sentry
to the modules
section of nuxt.config.js
and set your unique dsn
value:
{
modules: [
'@nuxtjs/sentry'
],
sentry: {
dsn: '', // Enter your project's DSN.
// Additional module options go here.
}
}
See Options for a list of available options.
Note that the Sentry SDK dependencies (@sentry/*
) are not pinned and can be updated independently from the module itself by running npm upgrade @nuxtjs/sentry
or yarn upgrade @nuxtjs/sentry
. That means you don't have to wait for a new module release if you want to update to the latest SDK version.
Types
In Typescript or type-checked JavaScript projects, add @nuxtjs/sentry
to the types
array in tsconfig.json
to enable module types.
{
"compilerOptions": {
// ...
"types": [
"@nuxtjs/sentry"
]
}
}
The otherwise optional packages @sentry/tracing
and @sentry/webpack-plugin
have to be installed for types to be fully working.
If not using the relevant functionality (tracing
and publishRelease
options are not enabled) then those packages can be installed as dev-only dependencies.