查询 Google Workspace 插件的错误日志

当某个已发布的 Google Workspace 插件返回错误时, 插件接口会返回一条通用消息, “执行插件时出了点问题。”不过,这些错误 登录到 Cloud Logs Explorer

<ph type="x-smartling-placeholder">

本指南介绍如何在 Cloud Logs Explorer,让您可以:

  • 了解用户是否遇到错误。
  • 查看错误出现的频率以及错误出现的频率。
  • 阅读描述性错误消息,以帮助您解决问题。

前提条件

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

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

查询插件错误日志

如需获取插件的日志,请按以下步骤操作:

  1. 打开 Google Cloud Console
  2. 在“Google Cloud Platform”旁边点击向下箭头 ,然后选择 插件项目。
  3. 点击左上角的“菜单”图标 &gt;日志记录。系统随即会打开日志浏览器。
  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 中使用插件错误日志时 请注意以下注意事项:

  • 插件仅会在日志浏览器中记录错误。其他日志类型包括 未记录。
  • 错误消息始终使用英文显示。
  • Cloud Logging 会产生费用。如需详细了解 Cloud Logging, 请参阅 Google Cloud Observability 价格