robyedlin / sentry-module

Sentry module for NuxtJS

@nuxtjs/sentry

Sentry module for Nuxt.js

Features

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.

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: {
      public_key: '',
      project_id: '',
      config: {
        // Additional config
      },
    }
}

Nuxt compatibility

Versions of NuxtJS between v1.0.0 and v1.2.1 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

public_key

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

Will be ignored if dsn provided.

host

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

Will be ignored if dsn provided.

protocol

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

Will be ignored if dsn provided.

project_Id

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

Will be ignored if dsn provided.

path

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

Will be ignored if dsn provided.

disabled

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

disableClientSide

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

License

MIT License

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