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. 依序按一下左上角的「選單」圖示 >「記錄」。記錄檔探索工具會隨即開啟。

  4. 針對外掛程式錯誤記錄，請在查詢產生器中輸入下列查詢：

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

  5. 如要查看最近發生的錯誤，請按一下「執行查詢」。或者，如要查看發生錯誤時的狀況，請按一下「Stream logs」(串流記錄)。外掛程式錯誤記錄檔會顯示在「查詢結果」窗格中。

如要進一步瞭解 Cloud 記錄檔探索工具和寫入查詢，請參閱以下資源：

啟用或停用錯誤記錄功能

錯誤記錄功能預設為啟用。錯誤記錄功能啟用後，資訊清單檔案包含下列內容：

"exceptionLogging": "STACKDRIVER",

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

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

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

注意事項

使用 Cloud Logs Explorer 中的外掛程式錯誤記錄檔時，請注意以下幾點：

  • 外掛程式只會記錄記錄檔探索工具中的錯誤。系統不會記錄其他記錄類型。
  • 錯誤訊息一律以英文撰寫。
  • Cloud Logging 會產生費用。如要進一步瞭解 Cloud Logging 定價，請參閱 Google Cloud 作業套件定價。