云调试器:节点.js客户端
本模块为Node.js应用程序提供快照调试器支持. 快照调试器是一个开源产品, 允许您调试您的 在生产过程中的应用程序不停止或取消您的应用程序.
使用 Firebase 实时数据库实例存储您的数据 .
项目状态:已归档
此项目已存档,不再支持. 没有 进一步修正错误或安全补丁。 用户可以建立仓库 如果他们想保持下去的话.
各版本的更改一览表载于 变化。 。 。 .
更多信息,请访问Cloud APIs的客户端库,包括老年人 Google APIs 客户端图书馆, in 客户端图书馆解释。 。 。 .
目录 :
快速启动
在你开始之前
- 选择或创建云平台项目。 。 。 .
- 启用云调试器 API。 。 。 .
- 用服务账户设置认证 这样你就可以访问 当地工作站的API.
安装客户端库
npm install @google-cloud/debug-agent
调试器代理设置
要自定义自动调试代理的行为, 请指定选项 当开始代理。 以下代码样本显示如何在 可用选项的子集.
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中用于识别所有 您服务的运行实例 。 如果你不喜欢的话就设置这个 默认值.
- 抓取 - 在快照上抓取的配置选项。 设定 如果默认的快照抓取太有限, 则使用此选项 。 请注意: 放松限制可能会对业绩产生影响.
见 代理配置 可能配置列表 选项.
使用调试器
一旦您的应用程序运行, 请使用 快照调试器 CLI 或 VSCode 扩展 来调试您的应用程序.
历史注释
此代理的 6. x 和 7. x 版本都支持当前关闭的 Cloud
调试器服务( 默认) 和
快照调试器
通过设置 useFirebase 旗帜为真。 第8.0.0版 (中文(简体) )
已删除对 Cloud 调试器服务的支持, 使 Snapshot 调试器为
默认。 注意到 useFirebase 旗帜现已过时,但仍为
向后兼容.
限制和要求
说明: 有一个已知的问题,即允许代理触发内存 渗出. 见 811号
- 可以通过设置监视的快照条件来创建隐私问题 在您的申请中评估表达式。 你也许可以 在查看变量值时查看敏感的用户数据.
- 调试代理试图确保所有条件和监视都指向您
添加是只读的,没有副作用。 它能捕捉,不能捕捉,
所有可能具有静态副作用的表达式以防止意外
州变. 然而,它目前没有捕捉到具有以下特征的表达:
动态副作用. 譬如说,
o.f看起来像一个财产进入, 但从动态角度来说,它可能最终会称为取出函数. 我们目前是 不检测到这种动态侧面效应. - 您应用程序的根目录需要包含
package.json文档.
样本
样本在 samples/ 目录。 每个样本 README.md 有运行样本的指示.
| 样本 | 源代码 | 试试看 |
|---|---|---|
| 应用 | 源代码 | ![]() |
| 片断 | 源代码 | ![]() |
这个 Cloud 调试器节点.js 客户端 API 引用 文档 还包含样品.
支持的节点.js版本
我们的客户端图书馆跟着 节点.js发布时间表。 。 。 . 图书馆兼容所有当前 活动 财务报告和审定财务报表 维修 版本 节点.js. 如果你在使用"节点"(Node.js)的报废版本,我们建议你更新 尽快到积极支持的LTS版本.
Google 的客户端库支持在 a 上的 Node.js runtimes 的遗留版本 以下列警告为依据:
- 后遗症版本不进行连续整合测试.
- 一些安全补丁和特性不能被后移植.
- 依赖关系不能不断更新.
设有针对Node.js的一些报废版本的客户端图书馆,以及
可以通过 npm 安装 秒数。 。 。 .
立面遵循命名惯例 legacy-(version)。 。 。 .
譬如说, npm install @google-cloud/debug-agent@legacy-8 安装客户端库
用于兼容Node.js 8的版本.
版本
这个图书馆跟随 语义版本。 。 。 .
这个图书馆被认为是 稳定。代码表面不会改变向后兼容的方式 除非绝对必要(例如,由于关键的安全问题)或 大量贬值期。 问题和要求 稳定 图书馆 以最高优先处理.
更多信息 : 谷歌云平台启动阶段
捐款
欢迎捐款! 见 贡献指南。 。 。 .
请注意: README.md,则 samples/README.md, (中文(简体) ),
和该寄存器中的各种配置文件(包括 .nycrc 财务报告和审定财务报表 tsconfig.json(中文(简体) )
从中央模板生成。 要编辑这些文件之一, 请编辑
输入模板
目录。 。 。 .
许可证
Apache 版本 2.0
见 自由主义
