# @airbrake/node 中文文档

规范地址：https://npmcn.com/package/%40airbrake/node/

版本：2\.1\.9
npm 元数据更新时间：2025-03-13T00:01:00.115Z
中文译文更新时间：2026-11-05T18:12:58.691Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40airbrake/node
原文对照：https://npmcn.com/package/%40airbrake/node/?lang=original
项目主页：https://github.com/airbrake/airbrake-js/tree/master/packages/node
源码仓库：https://github.com/airbrake/airbrake-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：106 kB，107 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- Node.js 要求：\>=10
- 运行依赖：4 个
- 首次发布：2019-08-20T12:16:11.091Z
- 最新版本发布：2025-03-13T00:00:59.922Z
- 近 30 天下载量：95399（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 0 个）

## 中文简介

Node.js 的官方空气制动通知器

## 安装

```sh
npm install @airbrake/node
```

也可以使用：`pnpm add @airbrake/node`、`yarn add @airbrake/node`、`bun add @airbrake/node`

## README

![](https://airbrake-github-assets.s3.amazonaws.com/brand/airbrake-full-logo.png)

# 节点(js)的官方空气制动通知器

[![Build Status](https://github.com/airbrake/airbrake-js/workflows/CI/badge.svg?branch=master)](https://github.com/airbrake/airbrake-js/actions?query=branch%3Amaster) [![npm version](https://img.shields.io/npm/v/@airbrake/node.svg)](https://www.npmjs.com/package/@airbrake/node) [![npm dm](https://img.shields.io/npm/dm/@airbrake/node.svg)](https://www.npmjs.com/package/@airbrake/node) [![npm dt](https://img.shields.io/npm/dt/@airbrake/node.svg)](https://www.npmjs.com/package/@airbrake/node)

在节点.js和 报告给 [空中刹车](http://airbrake.io/)如果你要找的话 浏览器支持, 有一个 [单独的软件包](https://github.com/airbrake/airbrake-js/tree/master/packages/browser)。 。 。 .

## 安装

使用线条 :

```sh
yarn add @airbrake/node
```

使用 npm :

```sh
npm install @airbrake/node
```

## 基本用途

首先,以项目标识和项目密钥初始化通知符 [空中刹车](https://airbrake.io/)寻找你的 `project_id` 财务报告和审定财务报表 `project_key` 导航您的项目 _设置_ 从右侧复制值 侧边栏 :

![](https://s3.amazonaws.com/airbrake-github-assets/airbrake-js/project-id-key.png)

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

const airbrake = new Notifier({
  projectId: 1,
  projectKey: 'REPLACE_ME',
  environment: 'production',
});
```

然后,你可以发送一条短信给空气刹:

```js
let promise = airbrake.notify(`user id=${user_id} not found`);
promise.then((notice) => {
  if (notice.id) {
    console.log('notice id', notice.id);
  } else {
    console.log('notify failed', notice.error);
  }
});
```

或直接报告错误 :

```js
try {
  throw new Error('Hello from Airbrake!');
} catch (err) {
  airbrake.notify(err);
}
```

或者,您可以将任何可能使用 `wrap` 方法 :

```js
let startApp = () => {
  throw new Error('Hello from Airbrake!');
};
startApp = airbrake.wrap(startApp);

// Any exceptions thrown in startApp will be reported to Airbrake.
startApp();
```

或使用 `call` 快捷键 :

```js
let startApp = () => {
  throw new Error('Hello from Airbrake!');
};

airbrake.call(startApp);
```

## 示例配置

-   [快递](https://npmcn.com/package/%40airbrake/node/examples/express)
-   [节点.js](https://npmcn.com/package/%40airbrake/node/examples/nodejs)

## 高级使用

### 说明

可以用各种有用的信息对错误通知进行注释 在报告的对象中提供它们的时间.

```js
try {
  startApp();
} catch (err) {
  airbrake.notify({
    error: err,
    context: { component: 'bootstrap' },
    environment: { env1: 'value' },
    params: { param1: 'value' },
    session: { session1: 'value' },
  });
}
```

### 严重性

[严重性](https://airbrake.io/docs/airbrake-faq/what-is-severity/) 允许 分类错误有多严重。 默认,它设定为 `error`改为: 重新定义严重性, 简单覆盖 `context/severity` 通知对象:

```js
airbrake.notify({
  error: err,
  context: { severity: 'warning' },
});
```

### 过滤出错

申请中可能有些错误 你对这个不感兴趣 发送到 Airbrake 中,例如 由 3 党派 库 所抛出的错误 .

空气刹车通知器 很容易忽略这个沙发 处理合法错误。 通过提供过滤器向通知者添加过滤器 函数到 `addFilter`。 。 。 .

`addFilter` 接受整个 [错误通知](https://airbrake.io/docs/api/#create-notice-v3) 发送至 空中刹车和提供进入 `context`, (中文(简体) ), `environment`, (中文(简体) ), `params`, (中文(简体) ), 财务报告和审定财务报表 `session` 属性。 还包括单元素 `errors` 数组 联合国 `backtrace` 属性和相关回溯行.

过滤器函数的返回值决定错误是否 将提交通知.

-   若为 `null` 返回时,通知被忽略.
-   否则,将提交退回的通知.

错误通知必须通过所有要提交的过滤器.

在下面的例子中,管理员引发的所有错误将被忽略:

```js
airbrake.addFilter((notice) => {
  if (notice.params.admin) {
    // Ignore errors from admin sessions.
    return null;
  }
  return notice;
});
```

过滤器也可以用于修改通知有效载荷,例如用于设定环境 和应用程序版本 :

```js
airbrake.addFilter((notice) => {
  notice.context.environment = 'production';
  notice.context.version = '1.2.3';
  return notice;
});
```

### 过滤密钥

与 `keysBlocklist` 选项,您可以指定包含 必须过滤的敏感信息:

```js
const airbrake = new Notifier({
  // ...
  keysBlocklist: [
    'password', // exact match
    /secret/, // regexp match
  ],
});
```

### 节点.js 请求和代理

用来使用 [请求](https://github.com/request/request) HTTP 客户端, 通过 页:1 `request` 选项,用于接受请求的包装:

```js
const airbrake = new Notifier({
  // ...
  request: request.defaults({ proxy: 'http://localproxy.com' }),
});
```

### 仪器

`@airbrake/node` 试图自动记录各种性能 度量衡。 您可以使用 `performanceStats` 选项 :

```js
const airbrake = new Notifier({
  // ...
  performanceStats: false,
});
```

### 过滤性能数据

`addPerformanceFilter` 允许过滤性能数据。 返回时 `null` 内 防止向空气刹车报告这一度量的过滤器.

```js
airbrake.addPerformanceFilter((metric) => {
  if (metric.route === '/foo') {
    // Requests to '/foo' will not be reported
    return null;
  }
  return metric;
});
```

## 常见问题

### @airbrake/node 是什么？

Node\.js 的官方空气制动通知器

### 如何安装 @airbrake/node？

在项目目录运行 npm install @airbrake/node，或使用 pnpm add / yarn add / bun add。

### @airbrake/node 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/airbrake\_\_node 是否存在。

### @airbrake/node 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @airbrake/node 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @airbrake/node 可以商用吗？

@airbrake/node 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @airbrake/node 的下载量有多少？

根据 npm 官方下载统计，@airbrake/node 在 2026/10/05 – 2026/11/03 这 30 天内被下载 95,399 次，日均约 3,180 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @airbrake/node 还在维护吗？

最新版本 2\.1\.9 发布于 2025/03/13（1\.7 年前）；至今共发布 41 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/08/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。