查询 Google Workspace 插件的错误日志

当已发布的 Google Workspace 插件返回错误时，插件界面会返回一条通用消息：“执行插件时出现问题。”但是，这些错误会记录到 Cloud Logs Explorer 中。

本指南介绍如何在 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 的运维套件价格。