Key Visualizer を使ってみる

このページでは、Key Visualizer を使用して、Firestore の使用パターンに関連するパフォーマンス問題を確認する方法について説明します。

始める前に

Firestore で Key Visualizer を使用するには、Firestore Key Visualizer API を有効にする必要があります。

アカウントに次のいずれかの IAM ロールが付与されていることを確認します。

これらのロールには、Key Visualizer へのアクセスに必要な次の IAM 権限が含まれています。

必要な権限を持つカスタムロールを定義することもできます。

Key Visualizer の各スキャンは、2 時間の期間に対応しています。特定の期間のスキャンは、その期間中の 1 分間に 3,000 回を超えるドキュメントオペレーションのトラフィックがあるデータベースに対して使用できます。

Key Visualizer を起動するには:

Google Cloud コンソールで [Database] ページに移動します。

[データベース] に移動
データベースのリストから、必要なデータベースを選択します。
ナビゲーションメニューで、[Key Visualizer] をクリックします。
使用可能な Key Visualizer スキャンからタイムスパンと指標を選択します。
1. 右上の鉛筆アイコンをクリックします。[Date] と [Time Span] を選択します。
  
  スキャンはスキャンの利用資格に基づいて行うことができます。スキャンの利用資格を満たしていない期間、または処理中の期間を選択することはできません。1 日の直近の 2 回のスキャンは、使用可能になるまで処理に時間がかかります。
2. ソースとして [All document data] または [All index data] を選択します。
3. [更新] をクリックします。
分析する指標を選択します。

左上にある指標のプルダウンをクリックして、表示する指標を選択します。デフォルトでは、Key Visualizer は、ドキュメントキーのオペレーション/秒指標とインデックスキーのインデックス書き込みオペレーション/秒指標で開きます。

指標の比較やデータの相関関係の調査を行う場合は、複数の Key Visualizer の指標を一緒に表示できます。複数の指標間の関係の探索をご覧ください。

選択した 2 時間のアクティビティの概要を把握するには、ヒートマップでデフォルトの指標を確認します。

次の例は、キー範囲で使用パターンの異なるヒートマップを示しています。

Key Visualizer スキャンの例

オペレーション/秒指標は、各キー範囲の 1 秒あたりのリクエスト数を測定します。この指標は、書き込み、ルックアップ、クエリのリクエストの合計です。デフォルトでは、Key Visualizer でヒートマップを開くと、この指標が表示されます。

データベースの全体的なアクティビティを把握したら、他の指標を調べて、問題を引き起こしている可能性のあるキー範囲に焦点を当てることで、調査を続行できます。詳細。

所与のセルのインデックス書き込みオペレーション/秒指標は、対応する 10 秒間とキー範囲での 1 秒あたりの平均インデックス書き込み数を測定します。