查詢 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」旁邊的向下箭頭 arrow_drop_down，然後選取外掛程式專案。
3. 依序按一下左上角的「選單」圖示 menu >「Logging」。記錄檔探索工具會隨即開啟。

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

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

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

如要進一步瞭解 Cloud 記錄檔探索工具及撰寫查詢，請參閱下列內容：

• 使用記錄檔探索工具
• 建構查詢

啟用或停用錯誤記錄功能

錯誤記錄功能預設為啟用。啟用錯誤記錄功能後，資訊清單檔案會提供下列資訊：

"exceptionLogging": "STACKDRIVER",

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

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

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

注意事項

在 Cloud 記錄檔探索工具中處理外掛程式錯誤記錄檔時，請注意以下幾點：

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