查詢 Google Chat 應用程式的錯誤記錄

本指南說明如何在 Google Cloud 記錄檔探索工具中查詢 Chat 擴充應用程式錯誤記錄檔。查詢記錄檔以便：

  • 瞭解使用者是否會發生錯誤。
  • 查看錯誤發生頻率，以及最常發生的錯誤。
  • 閱讀描述性的錯誤訊息和記錄資料，以協助您修正錯誤。

必要條件

  • 可存取 Google Chat 的 Google Workspace 帳戶。
  • Chat 應用程式。如要建構 Chat 應用程式，請按照快速入門中的說明操作。
  • 為 Chat 應用程式啟用錯誤記錄功能。

查詢錯誤記錄檔

  1. 在 Google Cloud 控制台中，依序按一下「選單」圖示 >「更多產品」>「記錄」>「記錄檔探索工具」。

    前往記錄檔探索工具

  2. 如有需要，請開啟「顯示查詢」，顯示查詢產生器。

  3. 如要查看 Chat 應用程式錯誤記錄，請輸入下列查詢：

    severity=ERROR
resource.type="chat.googleapis.com/Project"

  4. 如要查看近期錯誤，請按一下「執行查詢」。或者，如要查看發生的錯誤，請按一下「串流記錄」。即時通訊應用程式錯誤記錄會顯示在「查詢結果」中窗格。

如要進一步瞭解 Google Cloud 記錄檔探索工具及寫入查詢，請參閱記錄檔探索工具說明文件中的下列指南：

從記錄中讀取錯誤訊息

查詢錯誤記錄後，您可以檢視個別記錄，其中包含描述記錄的 JSON 酬載。如果是 Chat 應用程式錯誤，JSON 會在 jsonPayload.error.message 中加入錯誤訊息。舉例來說，在下列記錄範例中，錯誤訊息指出 Apps 腳本函式執行失敗：

JSON

{
  "insertId": "INSERT_ID",
  "jsonPayload": {
    "@type": "type.googleapis.com/google.chat.logging.v1.ChatAppLogEntry",
    "error": {
      "code": 9,
      "message": "An Apps Script function failed to execute. To review AppsScript error logs, see \"Logging\" (https://developers.google.com/apps-script/guides/logging)."
    },
    "deployment": "DEPLOYMENT_ID"
  },
  "resource": {
    "type": "chat.googleapis.com/Project",
    "labels": {
      "project_id": "PROJECT_ID"
    }
  },
  "timestamp": "2022-12-06T05:24:18.697255Z",
  "severity": "ERROR",
  "logName": "projects/PROJECT_ID/logs/chat.googleapis.com%2Ferrors",
  "receiveTimestamp": "2022-12-06T05:24:19.207936968Z"
}

注意事項

在 Google Cloud 記錄檔探索工具中處理即時通訊應用程式錯誤記錄時，請注意以下幾點：

  • 就 Google Chat 應用程式而言，記錄檔探索工具目前包含下列嚴重性的記錄，可協助排解應用程式故障問題：

    • ERROR

    相關服務的記錄也能協助對 Chat 應用程式進行偵錯。舉例來說，如果使用 Google Cloud Functions 部署即時通訊應用程式，最佳做法是一併查看 Cloud Functions 記錄檔的記錄檔探索工具。

  • 錯誤訊息一律以英文撰寫。

  • Cloud Logging 會產生費用。如要進一步瞭解 Cloud Logging 定價，請參閱「Google Cloud 作業套件定價」一文。

查詢錯誤記錄後，如果您發現錯誤，請參閱下列指南，瞭解如何修正錯誤：