Firestore のパフォーマンス モニタリングについて
Cloud Monitoring は、Google Cloud プロダクトから指標、イベント、メタデータを収集します。使用状況ダッシュボードとセキュリティ ルールの使用状況で報告されたデータには、Cloud Monitoring からもアクセスしてより詳細な分析ができます。Cloud Monitoring では、カスタム ダッシュボードと使用状況アラートを設定することもできます。
このドキュメントでは、指標の使用、カスタム指標ダッシュボードの学習、アラートの設定について説明します。
モニタリング対象リソース
Cloud Monitoring のモニタリング対象リソースは、仮想マシン、データベース、アプリケーションなどの論理エンティティまたは物理エンティティを表します。モニタリング対象リソースには、ダッシュボードを通じて調査、報告したり、アラートの作成に使用したりできる一意の指標セットが含まれています。各リソースには、リソースに関する追加情報を保持する Key-Value ペアである一連のリソースラベルもあります。リソースラベルは、そのリソースに関連付けられているすべての指標で使用できます。
Cloud Monitoring API を使用して、Firestore のパフォーマンスは次のリソースでモニタリングされます。
| 関連情報 | 説明 | サポートされているデータベース モード |
firestore.googleapis.com/Database（推奨） | project、location*、database_id の内訳を提供するモニタリング対象リソースタイプ。特定の名前なしで作成されたデータベースの場合、database_id ラベルは (default) になります。 | Datastore モードの Firestore でサポートされていない次の指標を除く、両方のモードでサポートされるすべての指標:
|
firestore_instance | Firestore プロジェクトのモニタリング対象リソースタイプ。データベースの内訳は提供されません。 | Firestore ネイティブに適用 |
datastore_request | Datastore プロジェクトのモニタリング対象リソースタイプ。データベースの内訳は提供されまん。 | 両方のモードに適用されます。 |
指標
Firestore には、Firestore ネイティブと Datastore モードの Firestore の 2 つのモードがあります。この 2 つのモードの機能の比較については、データベース モードから選択するをご覧ください。
両方のモードの指標の完全なリストについては、次のリンクをご覧ください。
サービス ランタイム指標
serviceruntime 指標は、プロジェクトのトラフィックの概要を提供します。これらの指標は、ほとんどの Google Cloud API で使用できます。consumed_api モニタリング対象リソースタイプには、これらの一般的な指標が含まれます。これらの指標は 30 分ごとにサンプリングされ、データが平滑化されます。
serviceruntime 指標の重要なリソースラベルは method です。このラベルは、呼び出された基盤となる RPC メソッドを表します。呼び出す SDK メソッドは、基盤となる RPC メソッドと必ずしも同じ名前であるとは限りません。その理由は、SDKが高レベルの API 抽象化を提供するためです。ただし、アプリケーションと Firestore の相互作用を理解するには、RPC メソッドの名前に基づいて指標を理解することが重要です。
特定の SDK メソッドの基盤となる RPC メソッドを知る必要がある場合は、API のドキュメントをご覧ください。
次のサービス ランタイム指標を使用して、データベースをモニタリングします。
api/request_count
この指標は、プロトコル（http、gRPC などのリクエスト プロトコル）、レスポンス コード（HTTP レスポンス コード）、response_code_class（2xx、4xx などのレスポンス コード クラス）、grpc_status_code（数値 gRPC レスポンス コード）にわたる完了したリクエストの数を示します。この指標を使用して、API リクエスト全体を監視し、エラー率を計算します。
図 1 に、サービスとメソッドごとにグループ化された 2xx コードを返すリクエストを示します。2xx コードは、リクエストが成功したことを示す HTTP ステータス コードです。
図 2 では、response_code でグループ化された commit を確認できます。この例では、データベースが正常であることを意味する HTTP 200 レスポンスのみが表示されています。
api/request_latencies
api/request_latencies 指標は、完了したすべてのリクエスト間のレイテンシの分布を提供します。
Firestore は、Firestore サービス コンポーネントから指標を記録します。レイテンシの指標には、Firestore がリクエストを受け取ってから、ストレージ レイヤとのやり取りを含め、レスポンスの送信が完了するまでの時間が含まれます。このため、クライアントと Firestore サービス間のラウンドトリップ レイテンシ（rtt）は、これらの指標に含まれません。
api/request_sizes と api/response_sizes
api/request_sizes 指標と api/response_sizes 指標はそれぞれ、ペイロード サイズ（バイト単位）に関する分析情報を提供します。これらは、大量のデータまたは範囲が広すぎるクエリを送信し、大きなペイロードを返す書き込みワークロードを理解するのに役立ちます。
図 5 に、RunQuery メソッドのレスポンス サイズのヒートマップを示します。サイズは安定していて、中央値は 50 バイト、全体では 10 ～ 100 バイトの間であることがわかります。ペイロード サイズは、伝送制御のオーバーヘッドを除いて、常に非圧縮バイトで測定されることに注意してください。
ドキュメントのオペレーション指標
Firestore では、読み取り、書き込み、削除のカウントが可能です。書き込み指標には、「CREATE」と「UPDATE」のオペレーションの内訳が表示されます。これらの指標は、CRUD オペレーションと一致しています。
次の指標を使用して、データベースの読み取り量と書き込み量が多いかどうかを判断できます。また、新しいドキュメントと削除されたドキュメントの割合を比較することもできます。
document/delete_ops_count: ドキュメントの削除の成功回数。document/read_ops_count: クエリまたはルックアップから正常に読み取られたドキュメントの数。document/write_ops_count: ドキュメントの書き込みの成功回数。
図 6 は、読み取りドキュメントと書き込みドキュメントの比率を表す比率を作成する方法を示しています。この例では、読み取られるドキュメントの数が、書き込まれるドキュメントの数より約 6% 多いです。
ドキュメントのオペレーション指標
これらの指標は、読み取り（ルックアップとクエリ）と Firestore データベースへの書き込み用のペイロード サイズ（バイト単位）の分布を提供します。値はペイロードの合計サイズを表します。たとえば、クエリから返された結果。これらの指標は、api/request_sizes や api/response_sizes の指標と似ていますが、主な違いはドキュメントのオペレーション指標ではより細かいサンプリングを提供するものの、内訳はあまり詳細ではない点です。
たとえば、ドキュメント オペレーション指標では datastore_request モニタリング対象リソースが使用されるため、サービスやメソッドの内訳はありません。
entity/read_sizes: 読み取られたドキュメントのサイズの分布。entity/write_sizes: 書き込まれたドキュメントのサイズの分布。
インデックス指標
インデックスの書き込みレートは、インデックスのファンアウト率を把握するために document/write_ops_count 指標と比較できます。
index/write_count: インデックスの書き込み数。
図 7 は、インデックスの書き込みレートとドキュメントの書き込みレートを比較する方法を示しています。この例では、ドキュメントの書き込みごとに約 6 つのインデックス書き込みがあります。これは、比較的小さいインデックス ファンアウトレートです。
Firebase SDK を使用してデータベースに直接接続しているクライアント
2 つのゲージ指標を使用して、モバイル SDK、ウェブ SDK、またはその両方で Firestore データベースに直接接続されたクライアントからのアクティビティを追跡できます。これらの指標には、データベース内の関連する変更が直ちにクライアントにストリーミングされるリアルタイムのスナップショット リスナーに関連する機能が含まれます。
network/active_connections: その時点でのアクティブな接続の数。各ウェブ クライアントまたはモバイル クライアントには 1 つの接続があります。network/snapshot_listeners: 接続されているすべてのクライアントで現在登録されているスナップショット リスナーの数。クライアントごとに複数の接続が存在する場合があります。
これらの指標は、Firebase コンソールの Firestore データベース内の Usage タブで確認できます。
TTL 指標
TTL 指標は、Firestore ネイティブ データベースと Datastore モードの Firestore データベースの両方で使用できます。これらの指標を使用して、TTL ポリシーの適用状況をモニタリングします。
document/ttl_deletion_count: TTL サービスによって削除されたドキュメントの合計数。
図 9 では、一定期間に 1 分ごとに削除されたドキュメントの割合を確認できます。
document/ttl_expiration_to_deletion_delays: TTL 付きのドキュメントが期限切れになってから実際に削除されるまでの経過時間。
図 10 では、この指標が、Firestore が TTL ポリシーを使用してドキュメントを削除するのにかかった時間の分布を秒単位で示していることがわかります。TTL 期限が切れたドキュメントを 99 パーセンタイルで削除するのに要する時間は 0.5 秒未満です。これは、システムが正常に動作していることを意味します。Firestore は通常、24 時間以内に期限切れのドキュメントを削除しますが、これは保証されません。24 時間以上かかる場合は、サポートにお問い合わせください。
次のステップ
- Cloud Monitoring ダッシュボードを使用して指標を表示する方法を学習します。
- 使用状況のモニタリングを使用して、ドキュメントの読み取り、書き込み、削除の推移を特定します。