本指南介绍了如何在 Google Cloud 日志浏览器 中查询 Chat 应用错误日志。查询日志可用于:
- 了解用户是否遇到错误。
- 查看错误发生的频率以及最常发生的错误。
- 阅读描述性错误消息和日志数据,以帮助您修复错误。
前提条件
- 拥有可访问 Google Chat 的 Google Workspace 账号。
- Chat 应用。如需构建 Chat 应用,请按照此 快速入门指南操作。
- 为 Chat 应用启用错误日志记录。
查询错误日志
在 Google API 控制台中,依次点击菜单 > 更多产品 > 日志记录 > Logs Explorer。
如有必要,请开启显示查询 以显示查询构建器。
对于 Chat 应用错误日志,请输入以下查询:
severity=ERROR resource.type="chat.googleapis.com/Project"如需查看近期发生的错误,请点击运行查询 。或者,如需在错误发生时查看错误,请点击流式传输日志 。Chat 应用错误日志会显示在“查询结果”窗格中。
如需详细了解 Google Cloud Logs Explorer 和编写查询,请参阅 Logs Explorer 文档中的以下指南:
从日志中读取错误消息
查询错误日志后,您可以查看各个日志,这些日志由描述日志的 JSON 载荷组成。对于 Chat 应用错误,JSON 会在
jsonPayload.error.message 中包含错误消息。例如,在以下示例日志中,错误消息指出 Apps 脚本函数执行失败:
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 Logs Explorer 中使用 Chat 应用错误日志时,请注意以下事项:
对于 Google Chat 应用,Logs Explorer 包含以下严重程度的日志,这些日志有助于排查应用故障:
ERROR
相关服务的日志也有助于调试 Chat 应用。例如,如果您使用 Google Cloud Run functions 部署 Chat 应用,请同时查看 Logs Explorer 中的 Cloud Run functions 日志。
错误消息始终以英文编写。
Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格,请参阅 Google Cloud 的运维套件价格。
相关主题
查询错误日志后,如果您发现错误,请参阅以下指南以获取有关修复错误的帮助:
- 了解如何修复 Google Chat 应用错误,例如“应用无响应”“只有 Google Workspace 用户可以使用 Google Chat API”或“用户可以从空间中排除”。
- 了解如何修复卡片错误,例如卡片消息、对话框或链接预览未按预期呈现或运行。
- 了解如何进行调试。