您可以使用 Node.js 版 Error Reporting 库,从 Node.js 应用向 Error Reporting 发送错误报告。
Error Reporting 已与某些 Google Cloud 服务集成,例如 Cloud Functions、App Engine、Compute Engine 和 Google Kubernetes Engine。Error Reporting 可显示在这些服务上运行的应用记录到 Cloud Logging 中的错误。如需了解详情,请参阅本页面上的在 Google Cloud Platform 上运行。
您还可以使用 Logging 将错误数据发送到 Error Reporting。如需了解数据格式设置要求,请参阅设置 Logging 中的错误消息格式。
须知事项
- 登录您的 Google Cloud 帐号。如果您是 Google Cloud 新手,请创建一个帐号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
-
在 Google Cloud Console 中的项目选择器页面上,选择或创建一个 Google Cloud 项目。
-
启用 Error Reporting API 。
-
在 Google Cloud Console 中的项目选择器页面上,选择或创建一个 Google Cloud 项目。
-
启用 Error Reporting API 。
- 为 Node.js 开发准备好环境。
安装客户端库
借助 Node.js 版 Error Reporting 库,您可以监控和查看几乎在任何位置运行的 Node.js 应用所报告的错误。
-
使用 npm 安装该软件包:
npm install --save @google-cloud/error-reporting
-
导入库并实例化客户端,以开始报告错误:
如需详细了解如何安装,请参阅 Node.js 版 Error Reporting 库的文档。您还可以使用问题跟踪器来报告问题。
配置客户端库
您可以自定义 Node.js 版 Error Reporting 库的行为。如需查看可能的配置选项的列表,请参阅库的配置。这些选项可以在传递到库构造函数的 options
对象中传递。
报告错误
您可以调用 report
方法来手动报告错误,如以下示例所示:
使用 Express.js 报告错误
通过 Node.js 版 Error Reporting 库,您可以将 Error Reporting 轻松集成到常用的 Node.js Web 框架中,例如 Express.js:
其他集成
如需详细了解 Node.js 版 Error Reporting 库与其他 Node.js Web 框架之间的集成,请参阅 GitHub 上该库的代码库。
在 Google Cloud 上运行
要使用 Node.js 版 Error Reporting 库,您必须具备 Identity and Access Management 的 Error Reporting Writer 角色。大多数 Google Cloud 计算平台均默认提供此角色。
您可以使用以下 Google Cloud 环境配置 Node.js 版 Error Reporting。
App Engine 柔性环境
App Engine 默认授予 Error Reporting Writer 角色。
您无需明确提供凭据即可使用 Node.js 版 Error Reporting 库。
系统会自动为 App Engine 柔性环境应用启用 Error Reporting。 无需进行额外设置。Google Kubernetes Engine
在 GKE 上,您必须在创建集群时添加 cloud-platform
访问权限范围,如以下示例命令所示:
gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform
Compute Engine
使用 Compute Engine 虚拟机实例时,请为每个实例添加 cloud-platform
访问权限范围。通过 Google Cloud 控制台创建新实例时,您可以在创建实例面板的身份和 API 访问权限部分执行此操作。请使用 Compute Engine 默认服务账号或您选用的其他服务账号,并在身份和 API 访问权限部分中勾选允许所有 Cloud API 的全面访问权限。无论您选择哪个服务帐号,都请确保已在 Google Cloud 控制台的 IAM 和管理部分中向该服务帐号授予 Error Reporting Writer 角色。
Cloud Functions
Cloud Functions 会默认授予 Error Reporting Writer 角色。
您无需明确提供凭据即可使用 Node.js 版 Error Reporting 库。
Cloud Functions 已配置为自动使用 Error Reporting。未处理的 JavaScript 异常将在 Logging 中显示,并且会由 Error Reporting 进行处理,而无需使用 Node.js 版 Error Reporting 库。
在本地和其他位置运行
如需在 Google Cloud 之外(包括您自己的工作站、您数据中心的计算机或另一家云提供商的虚拟机实例上)使用 Node.js 版 Error Reporting 库,您必须直接向 Node.js 版 Error Reporting 库提供您的 Google Cloud 项目 ID 和相应的服务账号凭据。
您可以手动创建和获取服务账号凭据。指定角色字段时,请使用 Error Reporting Writer 角色。如需详细了解 Identity and Access Management 角色,请转到访问权限控制指南。
示例:查看错误报告
在 Google Cloud 控制台中,选择 Error Reporting,或点击以下按钮并选择项目:
如需了解详情,请参阅查看错误。