查詢 Google Workspace 外掛程式的錯誤記錄

如果已發布的 Google Workspace 外掛程式傳回錯誤，外掛程式介面會傳回「執行外掛程式時發生錯誤」的一般訊息。不過，這些錯誤會記錄至 Cloud 記錄檔探索工具。

本指南說明如何在 Cloud 記錄檔探索工具中查詢外掛程式錯誤記錄，以便：

  • 瞭解使用者是否遇到錯誤。
  • 查看錯誤發生頻率，以及最常發生的錯誤。
  • 閱讀描述性錯誤訊息，瞭解如何修正問題。

必要條件

查詢外掛程式錯誤記錄前，請先完成下列事項：

  • 在外掛程式的 Google Cloud 專案中啟用「Cloud Logging API」。如要啟用 API，請參閱「建立 Cloud 專案並啟用 API」。
  • 在 Google Workspace Marketplace 發布外掛程式。 如要在 Marketplace 上發布外掛程式，請參閱「發布應用程式」。

查詢外掛程式錯誤記錄

如要取得外掛程式的記錄，請按照下列步驟操作：

  1. 開啟 Google Cloud 控制台。
  2. 按一下「Google Cloud Platform」旁的向下箭頭 ，然後選取外掛程式專案。
  3. 依序按一下左上角的「選單」圖示 >「記錄」。系統會開啟 Logs Explorer。

  4. 如要查看外掛程式錯誤記錄，請在查詢建立工具中輸入下列查詢：

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

  5. 如要查看近期錯誤，請按一下「執行查詢」。如要查看錯誤發生情形，請按一下「串流記錄」。外掛程式錯誤記錄會顯示在「Query results」(查詢結果) 窗格中。

如要進一步瞭解 Cloud 記錄檔探索工具和如何編寫查詢，請參閱下列文章：

啟用或停用錯誤記錄

系統預設會啟用錯誤記錄功能。啟用錯誤記錄功能後，資訊清單檔案會包含下列項目：

"exceptionLogging": "STACKDRIVER",

如要停用錯誤記錄，請在資訊清單檔案中將 "exceptionLogging": "STACKDRIVER", 替換為下列程式碼：

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

如要重新啟用錯誤記錄功能，請將 "exceptionLogging": "NONE" 替換為 "exceptionLogging": "STACKDRIVER",。

注意事項

在 Cloud Logs Explorer 中使用外掛程式錯誤記錄時，請注意下列事項：

  • 外掛程式只會在記錄探索工具中記錄錯誤。系統不會記錄其他記錄類型。
  • 錯誤訊息一律以英文顯示。
  • Cloud Logging 會產生費用。如要進一步瞭解 Cloud Logging 定價，請參閱「Google Cloud Observability 定價」。