本指南介绍了如何在 Google Cloud 日志浏览器中查询 Chat 应用错误日志。查询日志以:
- 了解用户是否遇到错误。
- 查看错误发生的频率以及最常发生的错误。
- 阅读有助于您修复错误的描述性错误消息和日志数据。
前提条件
- 拥有 Google Chat 访问权限的 Google Workspace 账号。
- 一个 Chat 应用。如需构建 Chat 应用,请按照此快速入门操作。
- 为 Chat 应用开启错误日志记录功能。
查询错误日志
在 Google Cloud 控制台中,依次点击菜单 > 更多产品 > 日志记录 > 日志浏览器。
如有必要,请开启显示查询以显示查询构建器。
对于 Chat 应用错误日志,请输入以下查询:
severity=ERROR resource.type="chat.googleapis.com/Project"
如需查看近期发生的错误,请点击运行查询。或者,如需查看错误发生情况,请点击直播日志。聊天应用错误日志会显示在“查询结果”窗格中。
如需详细了解 Google Cloud 日志浏览器和如何编写查询,请参阅日志浏览器文档中的以下指南:
从日志中读取错误消息
查询错误日志后,您可以查看各个日志,这些日志包含描述日志的 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 日志浏览器中使用 Chat 应用错误日志时,请注意以下事项:
对于 Google Chat 应用,日志浏览器目前包含以下严重程度的日志,可帮助排查应用故障:
ERROR
相关服务的日志也有助于调试 Chat 应用。例如,如果 Chat 应用是使用 Google Cloud Functions 部署的,那么最好也检查 Cloud Functions 日志的日志浏览器。
错误消息始终以英文显示。
Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格,请参阅 Google Cloud 的运维套件价格。
相关主题
查询错误日志后,如果您发现错误,请参阅以下指南,获取有关修正错误的帮助:
- 了解如何修正 Google Chat 应用错误,例如“应用未响应”“Google Chat API 仅适用于 Google Workspace 用户”或“用户可被排除在聊天室之外”。
- 了解如何修复卡片错误,例如卡片消息、对话框或链接预览未按预期呈现或运行。
- 了解如何进行调试。