npm 包 @bugsnag/delivery-node 使用教程

简介

@bugsnag/delivery-node 是一个 Node.js 端用于向 Bugsnag 发送错误报告的npm 包，可以帮助开发者快速集成 Bugsnag 错误报告服务，提高应用的稳定性和可靠性。

安装

安装 @bugsnag/delivery-node 很简单，只需要在命令行中运行以下命令即可：

npm install @bugsnag/delivery-node

配置

在使用 @bugsnag/delivery-node 发送错误报告之前，您需要首先配置包中的 Delivery 类，主要包括以下三个参数：

• endpoint: Bugsnag 给开发者生成的 API Key。在 Bugsnag 项目 dashboard 中可找到。
• appVersion: 应用的版本号。
• payloadVersion: 错误报告的版本号。

其中，endpoint 为必填项，appVersion 和 payloadVersion 可选。

下面是配置示例代码：

const { Delivery } = require('@bugsnag/delivery-node');

const apiKey = '<YOUR_API_KEY_HERE>';
const appVersion = '1.0.0';
const payloadVersion = '1';

const delivery = new Delivery(apiKey, appVersion, payloadVersion);

发送错误报告

配置完成后，您可以使用 delivery 实例的 sendReport 方法来发送错误报告，该方法接收一个 Report 实例参数，其中包含了错误信息和上下文等详细内容。

下面是发送错误报告的示例代码：

const { Report } = require('@bugsnag/delivery-node');

const report = new Report('error message', {
  metaData: { user: { id: 123, email: 'abc@def.com' } },
});

delivery.sendReport(report);

Report 实例的构造函数中，第一个参数为错误信息，可输入任意字符串类型的错误信息，第二个参数为错误信息的相关数据，如 metaData、request、user 等等。

总结

通过本文的介绍，您已经学会了如何使用 @bugsnag/delivery-node npm 包来快速集成 Bugsnag 错误报告服务，让应用更加稳定可靠。如果您还没有在项目中使用过 Bugsnag 错误报告服务，不妨试一试。不仅可以帮助您更好地关注应用的健康状况，也可以帮助您更快地发现和解决问题。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/bugsnag-delivery-node