查询 Google Workspace 插件错误日志

当已发布的 Google Workspace 加载项返回错误时，加载项界面会返回一条通用消息：“执行加载项时出错。”不过，这些错误会记录到 Cloud Logs Explorer。

注意：对于 Apps 脚本，如果您的插件部署为测试版，则 Cloud Logs Explorer 和插件界面都会报告错误。

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

虽然此类错误消息很有用，但您可以在 Logs Explorer 中查看更多信息。最佳实践是，查询错误日志以获取更多信息。如需详细了解如何测试插件部署，请参阅测试和调试 Google Workspace 加载项。

本指南介绍了如何在 Cloud Logs Explorer 中查询插件错误日志，以便：

• 了解用户是否遇到错误。
• 查看错误发生的频率以及最常发生的错误。
• 阅读描述性错误消息，以便您修复这些错误。

前提条件

在查询插件错误日志之前：

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

查询插件错误日志

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

1. 打开 Google Cloud Console。
2. 点击“Google Cloud Platform”旁边的向下箭头 ，然后选择附加项目。
3. 依次点击左上角的“菜单”图标 > 记录。系统会打开 Logs Explorer。

4. 对于插件错误日志，请在查询构建器中输入以下查询：

   severity>=ERROR
   protoPayload.serviceName="gsuiteaddons.googleapis.com"
   

5. 如需查看近期发生的错误，请点击运行查询。或者，如需在发生错误时查看错误，请点击流式传输日志。插件错误日志会显示在“查询结果”窗格中。

如需详细了解 Cloud Logs Explorer 和如何编写查询，请参阅以下内容：

• 使用 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 价格。