モニタリングとトラブルシューティング

このページでは、カタログやユーザーイベントのインポートで発生したエラーや、その他の Retail API オペレーションの情報を取得する方法について説明します。

アラートの設定について詳しくは、アラートの設定をご覧ください。

はじめに

正確なカタログ情報とユーザーイベントを Retail API に提供することは、最高品質の結果を得るために重要です。エラーの原因をモニタリングし、理解することは、サイトのエラーを検出して修正することに役立ちます。

集約された統合エラーを確認する

データアップロードプロセスと予測リクエストや検索リクエストによって生成され、集計されたエラーを確認するには、[モニタリングと分析] ページの [モニタリング] タブを使用します。

このページには、Retail API のすべてのエラーが表示されます。商品カタログ、ユーザーイベント、Recommendations AI 予測、Retail 検索結果、モデルに関連するエラーを表示できます。システムはまた、Cloud Storage ファイルの不正な行など、インポートのエラーも記録します。システムはインポートファイルごとに最大 100 件のエラーを記録します。エラーが表示される期間を定義し、エラータイプに基づいてフィルタリングできます。

個々のエラーをクリックすると、そのエラーのログが Cloud Logging に表示されます。

そのログを展開して、個々のエラーログを開くことができます。エラーログには、リクエストやレスポンスのペイロードやエラーの詳細など、リクエストに関する詳細情報が確認できます。この情報は、問題のあるメソッド呼び出しがサイトのどこにあるのかを判断するのに役立ちます。

無効な JSON エラーの場合は、status フィールドを展開すると、問題に関する詳細情報を確認できます。

特定の統合オペレーションのステータスを確認する

特定の統合オペレーションのステータスを表示するには、統合アクティビティパネルを使用します。

Google Cloud Console の [Retail Data] ページに移動します。

[データ] ページに移動
ボタンバーの [インポートアクティビティを表示] をクリックして、インポートアクティビティパネルを開きます。

特定の統合オペレーションのエラーをチェックできます。
エラーがあるオペレーションの [詳細] 列で [ログを表示] をクリックし、Cloud Logging のログファイルを検査できます。

エラータイプ

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 として指定される場合を除き、一般的な（個別ではない）人気アイテムが返されます。この問題が発生する一般的な理由として、以下のものがあります。
- カタログに存在しないフィルタタグを指定しています。フィルタタグの更新が反映されるまでには、最長で 1 日かかることがあります。
- フィルタが狭すぎます。

ログを直接確認する

Logging でログファイルを直接開くこともできます。たとえば、次のリンクをクリックすると、過去 1 時間のすべての Retail エラーのログが開きます。Retail ログを開く

データ読み込み指標の表示

データアップロードシステムが正常に実行されたら、[小売データ] ページの [カタログ] タブと [イベント] タブを使用して、データの取り込みのエラー指標を確認し、すべてが円滑に実行されるようにすることができます。

データアップロードシステムで問題が発生した場合に通知されるアラートを追加できます。

カタログデータの概要

[データ] ページの [カタログ] タブを使用して、各カタログブランチのデータ統計の概要を表示します。このページには、商品カタログブランチごとに、インポートした商品の数、在庫数、最後にインポートした商品が表示されます。

アップロードしたカタログアイテムのプレビューを表示したり、商品フィールドに基づいてフィルタリングしたりすることもできます。

Recommendations AI または小売検索結果をステージングしてプレビューする方法として、データをさまざまなブランチにインポートできます。たとえば、ホリデーシーズンに備えて、新しいカタログデータをデフォルト以外のブランチにアップロードし、小売結果が正しく生成されることを確認してからウェブサイトで公開することができます。

ユーザーイベント記録の統計情報

ユーザーイベントの種類ごとに、[イベント] タブで、記録したイベントの数、そのうち商品に関連付けられなかったイベントの数（結合されていないイベント）、前の期間との数の相違を確認できます。プリセット期間を選択することも、カスタム期間を入力することもできます。

指標グラフには、一定期間にわたって取り込まれたユーザーイベントが表示されます。これは、ユーザーイベントの種類によってフィルタリングできます。

データ品質の指標

[データ] ページで [データ品質を表示] をクリックして、[データ品質] パネルを開きます。

[カタログ] タブには、カタログ内の商品のうち、それぞれの品質指標を満たす商品の割合が表示されます。これらの指標は、商品データの検索品質を評価するのに役立ちます。
[イベント] タブには、ユーザーイベントでそれぞれのデータ品質の要件を満たすものの数が表示されます。これらの指標は、ユーザーイベントの検索品質を評価するのに役立ちます。結果を期間でフィルタリングし、各要件の [ログを表示] をクリックします。

結合されていないイベント

ユーザーイベントまたは API リクエストが小売にアップロードされていないプロダクトを参照する場合、結合されていないイベントになります。結合されていないユーザーイベントは引き続きログに記録され、結合されていないリクエストも処理されますが、今後の予測に対して、にさらに強化するためには使用できません。このため、ログに記録されないイベントの割合が、ユーザーイベントと予測リクエストの両方で非常に低い値であることを確認する必要があります。

結合されていないユーザーイベントの割合は、[データ] ページの [イベント] タブで確認できます。

API エラー

クリックすると、メソッド名別に API エラーのグラフを時系列で表示するには、[モニタリングと分析] ページのボタンバーで、API 指標の表示をクリックします。

API メソッドのアクティビティをモニタリングする

API メソッドを使用してトラフィック、エラー、レイテンシを可視化するには、[モニタリングと分析] ページの [Monitoring] タブに移動します。プリセット期間を選択することも、カスタム期間を入力することもできます。

各グラフの詳細を表示するには:

グラフの下で、メソッド名をクリックしてグラフ内で分離します。
グラフにカーソルを合わせると、各メソッドと、その時点での値のコールアウトが表示されます。
グラフの一部をクリックしてドラッグし、その期間を拡大できます。

次のステップ

データフィードのエラーアラートを設定する方法について学習する。
Error Reporting について学習する。
Logging でのログの表示について学習する。