查询 Google Workspace 插件错误日志

发布的 Google Workspace 插件返回错误时，插件界面会返回“执行插件时出错”这一通用消息。不过，这些错误会记录到 Cloud Logs Explorer。

注意：对于 Apps Script，如果您的插件以测试方式部署，则 Cloud Logs Explorer 和插件界面中都会报告错误。

例如，插件测试部署可能会在其界面中显示如下错误消息：TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn]。

虽然此类错误消息很有帮助，但 Logs Explorer 中还提供了更多信息。最佳实践是，查询错误日志以了解更多信息。如需详细了解如何测试插件部署，请参阅测试和调试 Google Workspace 插件。

本指南介绍了如何在 Cloud Logging 日志浏览器中查询插件错误日志，以便您：

• 了解用户是否遇到错误。
• 查看错误发生的频率以及哪些错误最常见。
• 阅读描述性错误消息，帮助您解决问题。

前提条件

在查询插件错误日志之前，请先执行以下操作：

• 在插件对应的 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 中处理插件错误日志时，请注意以下注意事项：

• 插件仅会在 Logs Explorer 中记录错误。系统不会记录其他日志类型。
• 错误消息始终采用英语编写。
• Cloud Logging 会产生费用。如需详细了解 Cloud Logging 价格，请参阅 Google Cloud Observability 价格。