nuxt-bugsnag

用于 nuxt.js 的 Bugsnag 集成。使您能够轻松地将 Bugsnag 添加到您的项目中。支持上传源映射。

1.66 万次下载•50 星•v8.6.0

JulianMar

nuxt-bugsnag

📖 发布说明

演示

打开 Stackblitz 并试用。

设置

将 nuxt-bugsnag 依赖项添加到您的项目

npx nuxi@latest module add bugsnag

将 nuxt-bugsnag 添加到 nuxt.config.js 的 modules 部分。

{
  modules: [
    'nuxt-bugsnag'
  ]
}

您可以在配置对象中传递所有 Bugsnag 选项

{
  bugsnag: {
    config: {
      apiKey: 'your key',
      enabledReleaseStages: ['staging', 'production'],
    }
  }
}

源映射

您可以通过添加选项 publishRelease 来上传源映射。设置 baseUrl 也非常重要，它将允许 bugsnag 将您的错误映射到源映射

{
  bugsnag: {
    publishRelease: true,
    baseUrl: 'https://:3000'
  }
}

一个中等 Nuxt 应用程序的输出可能会变得非常大。因此我们添加了一个选项来禁用这种情况下的日志。

{
  bugsnag: {
    publishRelease: true,
    disableLog: true,
    baseUrl: 'https://:3000'
  }
}

设置不同的项目根目录

如果您的 Nuxt 应用程序在不同于 / 的文件夹中运行，您可能希望将 projectRoot 设置为此目录，以便 BugSnag 可以匹配源映射。

{
  bugsnag: {
    publishRelease: true,
    projectRoot: '/someFolder/'
  }
}

配置示例

我建议设置这些选项

{
  modules: [
    'nuxt-bugsnag',
  ],

  bugsnag: {
    publishRelease: true,
    config: {
      apiKey: 'YOUR_API_KEY',
      enabledReleaseStages: ['staging', 'production'],
      releaseStage: process.env.NODE_ENV,
      appVersion: 'YOUR_VERSION',
    }
  }
}

报告自定义错误

最简单的答案是这样。

this.$bugsnag.notify(new Error('Some Error'))

如果您喜欢组合方式，您可以这样做

useBugsnag().notify('Some Error')

性能

仅在 7.4.0 及以上版本中可用

bugsnag 性能功能的最简单配置如下

{
  bugsnag: {
    apiKey: 'YOUR API KEY',
    performance: true
  }
}

对于自定义选项，您可以使用以下配置并从此处获取所有设置

{
  bugsnag: {
    apiKey
    config: {
      performanceConfig: {
        autoInstrumentFullPageLoads: true,
      }
    }
  }
}

自定义性能监控

有关发送自定义 span，请参阅此文档。模块中有一个小助手可以发送自定义 span。

这只能在客户端使用，绝不应在服务器端调用。其中包含一个模拟，因此您无需担心，但应牢记这一点。

useBugsnagPerformance().startSpan('my-span')

开发

克隆此仓库
使用 npm install 安装依赖项
使用 npm run dev 启动开发服务器

许可证

麻省理工学院许可证