監控功能與疑難排解

本頁說明如何取得 Vertex AI Search for commerce 中目錄和使用者事件匯入作業,以及其他 API 作業發生的錯誤資訊。

如需設定快訊的說明,請參閱「設定 Cloud Monitoring 快訊」。

簡介

如要獲得最佳品質的結果,請務必向 API 提供正確的目錄資訊和使用者事件。監控並瞭解錯誤來源,有助於您找出並修正網站中的任何錯誤。

查看匯總的整合錯誤

如要查看資料上傳程序和預測或搜尋要求產生的匯總錯誤,請使用「監控頁面。

這個頁面會顯示商家適用的 Vertex AI Search API 所有錯誤。您可以查看與產品目錄、使用者事件、推薦預測、搜尋結果和模型相關的錯誤。系統也會記錄匯入作業的錯誤,例如 Cloud Storage 檔案中的格式錯誤行。系統會為每個匯入檔案記錄最多 100 個錯誤。您可以定義要顯示錯誤的時間範圍,並根據錯誤類型進行篩選。

您可以按一下個別錯誤,在 Cloud Logging 中查看該錯誤的記錄。

您可以展開個別記錄,開啟個別錯誤記錄。錯誤記錄會提供要求的詳細資料,包括要求和回應酬載以及錯誤詳細資料。這項資訊可協助您判斷網站中哪個位置發生錯誤的方法呼叫。

如要取得無效 JSON 錯誤的詳細資訊,請展開 status 欄位。

查看特定整合作業的狀態

您可以在「活動狀態」視窗中查看特定整合作業的狀態:

  1. 在「Search for commerce」控制台中,依序前往「資料」> 頁面。

    前往「資料」頁面

  2. 按一下「活動狀態」

    「活動狀態」視窗會顯示產品目錄、使用者事件和控制項的長時間執行作業狀態。

    您可以在這個視窗中檢查特定整合作業的錯誤。

  3. 在任何發生錯誤的作業的「詳細資料」欄中,按一下「查看記錄檔」,即可在 Cloud Logging 中檢查記錄檔。

在 Cloud Logging 中查看記錄

如要在 Cloud Logging 中直接開啟記錄檔案,請按照下列程序操作。您必須具備「記錄檢視器」(roles/logging.viewer) 角色,才能查看記錄檔。

  1. 前往 Google Cloud 控制台的「Logs Explorer」頁面。前往「Logs Explorer」

  2. 從專案選取器中選取 Vertex AI Search for Commerce 專案。

  3. 按一下「資源」下拉式選單,然後依序選取「已使用 API」 >「Cloud Retail」

如要進一步瞭解記錄檔探索工具,請參閱「使用記錄檔探索工具查看記錄檔」。

舉例來說,這個連結會開啟過去一小時內所有商家適用的 Vertex AI Search 錯誤的記錄:

開啟 Vertex AI Search for Commerce 記錄

如要設定要寫入哪些 API 記錄,請參閱「設定記錄」。

設定記錄功能

您可以設定要將哪些服務記錄寫入 Logging。記錄設定可讓您設定記錄嚴重性層級、開啟或關閉記錄功能,以及覆寫特定服務的預設記錄設定。

每位使用者發出的每項 API 要求,都會產生一則記錄項目。項目包含 API 方法、呼叫時間、回應代碼,以及要求和回應內文等資訊。專案的記錄設定會指定 API 產生的記錄類型,並可針對特定 API 服務精細指定記錄設定。

如要更新記錄設定,您必須具備 Vertex AI Search for Commerce 編輯者角色。

您可以使用控制台或 LoggingConfig API 設定記錄功能。

主控台

如要更新主控台中的記錄設定,請按照下列步驟操作:

  1. 前往「Search for commerce」控制台的「Monitoring」頁面。

    前往「Monitoring」頁面

  2. 按一下「記錄設定」

  3. 如要設定全域記錄設定,請選取記錄層級。如果您選取 LOG_ALL,請一併輸入成功記錄的取樣率

  4. 如要設定服務層級設定,請選取要更新的服務,然後選取其記錄層級。這項設定會覆寫全域記錄設定。

curl

如要使用 API 更新記錄設定,請使用 LoggingConfig 資源。請參閱 LoggingConfig API 參考資料

  1. 如要查看目前的記錄設定,請使用 loggingConfig.Get

    curl -X GET \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/loggingConfig"
    
    • PROJECT_ID:專案 ID。
  2. 如要更新記錄設定,請使用 loggingConfig.Patch 方法。詳情請參閱 LoggingConfig API 參考資料

    本範例使用 loggingConfig.Patch 將全域記錄設定設為 LOG_WARNINGS_AND_ABOVE。它也會設定兩個服務層級設定:CatalogService 設為 LOG_WARNINGS_AND_ABOVEControlService 設為 LOG_ALL

    curl -X PATCH \
      -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
      -H "Content-Type: application/json; charset=utf-8" \
      "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/loggingConfig" \
      --data '{
        "name": "projects/PROJECT_ID/loggingConfig",
        "default_log_generation_rule": {"logging_level": "LOG_ERRORS_AND_ABOVE"},
        "service_log_generation_rules": [
          {
            "service_name": "CatalogService",
            "log_generation_rule": {
              "logging_level": "LOG_WARNINGS_AND_ABOVE"
              }
          },
          {
            "service_name": "ControlService",
            "log_generation_rule": {
                "logging_level": "LOG_ALL", "info_log_sample_rate": "0.1"
                }
            }
          ]
        }'
    

記錄層級

只有部分嚴重性層級的記錄會寫入 Logging。記錄層級設定會決定 API 方法產生的哪些記錄會寫入記錄。

如果未為 API 方法設定服務層級記錄設定,系統會使用全域記錄層級設定。

預設的記錄層級設定為 LOG_WARNINGS_AND_ABOVE

logging_level 欄位接受下列值:

  • LOGGING_DISABLED:未寫入任何記錄。
  • LOG_ERRORS_AND_ABOVE:僅記錄錯誤。
  • LOG_WARNINGS_AND_ABOVE:只記錄錯誤和警告。
  • LOG_ALL:記錄所有內容,包括成功記錄,例如 INFO 記錄。

成功記錄檔的取樣率

如果您將記錄層級設定為 LOG_ALL,但不想記錄每個成功的記錄,可以指定取樣率。舉例來說,您可以定期監控記錄,確認狀態是否成功,或是查看成功記錄的百分比。指定取樣率有助於執行這項操作,且不會將大量 INFO 記錄項目寫入 Logging,否則可能會導致 Logging 費用增加。

如要指定取樣率,請將 info_log_sample_rate 設為大於 0 且小於或等於 1 的有效浮點值。取樣率會決定 INFO 記錄檔寫入 Logging 的可能性。預設值為 1 (會寫入所有 INFO 記錄)。

服務層級設定

您可以為特定服務設定記錄設定。這會覆寫該服務的全球記錄設定。舉例來說,您可能會將全域記錄層級設為 LOG_WARNINGS_AND_ABOVE,但將 UserEventService 服務記錄層級設為 LOG_ALL,以便檢查是否成功整合使用者事件。

使用 ServiceLoggingLevel 物件設定精細的記錄等級。

service_name 欄位接受下列值:

  • CompletionService
  • ControlService
  • MerchantCenterStreaming
  • ModelService
  • PredictionService
  • ProductService
  • ServingConfigService
  • UserEventService

錯誤類型

本節將說明記錄中可能出現的錯誤類型:

  • MISSING_FIELD:未設定必填欄位值;例如,目錄項目缺少標題。
  • INVALID_TIMESTAMP:時間戳記無效,例如未來的時間距離現在太久,或格式不正確。
  • FIELD_VALUE_TOO_SMALL:欄位中的值小於要求的最小值;例如,負數價格。
  • INCORRECT_JSON_FORMAT:要求中的 JSON 格式不正確,例如缺少 { 括號。
  • INVALID_LANGUAGE_CODE:語言代碼的格式不正確。
  • FIELD_VALUE_EXCEEDED:欄位中的值大於允許的最大值。
  • INVALID_RESOURCE_ID:資源 ID 無效;例如,資源名稱中包含不存在的 catalog_id
  • FIELD_SIZE_EXCEEDED:欄位中的項目數超出上限。
  • UNEXPECTED_FIELD:預期空白的欄位中包含值;例如,詳細網頁瀏覽事件的交易。
  • INVALID_FORMAT:欄位的格式不正確,例如字串格式有誤
  • RESOURCE_ALREADY_EXISTS:您嘗試建立的資源已存在,例如先前已建立的目錄項目。
  • INVALID_API_KEY:API 金鑰與要求中的專案不符。
  • INSUFFICIENT_PERMISSIONS:您沒有執行要求的權限;這項錯誤通常與缺少必要的 IAM 權限有關。
  • UNJOINED_WITH_CATALOG:要求中包含目錄中不存在的目錄項目 ID。請確保您的目錄為最新版本。
  • BATCH_ERROR:要求中包含多項錯誤;例如,某個包含 10 個項目的內嵌匯入作業由於多種原因而無法通過驗證。
  • INACTIVE_RECOMMENDATION_MODEL:您查詢的模型未啟用服務功能。
  • ABUSIVE_ENTITY:與要求相關聯的訪客 ID 或使用者 ID 在短時間內傳送的事件數量異常。
  • FILTER_TOO_STRICT:預測要求篩選器封鎖所有預測結果。系統會傳回一般 (非個人化) 熱門項目,除非呼叫指定的 strictFiltering 為 false,否則不會傳回任何項目。導致這個問題的常見原因如下:

    • 您指定的篩選器標記不在目錄中。更新篩選器標記後,最多可能需要一天才會生效。
    • 篩選條件太過狹隘。

查看資料載入指標

如要在 Google Cloud 控制台中監控目錄和使用者事件資料的攝入作業,請按照下列步驟操作:

  1. 在「監控」頁面中查看目錄和使用者事件資料擷取作業的錯誤指標。

    前往「Monitoring」頁面

  2. 資料上傳系統順利運作後,請使用「資料」頁面中的「目錄」和「事件」分頁,查看目錄的匯總資訊、預覽已上傳的產品,以及查看使用者事件整合指標的圖表。

    前往「資料」頁面

  3. 如要建立快訊,以便在資料上傳作業發生錯誤時通知您,請按照「設定 Cloud Monitoring 快訊」一節中的程序操作。

目錄資料摘要

您可以使用「資料」頁面中的「目錄」分頁,查看各目錄分支的概略資料統計資料。這個頁面會顯示你匯入的產品數量、庫存數量,以及上次匯入各產品目錄分支的時間。

你也可以預覽已上傳的目錄項目,並依產品欄位篩選。

您可以將資料匯入不同的分支,以便排程及預覽推薦內容或搜尋結果。舉例來說,為了準備節慶檔期,您可以將新的目錄資料上傳至非預設分支,並確保商家適用的 Vertex AI Search 結果正確產生,再將其發布到網站上。

使用者事件記錄統計資料

您可以在「事件」分頁中,查看每種類型的使用者事件記錄數量、無法與產品建立關聯的事件數量 (未連結的事件),以及這些數字與先前期間的差異。您可以選取預設時間範圍,也可以輸入自訂時間範圍。

指標圖表會顯示一段時間內擷取的使用者事件,您可以依使用者事件類型篩選。

資料品質指標

在「資料品質」頁面上,您可以查看指標,瞭解符合搜尋資料品質建議標準的產品和使用者事件百分比。使用這個頁面評估需要匯入或更新哪些資料,以便提升搜尋結果品質,並解鎖搜尋效能等級。

如要進一步瞭解搜尋成效等級和檢查資料品質,請參閱「解鎖搜尋成效等級」。

如需所有目錄資料品質指標的清單,請參閱「目錄資料品質指標」。

如要瞭解推薦內容和搜尋功能的所有使用者事件規定和建議,請參閱「使用者事件規定和最佳做法」。

未整合的事件

如果使用者事件或 API 要求參照的產品尚未上傳至 Vertex AI Search for Commerce,則為未連結事件。系統仍會記錄未加入的使用者事件,並處理未加入的要求,但這兩者都無法用於進一步改善模型,以利日後的預測。因此,請確保使用者事件和預測要求的未記錄事件百分比都非常低。

您可以在「資料」頁面的「事件」分頁中,查看未加入的使用者事件百分比。

API 錯誤

如要查看 API 錯誤隨時間變化的圖表,請按一下 監控頁面按鈕列上的「查看 API 指標」。系統會依方法名稱顯示圖表。

監控 API 方法活動

如要依 API 方法將流量、錯誤和延遲時間視覺化,請前往「監控」頁面。您可以選取預設時間範圍,也可以輸入自訂時間範圍。

如要進一步瞭解每個圖表的詳細資料,請按照下列步驟操作:

  • 在圖表下方,按一下方法名稱,即可在圖表中隔離該方法。
  • 將游標懸停在圖表上,即可查看附註,其中包含各個方法及其在該時間點的值。
  • 按住並拖曳圖表的任一區塊,即可放大該時間範圍。

後續步驟