查询 Google Workspace 插件的错误日志

当已发布的 Google Workspace 插件返回错误时,该插件接口会返回一条通用消息:“执行该插件时出了点问题”。但是,这些错误会记录到 Cloud 日志浏览器中。

本指南介绍如何在 Cloud Logs Explorer 中查询插件错误日志,以便您可以执行以下操作:

  • 了解用户是否遇到错误。
  • 您可以查看错误发生的频率以及哪个最常见。
  • 阅读描述性的错误消息,以帮助您进行更正。

前提条件

在查询插件错误日志之前,请执行以下操作:

  • 在插件的 Google Cloud 项目中启用“Cloud Logging API”。如需启用 API,请参阅创建 Cloud 项目并启用 API
  • 在 Google Workspace Marketplace 中发布该插件。 如需在 Marketplace 中发布插件,请参阅发布应用

查询插件错误日志

如需获取插件的日志,请执行以下操作:

  1. 打开 Google Cloud Console
  2. 点击“Google Cloud Platform”旁边的向下箭头 ,然后选择插件项目。
  3. 在左上角,依次点击“菜单”图标 > 日志记录。日志浏览器即会打开。
  4. 对于插件错误日志,请在查询构建器中输入以下查询:

    severity>=ERROR
    protoPayload.serviceName="gsuiteaddons.googleapis.com"
    
  5. 如需查看最近的错误,请点击运行查询。或者,如需查看发生的错误,请点击流式传输日志。插件错误日志会显示在“查询结果”窗格中。

如需详细了解 Cloud Logs Explorer 以及如何编写查询,请参阅以下内容:

启用或停用错误日志记录

默认情况下,错误日志记录处于启用状态。启用错误日志记录后,清单文件包含以下内容:

"exceptionLogging": "STACKDRIVER",

如需停用错误日志记录,请将 "exceptionLogging": "STACKDRIVER", 替换为清单文件中的以下行:

// Disable error logging
"exceptionLogging": "NONE"

如需重新启用错误日志记录,请将 "exceptionLogging": "NONE" 替换为 "exceptionLogging": "STACKDRIVER",

注意事项

在 Cloud Logs Explorer 中使用插件错误日志时,请注意以下注意事项:

  • 插件仅会在日志浏览器中记录错误。系统不会记录其他类型的日志。
  • 错误消息始终以英文撰写。
  • Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格,请参阅 Google Cloud 可观测性价格