Overview

Error Reporting API 提供以下功能:

  • 一个简单的端点,用于报告 正在运行的服务中的错误。
  • 对错误组及其相关错误的读取权限。

使用入门

启用 Error Reporting API。

启用 API 所需的角色

如需启用 API,您需要拥有 Service Usage Admin IAM 角色 (roles/serviceusage.serviceUsageAdmin),该角色包含 serviceusage.services.enable 权限。了解如何授予角色

启用 API

授权使用 API

对 Error Reporting API 的访问权限由 Identity and Access Management 角色和权限控制。如需详细了解 Google Cloud API 的身份验证和授权,请参阅身份验证指南

数据模型

Error Reporting API 定义了三个实体:错误事件、错误组和错误组统计信息。错误组统计信息对象是大多数用户最常与之交互的对象。

错误事件

ErrorEvent 表示应用中发生的单个错误。该对象包含有关错误的信息,例如发生时间、发生时的上下文以及返回的错误消息。系统保证在生成错误事件后至少 30 天内提供该事件。

错误组

ErrorGroup 对象是按逻辑分组的错误事件集合。分组依据是错误事件堆栈轨迹中的信息。错误组是一个简单对象,仅包含组的名称、组 ID 以及与该组关联的所有跟踪问题。

如需更新跟踪问题网址,请使用此资源的 update 方法。

错误组统计信息

ErrorGroupStats 对象包含有关错误组的详细信息,并且是您最常与之交互的 API 对象。groupStats 对象中的信息包括此组中错误事件首次发生和上次发生的时间、计数、受影响的用户数等。此对象在构建 widget 和自定义信息中心时非常有用。

运维

Error Reporting API 支持以下运维:

  • 报告新的错误事件
  • 列出错误组统计信息
  • 列出错误事件
  • 获取错误组
  • 更新错误组的跟踪问题

报告错误事件

您可以通过将错误事件写入 ReportedErrorEvent 来报告正在运行的服务中的错误事件。采用这种做法时,系统会在 Cloud Logging 中生成具有适当格式设置的错误消息。生成的日志名称的格式为 projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors。采用这种方法时,可能会产生少量的 Cloud Logging 提取费用;要控制这些费用,请参阅 日志排除项

您还可以通过从正在运行的服务中组装 错误事件实体 并将其发送到 events.report 方法,向 Error Reporting 报告新的错误事件。

列出错误组统计信息

如需获取错误组统计信息列表,请向 groupStats.list 方法发送请求。您可以传递一个或多个查询参数来过滤返回的组统计信息。

列出错误事件

如需获取属于特定错误组的错误事件列表,请向 events.list 方法发送请求。您可以向这些请求传递过滤条件,以仅检索在特定开始时间和结束时间之间发生的错误事件,或与特定 服务上下文匹配的错误事件。

获取错误组

如需检索特定错误组资源,请向 groups.get 方法发送请求。

更新错误组

如需更新与错误组关联的跟踪问题网址,请将更新后的 ErrorGroup 资源发送到 groups.update 方法。