Airbrake Node.js 错误监控教程

项目介绍

node-airbrake 是一个用于 Airbrake 的 Node.js 通知器，Airbrake 是一个领先的异常报告服务。该库提供了一个极简的 API，使您能够将任何 Node.js 异常发送到 Airbrake 仪表板。node-airbrake 提供了与 Express 网络框架的开箱即用集成。

注意： node-airbrake 已被弃用，推荐使用 @airbrake/node。请尽快迁移。

项目快速启动

安装

首先，创建一个 Airbrake 账户并安装 @airbrake/node：

npm install @airbrake/node

初始化

在你的 Node.js 应用中初始化 Airbrake：

const { Notifier } = require('@airbrake/node');

const airbrake = new Notifier({
  projectId: 123,
  projectKey: 'abcdefg12345678',
  environment: 'production'
});

发送错误

你可以通过以下方式发送错误到 Airbrake：

try {
  // 你的代码
} catch (err) {
  airbrake.notify(err);
}

应用案例和最佳实践

应用案例

假设你有一个 Express 应用，你可以这样集成 Airbrake：

const express = require('express');
const { Notifier } = require('@airbrake/node');

const app = express();
const airbrake = new Notifier({
  projectId: 123,
  projectKey: 'abcdefg12345678',
  environment: 'production'
});

app.get('/', (req, res) => {
  try {
    // 你的代码
  } catch (err) {
    airbrake.notify(err);
    res.status(500).send('Something broke!');
  }
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

最佳实践

1. 环境配置： 确保在不同的环境中使用不同的 environment 参数，例如 development、staging 和 production。
2. 错误分类： 使用 Airbrake 的错误分类功能来管理不同类型的错误。
3. 定期检查： 定期检查 Airbrake 仪表板，及时处理新出现的错误。

典型生态项目

Express 集成

node-airbrake 提供了与 Express 框架的集成，使得在 Express 应用中监控错误变得非常简单。

其他生态项目

• Slack 集成： 通过 Slack 集成，可以在 Slack 中接收错误通知。
• GitHub 集成： 通过 GitHub 集成，可以将错误直接关联到 GitHub 仓库中的问题。

通过这些集成，你可以更高效地管理和响应应用中的错误。