# @google-cloud/debug-agent 中文文档

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

版本：9\.0\.1
npm 元数据更新时间：2024-02-01T20:09:23.175Z
中文译文更新时间：2026-11-16T20:08:07.207Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40google-cloud/debug-agent
原文对照：https://npmcn.com/package/%40google-cloud/debug-agent/?lang=original
项目主页：https://github.com/googleapis/cloud-debug-nodejs#readme
源码仓库：https://github.com/googleapis/cloud-debug-nodejs

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

- 包体积（解压后）：399 kB，58 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.0\.0
- 运行依赖：13 个
- 首次发布：2017-02-07T18:22:25.209Z
- 最新版本发布：2024-02-01T20:09:22.972Z
- 近 30 天下载量：59090（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 0 个）

## 中文简介

节点调试代理

## 安装

```sh
npm install @google-cloud/debug-agent
```

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

## README

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

# [云调试器:节点.js客户端](https://github.com/googleapis/cloud-debug-nodejs)

[![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/debug-agent.svg)](https://www.npmjs.org/package/@google-cloud/debug-agent)

> 本模块为Node.js应用程序提供快照调试器支持. 快照调试器是一个开源产品, 允许您调试您的 在生产过程中的应用程序不停止或取消您的应用程序.

使用 Firebase 实时数据库实例存储您的数据 .

## 项目状态:已归档

此项目已存档,不再支持. 没有 进一步修正错误或安全补丁。 用户可以建立仓库 如果他们想保持下去的话.

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

-   [Cloud 调试器节点.js 客户端 API 引用](https://cloud.google.com/nodejs/docs/reference/debug-agent/latest)
-   [云调试器文档](https://cloud.google.com/debugger)
-   [github.com/googleapis/ 云 -- -- 调试 -- -- 节点](https://github.com/googleapis/cloud-debug-nodejs)

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

**目录 :**

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

## 快速启动

### 在你开始之前

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

### 安装客户端库

```bash
npm install @google-cloud/debug-agent
```

## 调试器代理设置

要自定义自动调试代理的行为, 请指定选项 当开始代理。 以下代码样本显示如何在 可用选项的子集.

```js
require('@google-cloud/debug-agent').start({
  // .. auth settings ..

  // debug agent settings:
  allowExpressions: true,
  serviceContext: {
    service: 'my-service',
    version: 'version-1'
  },
  capture: { maxFrames: 20, maxProperties: 100 }
});
```

下列选项配置与Firebase数据库的连接:

-   消防基地DbUrl - https://**项目编号**\-cdbg.firebaseio.com将使用,如果 未提供。 地点 **项目编号** 您的项目 ID .
-   firebaseKeyPath - 如果不使用默认 google 应用程序证书则使用 提供.

一些关键配置选项有:

-   允许说明 - 是否允许评估 被压. 功能性在未设定时受到限制,但在那里 是一种恶意表达式可以改变程序状态的风险.
-   服务内容 - 该信息在UI中用于识别所有 您服务的运行实例 。 如果你不喜欢的话就设置这个 默认值.
-   抓取 - 在快照上抓取的配置选项。 设定 如果默认的快照抓取太有限, 则使用此选项 。 请注意: 放松限制可能会对业绩产生影响.

见 [代理配置](https://github.com/googleapis/cloud-debug-nodejs/blob/main/src/agent/config.ts) 可能配置列表 选项.

## 使用调试器

一旦您的应用程序运行, 请使用 [快照调试器 CLI](https://pypi.org/project/snapshot-dbg-cli/) 或 [VSCode 扩展](https://github.com/GoogleCloudPlatform/snapshot-debugger/tree/main/snapshot_dbg_extension) 来调试您的应用程序.

## 历史注释

此代理的 6. x 和 7. x 版本都支持当前关闭的 Cloud 调试器服务( 默认) 和 [快照调试器](https://github.com/GoogleCloudPlatform/snapshot-debugger/) 通过设置 `useFirebase` 旗帜为真。 第8.0.0版 (中文(简体) ) 已删除对 Cloud 调试器服务的支持, 使 Snapshot 调试器为 默认。 注意到 `useFirebase` 旗帜现已过时,但仍为 向后兼容.

## 限制和要求

> 说明: 有一个已知的问题,即允许代理触发内存 渗出. 见 [811号](https://github.com/googleapis/cloud-debug-nodejs/issues/811)

-   可以通过设置监视的快照条件来创建隐私问题 在您的申请中评估表达式。 你也许可以 在查看变量值时查看敏感的用户数据.
-   调试代理试图确保所有条件和监视都指向您 添加是只读的,没有副作用。 它能捕捉,不能捕捉, 所有可能具有静态副作用的表达式以防止意外 州变. 然而,它目前没有捕捉到具有以下特征的表达: 动态副作用. 譬如说, `o.f` 看起来像一个财产进入, 但从动态角度来说,它可能最终会称为取出函数. 我们目前是 不检测到这种动态侧面效应.
-   您应用程序的根目录需要包含 `package.json` 文档.

## 样本

样本在 [`samples/`](https://github.com/googleapis/cloud-debug-nodejs/tree/main/samples) 目录。 每个样本 `README.md` 有运行样本的指示.

| 样本 | 源代码 | 试试看 |
| --- | --- | --- |
| 应用 | [源代码](https://github.com/googleapis/cloud-debug-nodejs/blob/main/samples/app.js) | [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/app.js,samples/README.md) |
| 片断 | [源代码](https://github.com/googleapis/cloud-debug-nodejs/blob/main/samples/snippets.js) | [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/snippets.js,samples/README.md) |

这个 [Cloud 调试器节点.js 客户端 API 引用](https://cloud.google.com/nodejs/docs/reference/debug-agent/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/debug-agent@legacy-8` 安装客户端库 用于兼容Node.js 8的版本.

## 版本

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

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

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

## 捐款

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

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

## 许可证

Apache 版本 2.0

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

## 常见问题

### @google-cloud/debug-agent 是什么？

节点调试代理

### 如何安装 @google-cloud/debug-agent？

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

### @google-cloud/debug-agent 支持 TypeScript 吗？

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

### @google-cloud/debug-agent 支持 ESM 还是 CommonJS？

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

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

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

### @google-cloud/debug-agent 可以商用吗？

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

### @google-cloud/debug-agent 的下载量有多少？

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

### @google-cloud/debug-agent 还在维护吗？

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

