Sentry module for Nuxt.js

The module enables error logging through Sentry.

Please note that version 2.0.0 of this package introduces a breaking change. See #30 for more information.

• Add @nuxtjs/sentry dependency using yarn or npm to your project
• Add @nuxtjs/sentry to modules section of nuxt.config.js

{
  modules: [
    '@nuxtjs/sentry',
  ],

  sentry: {
      public_key: '',
      project_id: '',
      config: {
        // Additional config
      },
    }
}

Versions of NuxtJS between v1.0.0 and v1.2.1 are not supported by this package.

Enter your DSN in the NuxtJS config file. Additional config settings can be found here.

In a Vue component, Sentry is available as this.$sentry, so we can call functions like

this.$sentry.captureException(new Error('example'))

where this is a Vue instance.

Options can be passed using either environment variables or sentry section in nuxt.config.js. Normally setting required DSN information would be enough.

• Type: String
  • Default: process.env.SENTRY_DSN

• Type: String
  • Default: process.env.SENTRY_PUBLIC_KEY

Will be ignored if dsn provided.

• Type: String
  • Default: process.env.SENTRY_HOST || 'sentry.io'

Will be ignored if dsn provided.

• Type: String
  • Default: process.env.SENTRY_PROTOCOL || 'https'

Will be ignored if dsn provided.

• Type: String
  • Default: process.env.SENTRY_PROJECT_ID || ''

Will be ignored if dsn provided.

• Type: String
  • Default: process.env.SENTRY_PATH || '/'

Will be ignored if dsn provided.

• Type: Boolean
  • Default: process.env.SENTRY_DISABLED || false

• Type: Boolean
  • Default: process.env.SENTRY_DISABLE_CLIENT_SIDE || false

MIT License

Copyright (c) Diederik van den Burger [email protected]