排查问题

如果您的应用错误未显示在 Error Reporting 中， 然后按照以下步骤排查问题

准备工作

  1. 验证 Error Reporting 是否可以分析您的日志条目。

    Error Reporting 是一项全球性服务， Cloud Logging，并且可以在满足以下所有条件时分析日志条目：

    • Assured Workloads 已停用。如需了解详情，请参阅 Assured Workloads 概览。
    • 客户管理的加密密钥 (CMEK) 对存储相应日志条目的所有日志存储分区停用。有关如何使用 确定日志存储桶的 CMEK 配置，请参阅 验证密钥的启用状态。
    • 日志存储桶满足以下任一条件：
      • 日志存储桶存储在生成日志条目的项目中。
      • 日志条目已路由到某个项目，然后该项目存储了这些日志条目 存储在自己的日志存储桶中
    。 将日志条目存储在启用了 CMEK 的日志存储分区中，仍然可以使用 Error Reporting。但是，您必须使用 Error Reporting 客户端 库或 Error Reporting API。有关详情，请参阅 Error Reporting API 概览和 Error Reporting 客户端 库。

    如需查看已配置的接收器的列表，请运行以下命令：

    gcloud logging sinks list

    该命令会返回类似于以下内容的输出：

    NAME               DESTINATION                                                                                                FILTER
_Default           logging.googleapis.com/projects/my-team-project/locations/global/buckets/_Default                          NOT LOG_ID("cloudaudit.googleapis.com/activity") AND NOT LOG_ID("externalaudit.googleapis.com/activity") AND NOT LOG_ID("cloudaudit.googleapis.com/system_event") AND NOT LOG_ID("externalaudit.googleapis.com/system_event") AND NOT LOG_ID("cloudaudit.googleapis.com/access_transparency") AND NOT LOG_ID("externalaudit.googleapis.com/access_transparency")
_Required          logging.googleapis.com/projects/my-team-project/locations/global/buckets/_Required                         LOG_ID("cloudaudit.googleapis.com/activity") OR LOG_ID("externalaudit.googleapis.com/activity") OR LOG_ID("cloudaudit.googleapis.com/system_event") OR LOG_ID("externalaudit.googleapis.com/system_event") OR LOG_ID("cloudaudit.googleapis.com/access_transparency") OR LOG_ID("externalaudit.googleapis.com/access_transparency")
logs-from-samples  logging.googleapis.com/projects/my-team-project/locations/global/buckets/sample-bucket                     (empty filter)
regional_logs      logging.googleapis.com/projects/my-team-project/locations/europe-west1/buckets/bucket_for_regional_logs    (empty filter)
test-logs          logging.googleapis.com/projects/team-b-project/locations/global/buckets/test-bucket                        (empty filter)

    在此示例中，日志条目的来源 Google Cloud 项目为 my-team-project。因此：

    • Error Reporting 可以分析 _Default， _Required 和 logs-from-samples 接收器，因为日志存储桶 由路由日志条目的同一项目存储。
    • Error Reporting 无法分析日志中存储的日志条目 名为 test-logs 的存储桶，因为 my-team-project 中的接收器将 其他项目中的日志存储桶的日志条目。

  2. 确保您已拥有 已安装 Google Cloud CLI。

  3. 确保您已拥有 为 gcloud CLI 启用了 beta 组件。

使用日志时

本部分提供有关写入错误数据时的问题排查支持 Cloud Logging 存储分区，并且您依赖于 Error Reporting 自动分析这些日志存储分区

生成样本日志条目

如需确认项目设置，您可以通过编程方式生成日志条目 将由 Error Reporting 获取，其中包含以下 gcloud 命令：

gcloud logging write --payload-type=json test-errors-log \
  '{"serviceContext":
    {"service": "manual-testing"},
    "message": "Test Error\n at /test.js:42:42",
    "context": {"httpRequest":
      {"url": "/test","method": "GET","responseStatusCode": 500}}}'

然后打开 Error Reporting，并确认您已看到新创建的错误。

确认日志条目格式

转到 Cloud Logging 页面，找到包含您的应用发送的异常数据的日志条目。

确认该日志条目使用预期格式。

使用 Error Reporting API 时

  1. Enable the required API.

    Enable the API

  2. 发送测试错误

    尝试手动向该服务发送错误。

    您可以使用以下 gcloud 命令向 Error Reporting 报告测试错误：

    gcloud beta error-reporting events report --service Manual --service-version test1 \
  --message "java.lang.TestError: msg
    at com.example.TestClass.test(TestClass.java:51)
    at com.example.AnotherClass(AnotherClass.java:25)"

    您可以使用 cURL 命令测试 REST API 调用。在发送以下命令之前，用您的有效值替换 PROJECT_ID 和 API_KEY：

    curl -X POST -H "Content-Type: application/json" \
  -d '{"message":"java.lang.TestError: msg\n\tat com.example.TestClass.test(TestClass.java:51)\n\tat com.example.AnotherClass(AnotherClass.java:25)","serviceContext":{"service":"manual-testing"}}' \
  https://clouderrorreporting.googleapis.com/v1beta1/projects/PROJECT_ID/events:report?key=API_KEY

  3. 确认发送的载荷

    确保您的应用在 格式正确 包含必需的属性。