# @google-cloud/error-reporting 中文文档

规范地址：https://npmcn.com/package/%40google-cloud/error-reporting/

版本：4\.3\.0
npm 元数据更新时间：2026-10-12T22:04:10.603Z
中文译文更新时间：2026-11-16T19:50:53.586Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40google-cloud/error-reporting
原文对照：https://npmcn.com/package/%40google-cloud/error-reporting/?lang=original
项目主页：https://github.com/googleapis/google-cloud-node/tree/main/handwritten/error-reporting
源码仓库：https://github.com/googleapis/google-cloud-node

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

- 包体积（解压后）：161 kB，41 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2017-04-17T20:16:07.709Z
- 最新版本发布：2026-10-12T22:04:10.434Z
- 近 30 天下载量：514485（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：42（近 12 个月 6 个）

## 中文简介

节点客户端库报告出错

## 安装

```sh
npm install @google-cloud/error-reporting
```

也可以使用：`pnpm add @google-cloud/error-reporting`、`yarn add @google-cloud/error-reporting`、`bun add @google-cloud/error-reporting`

## README

![Google Cloud Platform logo](https://avatars2.githubusercontent.com/u/2810941?v=3&s=96 "Google Cloud Platform")

# [错误报告: Node.js 客户端](https://github.com/googleapis/nodejs-error-reporting)

[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/error-reporting.svg)](https://www.npmjs.org/package/@google-cloud/error-reporting)

> 节点.js 平庸客户端 [报告错误](https://cloud.google.com/error-reporting)。 。 。 .

[报告错误](https://cloud.google.com/error-reporting/docs/) 汇总和显示运行中的云服务中出现的错误.

各版本的更改一览表载于 [变化](https://github.com/googleapis/nodejs-error-reporting/blob/main/CHANGELOG.md)。 。 。 .

-   [报告节点出错.js 客户端 API 引用](https://cloud.google.com/nodejs/docs/reference/error-reporting/latest)
-   [报告文档出错](https://cloud.google.com/error-reporting)
-   [github.com/googleapis/nodejs-error- reporting (原始内容存档于2018-09-29) (英语)](https://github.com/googleapis/nodejs-error-reporting)

更多信息,请访问Cloud APIs的客户端库,包括老年人 Google APIs 客户端图书馆, in [客户端图书馆解释](https://cloud.google.com/apis/docs/client-libraries-explained)。 。 。 .

**目录 :**

-   [快速启动](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-quickstart)
    
    -   [在你开始之前](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-before-you-begin)
    -   [安装客户端库](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-installing-the-client-library)
-   [版本](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-versioning)
    
-   [捐款](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-contributing)
    
-   [许可证](https://npmcn.com/package/%40google-cloud/error-reporting/#readme-license)
    

## 快速启动

### 在你开始之前

1.  [选择或创建云平台项目](https://console.cloud.google.com/project)。 。 。 .
2.  [启用错误报告 API](https://console.cloud.google.com/flows/enableapi?apiid=clouderrorreporting.googleapis.com)。 。 。 .
3.  [用服务账户设置认证](https://cloud.google.com/docs/authentication/getting-started) 这样你就可以访问 当地工作站的API.

### 安装客户端库

```bash
npm install @google-cloud/error-reporting
```

本模块为Node.js应用程序提供自定义错误报告支持. [报告错误](https://cloud.google.com/error-reporting/) 是一个特征 Google Cloud 平台,可以对报告的错误进行深入监测和查看 应用程序在几乎所有环境中运行.

然而,注意到: [@google-cloud/logb-winston (英语)](https://github.com/googleapis/nodejs-logging-winston) 财务报告和审定财务报表 [@google-cloud/ logb-bunyan (英语)](https://github.com/googleapis/nodejs-logging-bunyan) 自动与错误报告服务集成, 错误对象以严重性记录 `error` 或更高,用于在Google Cloud平台运行的应用程序.

因此,如果您已经在应用程序中使用了Winston或Bunyan,并且不需要自定义错误报告能力,您就不需要使用 `@google-cloud/error-reporting` 库直接向错误报告控制台错误.

![Error Reporting overview](https://raw.githubusercontent.com/googleapis/nodejs-error-reporting/master/doc/images/errors-overview.png)

# 当错误被报告时

这个 `reportMode` 配置选项用于指定向错误报告控制台报告错误的时间。 它可以有三个价值之一:

-   `'production'` (默认):只有将 NODE ENV 环境变量设定为"生产"时才报告出错.
-   `'always'`:无论NODE ENV的值如何,总是报告出错.
-   `'never'`:无论NODE ENV的值如何,决不报告出错.

这个 `reportMode` 配置选项替换已贬值的 `ignoreEnvironmentCheck` 配置选项。 如果两者 `reportMode` 财务报告和审定财务报表 `ignoreEnvironmentCheck` 选项 `reportMode` 配置选项优先.

这个 `ignoreEnvironmentCheck` 选项。 然而,如果使用,以及 `reportMode` 未指定选项,它可以拥有以下值:

-   `false` (默认):只有将 NODE ENV 环境变量设定为"生产"时才报告出错.
-   `true`:无论NODE ENV的值如何,总是报告出错.

## 设置、配置和实例

请参看设置指令、配置选项和示例的文档 : [https://cloud.google.com/error-reporting/docs/ setup/nodejs 互联网档案馆的存檔,存档日期2011-12-21](https://cloud.google.com/error-reporting/docs/setup/nodejs)

这里还可以找到额外的代码样本: [https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/main/error-report) 互联网档案馆的存檔,存档日期2011-12-21](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/main/error-reporting)

这个 [报告节点出错.js 客户端 API 引用](https://cloud.google.com/nodejs/docs/reference/error-reporting/latest) 文档 还包含样品.

## 支持的节点.js版本

我们的客户端图书馆跟着 [节点.js发布时间表](https://github.com/nodejs/release#release-schedule)。 。 。 . 图书馆兼容所有当前 _活动_ 财务报告和审定财务报表 _维修_ 版本 节点.js. 如果你在使用"节点"(Node.js)的报废版本,我们建议你更新 尽快到积极支持的LTS版本.

Google 的客户端库支持在 a 上的 Node.js runtimes 的遗留版本 以下列警告为依据:

-   后遗症版本不进行连续整合测试.
-   一些安全补丁和特性不能被后移植.
-   依赖关系不能不断更新.

设有针对Node.js的一些报废版本的客户端图书馆,以及 可以通过 npm 安装 [秒数](https://docs.npmjs.com/cli/dist-tag)。 。 。 . 立面遵循命名惯例 `legacy-(version)`。 。 。 . 譬如说, `npm install @google-cloud/error-reporting@legacy-8` 安装客户端库 用于兼容Node.js 8的版本.

## 版本

这个图书馆跟随 [语义版本](http://semver.org/)。 。 。 .

这个图书馆被认为是 **稳定**。代码表面不会改变向后兼容的方式 除非绝对必要(例如,由于关键的安全问题)或 大量贬值期。 问题和要求 **稳定** 图书馆 以最高优先处理.

更多信息 : [谷歌云平台启动阶段](https://cloud.google.com/terms/launch-stages)

## 捐款

欢迎捐款! 见 [贡献指南](https://github.com/googleapis/nodejs-error-reporting/blob/main/CONTRIBUTING.md)。 。 。 .

请注意: `README.md`,则 `samples/README.md`, (中文(简体) ), 和该寄存器中的各种配置文件(包括 `.nycrc` 财务报告和审定财务报表 `tsconfig.json`(中文(简体) ) 从中央模板生成。 要编辑这些文件之一, 请编辑 输入模板 [目录](https://github.com/googleapis/synthtool)。 。 。 .

## 许可证

Apache 版本 2.0

见 [自由主义](https://github.com/googleapis/nodejs-error-reporting/blob/main/LICENSE)

## 常见问题

### @google-cloud/error-reporting 是什么？

节点客户端库报告出错

### 如何安装 @google-cloud/error-reporting？

在项目目录运行 npm install @google-cloud/error-reporting，或使用 pnpm add / yarn add / bun add。

### @google-cloud/error-reporting 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @google-cloud/error-reporting 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @google-cloud/error-reporting 需要什么版本的 Node\.js？

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

### @google-cloud/error-reporting 可以商用吗？

@google-cloud/error-reporting 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @google-cloud/error-reporting 的下载量有多少？

根据 npm 官方下载统计，@google-cloud/error-reporting 在 2026/10/17 – 2026/11/15 这 30 天内被下载 514,485 次，日均约 17,150 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @google-cloud/error-reporting 还在维护吗？

最新版本 4\.3\.0 发布于 2026/10/13（1 个月前）；至今共发布 42 个版本，其中过去 12 个月发布了 6 个；首次发布于 2017/04/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

