本指南介绍如何在 Google Cloud Logs Explorer 中查询 Chat 应用错误日志。查询日志以便:
- 了解用户是否遇到错误。
- 您可以查看错误发生的频率以及哪个最常见。
- 阅读描述性错误消息和日志数据,以帮助您修正错误。
前提条件
- 有权访问 Google Chat 的 Google Workspace 帐号。
- Chat 应用。如需构建 Chat 应用,请按照此quickstart操作。
- 为 Chat 应用启用错误日志记录。
查询错误日志
在 Google Cloud 控制台中,点击菜单 > 更多产品 > Logging > Logs Explorer。
如有必要,请开启显示查询以显示查询构建器。
对于 Chat 应用错误日志,请输入以下查询:
severity=ERROR resource.type="chat.googleapis.com/Project"
如需查看最近的错误,请点击运行查询。或者,如需查看发生的错误,请点击流式传输日志。Chat 应用错误日志会显示在“查询结果”窗格中。
如需详细了解 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 Logs Explorer 中使用 Chat 应用错误日志时,请注意以下事项:
对于 Google Chat 应用,日志浏览器目前提供以下严重级别的日志,这些严重级别有助于对出现故障的应用进行问题排查:
ERROR
相关服务的日志还有助于调试 Chat 应用。例如,如果 Chat 应用是使用 Google Cloud Functions 部署的,则最好也检查 Logs Explorer 中是否有 Cloud Functions 日志。
错误消息始终以英文撰写。
Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格,请参阅 Google Cloud 的运维套件价格。
相关主题
查询错误日志后,如果您发现错误,请参阅以下指南,获取有关修正错误的帮助:
- 了解如何修正 Google Chat 应用错误,例如“应用没有响应”“只有 Google Workspace 用户可以使用 Google Chat API”或“可以将用户排除在聊天室之外”。
- 了解如何修正卡片错误,例如卡片消息、对话框或链接预览无法按预期呈现或运行。
- 了解如何调试。