Azure Cosmos DB を監視する

[アーティクル]
12/05/2022

適用対象: NoSQL MongoDB Cassandra Gremlin Table

Azure リソースに依存するクリティカルなアプリケーションとビジネスプロセスがある場合は、それらのリソースの可用性、パフォーマンス、操作を監視する必要があります。この記事では、Azure Cosmos DB データベースによって生成される監視データと、Azure Monitor の機能を使用してこのデータについての分析とアラートを行う方法について説明します。

クライアント側のメトリックとサーバー側のメトリックを使用してデータを監視することができます。サーバー側のメトリックを使用する場合、Azure Cosmos DB に格納されているデータを監視するには、次のオプションを使用します。

Azure Cosmos DB ポータルからの監視: Azure Cosmos DB アカウントの [メトリック] タブ内で使用可能なメトリックを使用して監視できます。このタブのメトリックには、スループット、ストレージ、可用性、待機時間、一貫性、システムレベルのメトリックが含まれます。既定では、これらのメトリックの保持期間は 7 日間です。詳細については、この記事の「Azure Cosmos DB から収集したデータの監視」を参照してください。
Azure Monitor のメトリックを使用した監視: Azure Cosmos DB アカウントのメトリックを監視し、Azure Monitor からダッシュボードを作成することができます。既定では、Azure Monitor で Azure Cosmos DB メトリックを収集するため、何も明示的に構成する必要はありません。これらのメトリックは 1 分単位で収集されます。粒度は、選択したメトリックによって異なる場合があります。既定では、これらのメトリックの保有期間は 30 日間です。前のオプションで使用できるほとんどのメトリックも、これらのメトリックで利用できます。メトリックのディメンション値 (コンテナー名など) は、大文字と小文字が区別されません。そのため、これらのディメンション値に対して文字列比較を行う場合は、大文字と小文字を区別しない比較を使用する必要があります。詳細については、この記事の「メトリックデータの分析」を参照してください。
Azure Monitor の診断ログを使用した監視: Azure Cosmos DB アカウントのログを監視し、Azure Monitor からダッシュボードを作成することができます。 1 秒単位で発生するイベントやトレースなどのデータは、ログとして格納されます。たとえば、コンテナーのスループットが変化すると、Azure Cosmos DB アカウントのプロパティが変更され、これらのイベントがログ内にキャプチャされます。収集したデータに対してクエリを実行することで、これらのログを分析できます。詳細については、この記事の「ログデータの分析」を参照してください。
SDK を使用したプログラムによる監視: .NET、Java、Python、Node.js SDK、および REST API のヘッダーを使用して、Azure Cosmos DB アカウントをプログラムによって監視できます。詳細については、この記事の「Azure Cosmos DB をプログラムで監視する」セクションを参照してください。

次の図は、Azure portal を通じて Azure Cosmos DB アカウントを監視するために使用できるさまざまなオプションを示しています。

Azure portal で使用可能な監視オプション

Azure Cosmos DB を使用すると、クライアント側で、要求の料金、アクティビティ ID、例外/スタックトレース情報、HTTP ステータス/サブステータスコード、診断文字列の詳細を収集して、発生する可能性のある問題をデバッグできます。この情報は、Azure Cosmos DB サポートチームに問い合わせる必要がある場合にも必要です。

監視の概要

各 Azure Cosmos DB アカウントの Azure portal の [概要] ページには、要求の合計、特定の HTTP ステータスコードになった要求、時間ごとの課金など、リソースの使用状況の要約が表示されます。この情報は役に立ちますが、このペインで入手できる監視データの量はごくわずかです。このデータの一部は自動的に収集され、リソースを作成するとすぐに分析に使用できるようになります。構成によっては、他の種類のデータ収集を有効にできます。

Azure Monitor とは

Azure Cosmos DB では、Azure Monitor を使用して監視データを作成します。Azure Monitor は Azure のフルスタックの監視サービスであり、他のクラウドやオンプレミスのリソースに加えて、Azure リソースを監視するための完全な機能セットが提供されます。

Azure サービスの監視について理解が十分でない場合は、まず「Azure Monitor を使用した Azure リソースの監視」の記事にある次の概念の説明をお読みください。

Azure Monitor とは
監視に関連するコスト
Azure で収集される監視データ
データ収集の構成
監視データの分析とアラート生成のための Azure の標準ツール

以下のセクションでは、この記事を基に、Azure Cosmos DB から収集される特定のデータについて説明します。また、Azure のツールを使用してデータの収集を構成し、このデータを分析するための例を示します。

Azure Cosmos DB 分析情報

Azure Cosmos DB 分析情報は、Azure Monitor のブック機能に基づいた機能で、以下のセクションで説明する、Azure Cosmos DB 用に収集される監視データと同じものを使用します。 Azure Monitor は、すべての Azure Cosmos DB リソースの全体的なパフォーマンス、障害、容量、および運用の正常性を、一元的な対話型エクスペリエンスで表示するために使用します。また、詳細な分析とアラート生成のために、Azure Monitor のその他の機能を利用します。詳細については、Azure Cosmos DB 分析情報の探索に関する記事を参照してください。

Note

コンテナーを作成するときは、同じ名前で大文字と小文字が異なる 2 つのコンテナーを作成しないようにしてください。これは、Azure プラットフォームの一部で大文字と小文字が区別されないため、このような名前のコンテナーでテレメトリとアクションの混同や衝突が発生する可能性があるためです。

データの監視

Azure Cosmos DB では、他の Azure リソースと同じ種類の監視データを収集します。これについては、Azure リソースの監視データに関するページを参照してください。 Azure Cosmos DB によって作成されるログおよびメトリックの詳細なリファレンスについては、Azure Cosmos DB 監視データリファレンスを参照してください。

Azure portal 上にある、各 Azure Cosmos DB データベースの [概要] ページでは、データベースの要求や時間ごとの課金使用量など、データベースの使用状況の要約が表示されます。これは有用な情報ですが、見ることのできる監視データはごくわずかです。このデータの一部は自動的に収集され、データベースを作成するとすぐに分析に使用できるようになりますが、構成によってはさらにデータ収集を有効にできます。

[概要] ページ

収集とルーティング

プラットフォームメトリックとアクティビティログは自動的に収集および格納されますが、診断設定を使用して他の場所にルーティングすることもできます。

リソースログは、診断設定を作成して 1 つ以上の場所にルーティングするまでは収集および格納されません。

Azure portal といくつかの診断クエリ例を使用して診断設定を作成するプロセスの詳細については、「Azure でプラットフォームログとメトリックを収集するための診断設定を作成する」を参照してください。診断設定を作成するときは、収集するログのカテゴリを指定します。

収集できるメトリックとログについては、次のセクションで説明します。

メトリックの分析

Azure Cosmos DB は、メトリックを操作するためのカスタムエクスペリエンスを提供します。 Azure Monitor のメニューから [Metrics](メトリック) を開き、メトリックスエクスプローラーを使用して、Azure Cosmos DB のメトリックを、他の Azure サービスからのメトリックと一緒に分析することができます。このツールの使用方法の詳細については、「Azure メトリックスエクスプローラーの概要」を参照してください。また、Azure Cosmos DB リソースのサーバー側の待機時間、要求ユニットの使用状況、正規化された要求ユニットの使用状況を監視する方法についても確認できます。

Azure Cosmos DB 用に収集されるプラットフォームメトリックの一覧については、「Azure Cosmos DB 監視データのリファレンス」記事の「メトリック」を参照してください。

Azure Cosmos DB のすべてのメトリックは、Azure Cosmos DB standard metrics (Cosmos DB 標準メトリック) 名前空間に含まれています。フィルターをグラフに追加するときは、次のディメンションをこれらのメトリックと共に使用できます。

CollectionName
DatabaseName
OperationType
リージョン
StatusCode

参考のために、Azure Monitor でサポートされているすべてのリソースメトリックの一覧を確認できます。

Azure Cosmos DB の操作レベルのメトリックを表示する

Azure portal にサインインします。
左側のナビゲーションバーから [監視] を選択し、 [メトリック] を選択します。
[メトリック] ウィンドウから、[リソースの選択] を選択し、必要なサブスクリプションとリソースグループを選択します。 [リソースの種類] では、[Azure Cosmos DB accounts](Azure Cosmos DB アカウント) を選択し、既存の Azure Cosmos DB アカウントの一つを選択し、[適用] を選択します。
次に、使用可能なメトリックの一覧からメトリックを選択できます。要求ユニット、ストレージ、待機時間、可用性、Cassandra などに固有のメトリックを選択できます。この一覧で使用可能なすべてのメトリックの詳細については、「カテゴリ別のメトリック」の記事を参照してください。この例では、 [要求ユニット] および集計値として [Avg] を選択します。

これらの詳細に加えて、メトリックの [時間の範囲] と [時間の粒度] を選択することもできます。最大で、過去 30 日間のメトリックを表示できます。フィルターを適用すると、そのフィルターに基づいてグラフが表示されます。選択した期間に消費された要求ユニットの 1 分あたりの平均数を確認できます。

メトリックにフィルターを追加する

メトリックと、特定の CollectionName、DatabaseName、OperationType、Region、および StatusCode によって表示されるグラフをフィルターすることもできます。メトリックにフィルターを適用するには、 [フィルターの追加] を選択し、OperationType などの必要なプロパティを選択し、Query などの値を選択します。その後グラフには、選択した期間のクエリ操作で消費された要求ユニットが表示されます。ストアドプロシージャを介して実行された操作は、ログに記録されないため、OperationType メトリックでは使用できません。

メトリック細分性を選択するためのフィルターの追加

[Apply splitting](分割の適用) オプションを使用すると、メトリックをグループ化できます。たとえば、次の図に示すように、要求ユニットを操作の種類ごとにグループ化し、すべての操作のグラフを一度に表示できます。

分割の適用フィルターの追加

ログの分析

Azure Monitor ログのデータはテーブルに格納され、各テーブルには独自の一意のプロパティセットがあります。

Azure Monitor 内のすべてのリソースログには、同じフィールドの後にサービス固有のフィールドがあります。共通のスキーマの概要については、Azure Monitor リソースログのスキーマに関する記事をご覧ください。 Azure Cosmos DB 用に収集されるリソースログの種類の一覧については、「Azure Cosmos DB 監視データのリファレンス」を参照してください。

アクティビティログは、サブスクリプションレベルのイベントの分析情報を提供するプラットフォームです。個別に表示できるほか、Azure Monitor ログにルーティングして、Log Analytics を使用してより複雑なクエリを実行することもできます。

Azure Cosmos DB は、次のテーブルにデータを格納します。

テーブル	説明
AzureDiagnostics	リソースログを格納するために複数のサービスによって使用される共通テーブル。 Azure Cosmos DB のリソースログは `MICROSOFT.DOCUMENTDB` で識別できます。
AzureActivity	アクティビティログのすべてのレコードを格納する共通テーブル。

サンプル Kusto クエリ

Log Analytics を使用して Kusto クエリを発行する前に、コントロールプレーン操作の診断ログを有効にする必要があります。診断ログを有効にする場合は、単一の AzureDiagnostics テーブル (レガシ) またはリソース固有のテーブルのどちらにデータを格納するかを選択します。

Azure Cosmos DB のメニューから [ログ] を選択すると、クエリのスコープが現在の Azure Cosmos DB アカウントに設定された状態で Log Analytics が開きます。ログクエリには、そのリソースからのデータのみが含まれます。

重要

他のアカウントのデータや他の Azure サービスのデータを含むクエリを実行する場合は、 [Azure Monitor] メニューから [ログ] を選択します。詳細については、「Azure Monitor Log Analytics のログクエリのスコープと時間範囲」を参照してください。

[ログ検索] 検索バーに入力して Azure Cosmos DB リソースの監視に利用できるクエリを紹介します。クエリの正確なテキストは、診断ログを有効にしたときに選択したコレクションモードによって異なります。

AzureDiagnostics テーブル (レガシ)
リソース固有のテーブル

Azure Cosmos DB からすべてのコントロールプレーンログを照会するには:

AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB"
| where Category=="ControlPlaneRequests"

Azure Cosmos DB からすべてのデータプレーンログを照会するには:

AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB"
| where Category=="DataPlaneRequests"

1 つのリソースに固有の、フィルター処理されたデータプレーンログの一覧を照会するには:
```
AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB"
| where Category=="DataPlaneRequests"
| where Resource=="<account-name>"
```
重要

AzureDiagnostics テーブルでは、ResourceId、ResourceGroup、ResourceProvider、Resource などのように、多くのフィールドで大文字と小文字が区別されます。

リソース別にグループ化されたデータプレーンログの数を取得するには:

AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB"
| where Category=="DataPlaneRequests"
| summarize count() by Resource

操作の種類別にグループ化されたデータプレーンログのグラフを生成するには:

AzureDiagnostics
| where ResourceProvider=="MICROSOFT.DOCUMENTDB"
| where Category=="DataPlaneRequests"
| summarize count() by OperationName
| render columnchart

Azure Cosmos DB からすべてのコントロールプレーンログを照会するには:
```
CDBControlPlaneRequests
```
Azure Cosmos DB からすべてのデータプレーンログを照会するには:
```
CDBDataPlaneRequests
```
1 つのリソースに固有の、フィルター処理されたデータプレーンログの一覧を照会するには:
```
CDBDataPlaneRequests
| where AccountName=="<account-name>"
```
リソース別にグループ化されたデータプレーンログの数を取得するには:
```
CDBDataPlaneRequests
| summarize count() by AccountName
```
操作の種類別にグループ化されたデータプレーンログのグラフを生成するには:
```
CDBDataPlaneRequests
| summarize count() by OperationName
| render piechart
```

これらの例は、Kusto 照会言語を使用して Azure Monitor で実行できるたくさんのクエリのほんの一部にすぎません。詳細については、「Kusto クエリのサンプル」を参照してください。

警告

Azure Monitor のアラートは、監視データで重要な状態が見つかると事前に通知します。これにより、ユーザーが気付く前に、管理者が問題を識別して対処できます。アラートはメトリック、ログ、アクティビティログに対して設定できます。アラートの種類に応じて、さまざまな利点と欠点があります。

例として、リソースに関するアラートルールをいくつか次の表に示します。アラートルールの詳細な一覧は、Azure portal にあります。詳細については、アラートの構成方法に関する記事を参照してください。

アラートの種類	条件	説明
要求ユニットのレート制限 (メトリックアラート)	ディメンション名:StatusCode、演算子: Equals、ディメンション値: 429	コンテナーまたはデータベースが、プロビジョニングされたスループット制限を超えるとアラートが表示されます。
リージョンのフェールオーバー	演算子:Greater than、集計の種類: カウント、しきい値: 1	1 つのリージョンがフェールオーバーされたとき。このアラートは、サービスが管理するフェールオーバーを有効にしなかった場合に役立ちます。
キーのローテーション (アクティビティログアラート)	イベントレベル: 情報、ステータス: 開始	アカウントキーがローテーションされるとアラートが表示されます。新しいキーを使用してアプリケーションを更新できます。

Azure Cosmos DB をプログラムで監視する

ポータルで使用できるアカウントレベルのメトリック (アカウントストレージの使用状況や要求総数) は、NoSQL 用 API で使用することはできません。ただし、NoSQL 用 API を使用してコレクションレベルで使用状況データを取得することはできます。コレクションレベルのデータを取得するには、次の操作を行います。

REST API を使用するには、コレクションに対して GET を実行します。コレクションのクォータおよび使用状況の情報が、応答の x-ms-resource-quota および x-ms-resource-usage ヘッダーに返されます。
.NET SDK を使用するには、DocumentClient.ReadDocumentCollectionAsync メソッドを使用します。これは、CollectionSizeUsage、DatabaseUsage、DocumentUsage などの多数の使用状況プロパティを含む ResourceResponse を返します。

その他のメトリックにアクセスするには、Azure Monitor SDK を使用します。使用できるメトリック定義は、次の URL を呼び出すことで取得できます。

https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/{DocumentDBAccountName}/providers/microsoft.insights/metricDefinitions?api-version=2018-01-01

メトリックを個別に取得する場合には、次の形式を使用します。

https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/{DocumentDBAccountName}/providers/microsoft.insights/metrics?timespan={StartTime}/{EndTime}&interval={AggregationInterval}&metricnames={MetricName}&aggregation={AggregationType}&`$filter={Filter}&api-version=2018-01-01

詳細については、Azure 監視 REST API に関する記事をご覧ください。

次のステップ

Azure Cosmos DB によって作成されるログおよびメトリックのリファレンスについては、Azure Cosmos DB 監視データリファレンスを参照してください。
Azure リソースの監視の詳細については、「Azure Monitor を使用した Azure リソースの監視」を参照してください。