クエリのパフォーマンス統計情報を分析する

このページでは、Query Insights ダッシュボードを使用し、クエリのパフォーマンスを検出して分析する方法について説明します。

Query Insights の概要

Query Insights ダッシュボードを使用して、指標関連のクエリをモニタリングします。指標に基づいて、最も頻繁に使用されるクエリと、最適化が必要になる可能性のあるレイテンシの大きいクエリを特定できます。Query Insights ダッシュボードは、次の操作を行う場合に役立ちます。

  • クエリ パフォーマンスの最適化: レイテンシが大きく、最適化が必要になる可能性があるクエリを特定します。
  • クエリ費用の管理: 費用のかかるクエリを特定し、最適化して費用を削減します。
  • クエリ統計のモニタリング: クエリ統計の推移を追跡します。
  • インデックスの推奨事項: 欠落している複合インデックスや最適でない複合インデックスを特定し、ダッシュボードから直接推奨インデックスを作成します(Enterprise エディション)。

Query Insights のデータ

Query Insights には、次の API メソッドのデータが含まれます。

これらのメソッドを使用するクエリに関して、特定のプロジェクト、データベース、1 分から 30 日までの範囲の期間のデータを表示できます。同等の構造を使用するクエリに対するデータは、単一の正規化されたクエリでキャプチャされます。

Query Insights は、クエリに関する次の情報を返します。

正規化されたクエリテキスト テキストで表されたクエリ構造。
実行回数 選択した時間枠内の実行数。
エラー件数 選択した時間枠内のエラーの数。
平均実行時間(ms) データベースがクエリの処理に要したミリ秒単位の平均時間。
返された結果の平均数 検索によって返された結果の数。結果には、ドキュメント数、コレクション ID 数、集計されたバケット数が含まれます。
スキャンされたドキュメントの平均数 クエリでスキャンされたドキュメントの数。
スキャンされたインデックス エントリの平均数 クエリを実行するために参照されたインデックス エントリの数。
平均実行時間別の負荷 平均レイテンシに基づいて上位のクエリをフィルタするのに役立つデータ。
負荷(課金対象の読み取りオペレーションの合計数) 課金対象の読み取りオペレーションの合計数に基づいて上位のクエリをフィルタするのに役立つデータ。
インデックスに関する推奨事項 Enterprise エディション データベースのクエリに推奨される複合インデックス、使用されるインデックス、推定されるワークロードへの影響。

データの粒度と保持

データの粒度は、指定された期間によって異なります。

  • 過去 6 時間以内の場合、1 分単位の粒度
  • 過去 4 日以内の場合、10 分単位の粒度
  • 過去 30 日以内の場合、1 時間単位の粒度

Query Insights の最大データ保持期間は 30 日です。1 分のデータは 6 時間保存され、10 分のデータは 4 日間保存され、1 時間のデータは 30 日間保存されます。

Query Insights を表示

Firestore データベースの Query Insights を表示するには、次の操作を行います。

  1. Google Cloud コンソールで、[データベース] ページに移動します。

    [データベース] に移動

  2. データベースのリストからデータベースを選択します。

  3. ナビゲーション メニューで [Query Insights] をクリックします。

[Query Insights] ページには、正規化されたクエリ統計のテーブルとともに、上位のクエリの時系列グラフが表示されます。クエリのパフォーマンスを分析するには:

  • 期間を選択して、過去の傾向または準リアルタイムの指標を 1 分間隔で表示します。
  • [読み込みのタイプ] リストを使用して、平均レイテンシまたは読み取りオペレーションの合計数で上位のクエリをランク付けします。
  • テーブル内の個々のクエリを選択して、実行回数、レイテンシ、スキャンされたドキュメント、スキャンされたインデックス エントリ、エラー数をグラフにプロットして比較します。

インデックスに関する推奨事項

Query Insights のインデックスの推奨事項は、Firestore Enterprise エディション データベースで頻繁に実行されるクエリ形状の、欠落している、または最適でない複合インデックス構成を自動的に特定します。

Firestore Enterprise エディションでは、一致する複合インデックスがなくてもクエリを実行できます。これにより、コレクション全体のスキャンやメモリ内並べ替えオペレーションが遅くなる可能性があります。Query Insights ダッシュボードは、過去のクエリ実行統計を分析し、クエリ レイテンシを最適化して課金対象のスキャンされたドキュメントを削減するために、ターゲットを絞った複合インデックスを提案します。

インデックスの推奨事項の仕組み

オフライン バッチ パイプラインは、過去の上位クエリを定期的に評価します。

  • クエリ構造分析: 頻繁に実行されるクエリから、等価、並べ替え、範囲の述語を抽出します。
  • 候補インデックスの生成: インデックス順序付けヒューリスティック(等価 > 並べ替え > 範囲)を使用して、候補となる複合インデックス定義を生成します。
  • オプティマイザーの評価: 候補インデックスをクエリエンジンのコストモデルに挿入して、ベースラインのクエリ実行コストと、インデックスが作成された仮想的な実行プランを比較します。
  • ワークロードへの影響のランキング: 推定されるワークロードの総コスト削減額に基づいて、推奨インデックスを影響度別にランク付けします。
    • 高: コレクション全体のスキャンを選択的なインデックス シークに変換し、ドキュメントの読み取りと実行レイテンシを大幅に削減します。
    • MEDIUM: 事前に並べ替えられたインデックス結果を提供することで、メモリ内並べ替えなどのコストのかかるオペレーションを排除します。
    • 低: シークがわずかに改善されます。
Google Cloud コンソールからインデックスの推奨事項を表示し、推奨インデックスを作成するには:

  1. Google Cloud コンソールで、[データベース] ページに移動します。

    [データベース] に移動

  2. データベースのリストから、Enterprise エディションのデータベースを選択します。

  3. ナビゲーション メニューで [Query Insights] をクリックします。

  4. クエリテーブルで、クエリの形状を選択して、[推奨事項] カードを表示します。カードには次の情報が表示されます。

    • 推奨される複合インデックス定義(コレクション、フィールド、並べ替え順、array-contains プロパティ)。
    • ワークロードへの推定影響ティア(HIGH、MEDIUM、LOW)。
    • 使用されたインデックス、またはコレクションのフルスキャンが実行されたことを示すインジケーター。
  5. 推奨事項カードの [インデックスを作成] をクリックします。ダイアログが開き、コレクション、クエリ スコープ、フィールドが事前入力されます。

  6. [作成] をクリックして、インデックスの作成を開始します。インデックスのビルドの進行状況は、 Google Cloud コンソールの [インデックス] ページでモニタリングできます。

サポートされているエディションとモード

インデックスの推奨事項は、次の Firestore Enterprise エディションのデータベースでサポートされています。

  • ネイティブ モードの Firestore
  • MongoDB 互換の Firestore

Standard エディションのデータベースは、インデックスの推奨事項ではサポートされていません。

制限事項

  • リアルタイム リスナーは、Query Insights の統計情報に含まれません。
  • Query Insights のデータは、クエリの実行から数分以内に利用可能になります。
  • インデックスの推奨事項は、リアルタイムではなく、過去のクエリデータに基づいて定期的に生成されます。
  • インデックスの推奨事項は、新しい複合インデックスを提案します。既存のインデックスの変更や削除は提案しません。
  • インデックスの自動作成はサポートされていません。推奨インデックスは手動で作成する必要があります。
  • クエリの正規化では、リテラル値がプレースホルダに置き換えられます。インデックスの推奨事項は、特定のランタイム値ではなく、正規化されたクエリ テンプレートに基づいています。
  • コスト評価では、ライブデータ サンプリングではなくヒューリスティックが使用されます。推奨されるインデックスがすべてのシナリオでパフォーマンスを向上させるとは限りません。また、インデックスを作成すると、書き込みとストレージのオーバーヘッドが増加します。

料金

Query Insights やインデックスの推奨事項に追加料金は発生しません。

必要なロール

Query Insights ダッシュボードを表示して推奨インデックスを作成するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

これらの事前定義ロールには、Query Insights ダッシュボードを表示し、推奨インデックスを作成するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

Query Insights ダッシュボードを表示して推奨インデックスを作成するには、次の権限が必要です。

  • Query Insights を表示する: datastore.insights.get
  • 推奨インデックスを作成します。
    • datastore.indexes.create
    • datastore.indexes.update

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

次のステップ