@nuxtjs/sentry

@nuxtjs/sentry

Sentry module for Nuxt.js

Features

The module enables error logging through Sentry.

• Please note that version 2.2.0 of this package removed the older public_key and private_key options, since the updated Sentry packages don't support these anymore.
• Please note that version 2.0.0 of this package introduces a breaking change. See #30 for more information.

Setup

• 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: {
    dsn: '', // Enter your project's DSN here
    config: {}, // Additional config
  }
}

Nuxt compatibility

Versions of NuxtJS before v2.4.0 are not supported by this package.

Usage

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

Usage in Vue component

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

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

dsn

• Type: String
  • Default: process.env.SENTRY_DSN || false
  • If no dsn is provided, Sentry will be initialised, but errors will not be logged. See #47 for more information about this.

disabled

• Type: Boolean
  • Default: process.env.SENTRY_DISABLED || false
  • Sentry will not be initialised if set to true.

disableClientSide

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

disableServerSide

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

initialize

• Type: Boolean
  • Default: process.env.SENTRY_INITIALIZE || true

publishRelease

• Type: Boolean
  • Default: process.env.SENTRY_PUBLISH_RELEASE || false
  • See https://docs.sentry.io/workflow/releases for more information

disableServerRelease

• Type: Boolean
  • Default: process.env.SENTRY_DISABLE_SERVER_RELEASE || false
  • See https://docs.sentry.io/workflow/releases for more information

disableClientRelease

• Type: Boolean
  • Default: process.env.SENTRY_DISABLE_CLIENT_RELEASE || false
  • See https://docs.sentry.io/workflow/releases for more information

clientIntegrations

• Type: Dictionary
  • Default:

   {
      Dedupe: {},
      ExtraErrorData: {},
      ReportingObserver: {},
      RewriteFrames: {},
      Vue: {attachProps: true}
   }
  

  • See https://docs.sentry.io/platforms/node/pluggable-integrations/ for more information

serverIntegrations

• Type: Dictionary
  • Default:

    {
      Dedupe: {},
      ExtraErrorData: {},
      RewriteFrames: {},
      Transaction: {}
    }
  

  • See https://docs.sentry.io/platforms/node/pluggable-integrations/ for more information

config

• Type: Object
  • Default: { environment: this.options.dev ? 'development' : 'production' }

serverConfig

• Type: Object
  • Default: { }
  • If specified, values will override config values for server sentry plugin

clientConfig

• Type: Object
  • Default: { }
  • If specified, values will override config values for client sentry plugin

Submitting releases to Sentry

Support for the sentry-webpack-plugin was introduced #a6cd8d3. This can be used to send releases to Sentry. Use the publishRelease option to enable this feature.

Note that releases are only submitted to Sentry when (options.publishRelease && !isDev) is true.

License

MIT License

Copyright (c) Diederik van den Burger [e-mail]