查询 Google Chat 应用的错误日志

本指南介绍了如何在 Google Cloud 日志浏览器中查询 Chat 应用错误日志。查询日志以:

  • 了解用户是否遇到错误。
  • 查看错误发生的频率以及哪些错误最常见。
  • 阅读描述性错误消息和日志数据,帮助您修正错误。

前提条件

  • 拥有 Google Chat 访问权限的 Google Workspace 账号。
  • Chat 应用。如需构建 Chat 应用,请按照此快速入门中的说明操作。
  • 为 Chat 应用开启错误日志记录

查询错误日志

  1. 在 Google Cloud 控制台中,依次点击菜单 > 更多产品 > 日志记录 > 日志浏览器

    前往日志浏览器

  2. 如有必要,如需显示查询构建器,请开启显示查询

  3. 对于 Chat 应用错误日志,请输入以下查询:

    severity=ERROR
    resource.type="chat.googleapis.com/Project"
    
  4. 如需查看近期的错误,请点击运行查询。或者,如需在出现错误时查看错误,请点击数据流日志。Chat 应用错误日志会显示在“查询结果”窗格中。

如需详细了解 Google Cloud 日志浏览器和编写查询,请参阅日志浏览器文档中的以下指南:

从日志中读取错误消息

查询错误日志后,您可以查看各个日志,这些日志由描述日志的 JSON 载荷组成。对于 Chat 应用错误,JSON 在 jsonPayload.error.message 中包含错误消息。例如,在以下示例日志中,错误消息指出 Apps Script 函数执行失败:

JSON

{
  "insertId": "INSERT_ID",
  "jsonPayload": {
    "@type": "type.googleapis.com/google.chat.logging.v1.ChatAppLogEntry",
    "error": {
      "code": 9,
      "message": "An Apps Script function failed to execute. To review AppsScript error logs, see \"Logging\" (https://developers.google.com/apps-script/guides/logging)."
    },
    "deployment": "DEPLOYMENT_ID"
  },
  "resource": {
    "type": "chat.googleapis.com/Project",
    "labels": {
      "project_id": "PROJECT_ID"
    }
  },
  "timestamp": "2022-12-06T05:24:18.697255Z",
  "severity": "ERROR",
  "logName": "projects/PROJECT_ID/logs/chat.googleapis.com%2Ferrors",
  "receiveTimestamp": "2022-12-06T05:24:19.207936968Z"
}

注意事项

在 Google Cloud 日志浏览器中处理 Chat 应用错误日志时,请注意以下注意事项:

  • 对于 Google Chat 应用,Logs Explorer 目前包含以下严重级别的日志,可帮助排查应用运行异常问题:

    • ERROR

    相关服务的日志也可以帮助调试 Chat 应用。例如,如果 Chat 应用是使用 Google Cloud Functions 部署的,则最佳实践是查看日志浏览器中的 Cloud Functions 日志。

  • 错误消息始终采用英语编写。

  • Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格,请参阅 Google Cloud 的运维套件价格

查询错误日志后,如果您发现错误,请参阅以下指南,了解如何修正错误: