Azure Cosmos DB を監視する
この記事では、次の内容について説明します。
- このサービスに対して収集できる監視データの種類。
- そのデータを分析する方法。
Note
このサービスや Azure Monitor を既に使い慣れていて、監視データの分析方法だけを確認したい場合は、この記事で後述する分析に関するセクションをご覧ください。
Azure リソースに依存するクリティカルなアプリケーションやビジネス プロセスがある場合は、システムを監視し、そのアラートを受け取る必要があります。 Azure Monitor サービスでは、システムのすべてのコンポーネントからメトリックとログを収集して集計します。 Azure Monitor を使用すると、可用性、パフォーマンス、回復性を視覚化し、問題に関する通知を受け取ることができます。 Azure portal、PowerShell、Azure CLI、REST API、またはクライアント ライブラリは、監視データの設定および表示に使用できます。
- Azure Monitor の詳細については、「Azure Monitor の概要」を参照してください。
- Azure リソース全般の監視方法の詳細については、「Azure Monitor を使用した Azure リソースの監視」をご覧ください。
分析情報
Azure の一部のサービスについては、サービスを監視するための開始点となる監視ダッシュボードが Azure portal に組み込まれています。 これらのダッシュボードは、"分析情報" と呼ばれており、Azure portal の Azure Monitor の [分析情報ハブ] にあります。
Azure Cosmos DB 分析情報
Azure Cosmos DB 分析情報は、Azure Monitor のブック機能に基づいた機能です。 Azure Cosmos DB 分析情報を使用して、すべての Azure Cosmos DB リソースの全体的なパフォーマンス、失敗、容量、操作上の正常性を、統一された対話型エクスペリエンスのビューで表示します。
Azure Cosmos DB 分析情報の詳細については、次の記事をご覧ください。
リソースの種類
Azure では、リソースの種類と ID の概念を使用して、サブスクリプション内のすべてを識別します。 リソースの種類は、Azure で実行されているすべてのリソースのリソース ID の一部でもあります。 たとえば、Microsoft.Compute/virtualMachines
は、仮想マシンのリソースの種類の 1 つです。 サービスとそれに関連付けられるリソースの種類の一覧については、リソース プロバイダーに関するページをご覧ください。
同様に、Azure Monitor では、コア監視データがリソースの種類 (名前空間とも呼ばれます) に基づいてメトリックとログに整理されます。 リソースの種類に応じてさまざまなメトリックとログが使用できます。 サービスは、複数のリソースの種類に関連付けられる可能性があります。
Azure Cosmos DB のリソースの種類の詳細については、「Azure Cosmos DB の監視データのリファレンス」を参照してください。
データ ストレージ
Azure Monitor の場合:
- メトリック データは、Azure Monitor メトリック データベースに保存されます。
- ログ データは、Azure Monitor ログ ストアに保存されます。 Log Analytics は、Azure portal のツールの 1 つであり、このストアに対してクエリを実行することができます。
- Azure アクティビティ ログは、Azure Portal 内の独自のインターフェイスを持つ別のストアです。
必要に応じて、メトリックおよびアクティビティ ログ データを Azure Monitor ログ ストアにルーティングできます。 次に、Log Analytics を使用してデータのクエリを実行し、他のログ データと関連付けることができます。
多くのサービスで診断設定を使用して、メトリックとログ データを Azure Monitor の外部の他のストレージの場所に送信できます。 たとえば、Azure Storage、ホステッド パートナー システム、Event Hubs を使用する Azure 以外のパートナー システムなどがあります。
Azure Monitor によるデータの保存方法の詳細については、「Azure Monitor データ プラットフォーム」を参照してください。
Azure Monitor プラットフォームのメトリック
Azure Monitor により、ほとんどのサービスに関するプラットフォーム メトリックが提供されます。 これらのメトリックは次のとおりです。
- 名前空間ごとに個別に定義されます。
- Azure Monitor 時系列メトリック データベースに保存されます。
- 軽量であり、凖リアルタイムのアラートをサポートできます。
- リソースのパフォーマンスを時間の経過と共に追跡するために使用されます。
収集: Azure Monitor では、プラットフォーム メトリックを自動的に収集します。 構成は必要ありません。
ルーティング: また、いくつかのプラットフォーム メトリックを Azure Monitor ログまたは Log Analytics にルーティングして、他のログ データを使用してクエリを実行することもできます。 各メトリックの DS エクスポート設定を確認して、診断設定を使用してメトリックを Azure Monitor ログまたは Log Analytics にルーティングできるかどうかを確認します。
- 詳細については、「メトリック診断設定」を参照してください。
- サービスの診断設定を構成する場合は、「Azure Monitor の診断設定を作成する」を参照してください。
Azure Monitor ですべてのリソースに対して収集できるすべてのメトリックの一覧については、Azure Monitor でサポートされるメトリックに関する記事を参照してください。
Azure Monitor では、既定で Azure Cosmos DB のメトリックが収集されます。 何も明示的に構成する必要はありません。 ほとんどのメトリックは、Azure Cosmos DB ポータル ページまたは Azure Monitor ページから使用できます。 既定では、メトリックは 1 分の細分性で収集されます。 細分性は、選択したメトリックによって異なる場合があります。 既定の保有期間について詳しくは、Azure Monitor メトリックの保有期間に関する記事を参照してください
Azure Cosmos DB のサーバー側のメトリックには、スループット、ストレージ、可用性、待機時間、一貫性、システム レベルのメトリックが含まれます。 クライアント側では、要求の料金、アクティビティ ID、例外とスタック トレースの情報、HTTP ステータスとサブステータスのコード、診断文字列の詳細を収集できます。 既定では、これらのメトリックの保持期間は 7 日間です。 このデータは、問題のデバッグや、Azure Cosmos DB サポート チームに問い合わせる必要がある場合に使用できます。
メトリックのディメンション値 (コンテナー名など) は、大文字と小文字の区別がありません。 この状況では、そのような名前を持つコンテナーに対するテレメトリとアクションで混乱や競合が発生する可能性があります。 これらのディメンション値に対して文字列比較を行う場合は、大文字と小文字を区別しない比較を使用してください。
Azure Cosmos DB で使用可能なメトリックの一覧については、「Azure Cosmos DB の監視データのリファレンス」を参照してください。
Azure Monitor ベース以外のメトリック
このサービスは、Azure Monitor メトリック データベースに含まれていない他のメトリックを提供します。
- Azure Cosmos DB の監視に役立つパートナー ソリューションとツールの詳細については、「サードパーティ ソリューションを使用して Azure Cosmos DB を監視する」を参照してください。
- Prometheus メトリックを使って Azure Cosmos DB 用の Java SDK で Micrometer メトリックを実装するには、「Java 用の Micrometer クライアント メトリックを使用する」を参照してください。
Azure Monitor リソース ログ
リソース ログでは、Azure リソースによって実行された操作に関する分析情報を提供します。 ログは自動的に生成されますが、保存するかクエリを実行するには、Azure Monitor ログにルーティングする必要があります。 ログはカテゴリに分類されています。 特定の名前空間に複数のリソース ログ カテゴリが含まれる場合があります。
収集: リソース ログは、"診断設定" を作成してログを 1 つ以上の場所にルーティングするまでは収集および保存されません。 診断設定を作成するときは、収集するログのカテゴリを指定します。 診断設定を作成して管理するには、Azure portal、プログラム、Azure Policy など、複数の方法があります。
ルーティング: 既定で推奨されるのは、リソース ログを Azure Monitor ログにルーティングして、他のログ データを使用してクエリを実行できるようにすることです。 Azure Storage、Azure Event Hubs、特定の Microsoft 監視パートナーなど、その他の場所も利用できます。 詳細については、「Azure リソース ログ」およびリソース ログの送信先に関するページを参照してください。
リソース ログの収集、保存、ルーティングの詳細については、「Azure Monitor の診断設定」を参照してください。
Azure Monitor で使用可能なすべてのリソース ログ カテゴリの一覧については、Azure Monitor でサポートされているリソース ログに関するページを参照してください。
Azure Monitor 内のすべてのリソース ログには、同じヘッダー フィールドの後にサービス固有のフィールドがあります。 共通のスキーマの概要については、Azure Monitor リソース ログのスキーマに関する記事をご覧ください。
Azure Cosmos DB アカウントの診断ログを監視し、Azure Monitor からダッシュボードを作成することができます。 1 秒単位で発生するイベントやトレースなどのデータは、ログとして格納されます。 たとえば、コンテナーのスループットが変化すると、Azure Cosmos DB アカウントのプロパティが変更されます。 ログには、これらのイベントがキャプチャされます。 収集したデータに対してクエリを実行することで、これらのログを分析できます。
使用可能なリソース ログ カテゴリ、それに関連する Log Analytics テーブル、Azure Cosmos DB のログ スキーマについては、「Azure Cosmos DB の監視データのリファレンス」をご覧ください。
Azure activity log
アクティビティ ログには、Azure リソースごとに操作を追跡する、そのリソースの外から見たサブスクリプションレベルのイベント (新しいリソースの作成や仮想マシンの起動など) が含まれます。
収集: アクティビティ ログ イベントは、Azure portal で表示するために、個別のストアに自動的に生成および収集されます。
ルート指定: アクティビティ ログ データを Azure Monitor ログに送信して、他のログ データと共に分析できます。 Azure Storage、Azure Event Hubs、特定の Microsoft 監視パートナーなど、その他の場所も利用できます。 アクティビティ ログをルーティングする方法の詳細については、Azure アクティビティ ログの概要に関するページをご覧ください。
継続的バックアップ モードの復元アクションを監査する
アクティビティ ログを使うと、Azure Cosmos DB アカウントで実行された継続モードのすべてのポイントインタイム リストアの一覧を表示できます。 Azure portal でこれらの操作を表示する方法については、継続的バックアップ モードのポイントインタイム リストア アクションの監査に関する記事をご覧ください。
監視データを分析する
監視データを分析するためのツールは多数あります。
Azure Monitor ツール
Azure Monitor は、次の基本的なツールをサポートします。
メトリックス エクスプローラー。Azure リソースのメトリックを表示および分析できる Azure portal のツール。 詳細については、「Azure Monitor メトリック ス エクスプローラーを使用したメトリックの分析」を参照してください。
Log Analytics は、Kusto クエリ言語 (KQL) を使用して、ログ データのクエリと分析を可能にする Azure Portal のツールです。 詳細については、「Azure Monitor でログ クエリの使用を開始する」を参照してください。
アクティビティ ログ。表示および基本的な検索用のユーザー インターフェイスが Azure portal に用意されています。 より詳細な分析を行うには、データを Azure Monitor ログにルーティングし、Log Analytics でより複雑なクエリを実行する必要があります。
より複雑な視覚化を可能にするツールは次のとおりです。
- ダッシュボードを使用すると、さまざまな種類のデータを組み合わせて、Azure portal 内の 1 つのペインに表示できます。
- ブック。Azure portal で作成できるカスタマイズ可能なレポート。 ブックには、テキスト、メトリック、ログ クエリを含めることができます。
- Grafana。運用ダッシュボードに優れたオープン プラットフォーム ツール。 Grafana を使用して、Azure Monitor 以外の複数のソースからのデータを含むダッシュボードを作成できます。
- Power BI。さまざまなデータ ソースにわたって対話型の視覚化を提供するビジネス分析サービス。 Azure Monitor からログ データを自動的にインポートするように Power BI を構成して、これらの視覚化を利用できます。
Azure Monitor エクスポート ツール
次の方法を使用して、Azure Monitor から他のツールにデータを取得できます。
メトリック: メトリック用 REST API を使用して、Azure Monitor メトリック データベースからメトリック データを抽出します。 この API では、取得したデータを絞り込むためのフィルター式がサポートされています。 詳細については、Azure Monitor REST API のリファレンスをご覧ください。
ログ: REST API または関連するクライアント ライブラリを使用します。
もう 1 つのオプションは、ワークスペース データのエクスポートです。
Azure Monitor 用 REST API の使用を開始するには、「Azure 監視 REST API のチュートリアル」を参照してください。
Azure Cosmos DB メトリックの分析
Azure Monitor メトリックス エクスプローラーを使用すると、Azure Cosmos DB アカウント ポータルのナビゲーションで [監視] の下にある [メトリック] を選択して、Azure Cosmos DB のメトリックを、他の Azure サービスからのメトリックと一緒に分析できます。 メトリックス エクスプローラーの使用方法の詳細については、「Azure Monitor メトリックス エクスプローラーでメトリックを分析する」を参照してください。
Azure Cosmos DB リソースのサーバー側の待機時間、要求ユニットの使用状況、正規化された要求ユニットの使用状況を監視できます。 要求ユニット、ストレージ、待機時間、可用性、Cassandra などに固有のメトリックを選択できます。
クライアント側では、要求の料金、アクティビティ ID、例外とスタック トレースの情報、HTTP ステータスとサブステータスのコード、診断文字列のメトリックを収集して問題をデバッグできます。
詳細情報と詳細な手順については、次の記事を参照してください。
Azure Monitor でサポートされているすべてのリソース メトリックの一覧については、「Azure Monitor でサポートされているメトリック」を参照してください。 Azure Cosmos DB 用に収集されるプラットフォーム メトリックの一覧については、「Azure Cosmos DB 監視データのリファレンス」の「メトリック」を参照してください。
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 を使用します。 使用できるメトリック定義は、次の形式を使用して取得できます。
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 Monitor ログのデータはテーブルに格納されます。 各テーブルには、独自の固有のプロパティ セットがあります。 Azure Monitor 内のすべてのリソース ログには、同じフィールドの後にサービス固有のフィールドがあります。 共通のスキーマの概要については、Azure Monitor リソース ログのスキーマに関する記事をご覧ください。
Azure Cosmos DB 用に収集されるリソース ログの種類については、「Azure Cosmos DB 監視データのリファレンス」を参照してください。
Azure Cosmos DB の Azure Monitor ログの操作の詳細については、次の記事を参照してください。
Kusto クエリ
Kusto クエリ言語 (KQL) を使用して、Azure Monitor ログ/Log Analytics ストアの監視データを分析できます。
重要
ポータルでサービスのメニューから [ログ] を選択すると、クエリ スコープが現在のサービスに設定された状態で Log Analytics が開きます。 このスコープは、ログ クエリにその種類のリソースのデータのみが含まれることを意味します。 他の Azure サービスのデータを含むクエリを実行する場合は、[Azure Monitor] メニューから [ログ] を選択します。 詳細については、「Azure Monitor Log Analytics のログ クエリのスコープと時間範囲」を参照してください。
いずれかのサービスに関する一般的なクエリの一覧については、Log Analytics クエリ インターフェイスに関するページを参照してください。
Log Analytics を使用して Kusto クエリを発行する前に、コントロール プレーン操作の診断ログを有効にする必要があります。 診断ログを有効にする場合は、リソース固有のテーブルまたは単一の AzureDiagnostics テーブル (レガシ) のどちらにデータを格納するかを選択します。 Kusto クエリの正確なテキストは、選択したコレクション モードによって異なります。
- Azure Cosmos DB に関する問題のトラブルシューティングに役立つ簡単なクエリについては、「診断クエリに関する問題のトラブルシューティング」をご覧ください。
- Azure Diagnostics (レガシ) とリソース固有 (プレビュー) のテーブルに送信される診断ログを使う、Azure Cosmos DB アカウントに関する問題のトラブルシューティングに役立つ、より高度なクエリについては、「Azure Cosmos DB for NoSQL で高度な診断クエリを使用して問題をトラブルシューティングする」をご覧ください。
[ログ検索] 検索バーに入力して Azure Cosmos DB リソースの監視に利用できるクエリを紹介します。
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
Azure Cosmos DB に関する問題のトラブルシューティングに使用できる Kusto クエリについては、次の記事を参照してください。
これらの例は、Kusto 照会言語 (KQL) を使用して Azure Monitor で実行できるたくさんのクエリのほんの一部にすぎません。 その他の例については、「Kusto クエリのサンプル」を参照してください。
警告
Azure Monitor のアラートにより、監視データで特定の状態が見つかったときに事前に通知を受け取ります。 アラートにより、ユーザーが気付く前に、管理者が問題を識別して対処できます。 詳細については、Azure Monitor アラートに関するページを参照してください。
Azure リソースに関する一般的なアラートのソースは数多くあります。 Azure リソースに関する一般的なアラートの例については、ログ アラート クエリのサンプルに関するページをご覧ください。 Azure Monitor ベースライン アラート (AMBA) サイトには、重要なプラットフォーム メトリック アラート、ダッシュボード、ガイドラインを実装するための半自動化された方法が用意されています。 このサイトは、Azure ランディング ゾーン (ALZ) の一部であるすべてのサービスを含む、Azure サービスの継続的に拡張されるサブセットに適用されます。
共通アラート スキーマを使用すると、Azure Monitor のアラート通知の使用を標準化できます。 詳細については、「共通アラート スキーマ」をご覧ください。
アラートの種類
Azure Monitor データ プラットフォームでは、任意のメトリックまたはログ データ ソースに対してアラートを生成できます。 監視するサービスと収集する監視データに応じて、さまざまな種類のアラートがあります。 アラートの種類に応じて、さまざまな利点と欠点があります。 詳細については、適切な種類の監視アラートの選択に関するページをご覧ください。
次の一覧では、作成できる Azure Monitor アラートの種類について説明します。
- メトリック アラートでは、リソース メトリックを定期的に評価します。 メトリックはプラットフォーム メトリック、カスタム メトリック、メトリックに変換された Azure Monitor からのログまたは Application Insights メトリックにすることができます。 メトリック警告では、複数の条件と動的しきい値を適用することもできます。
- ログ アラートでは、ユーザーは Log Analytics クエリを使用して、定義済みの頻度でリソース ログを評価できます。
- アクティビティ ログ アラートは、定義された条件と一致する新しいアクティビティ ログ イベントが発生したときにトリガーされます。 Resource Health アラートと Service Health アラートは、サービスとリソースの正常性を報告するアクティビティ ログ アラートです。
一部の Azure サービスでは、スマート検出アラート、Prometheus アラート、推奨されるアラート ルールもサポートされています。
一部のサービスでは、同じ Azure リージョン内に存在する同じ種類の複数のリソースに同じメトリック警告ルールを適用することで、大規模に監視することができます。 監視対象リソースごとに個別の通知が送信されます。 サポートされている Azure サービスとクラウドについては、「1 つのアラート ルールで複数のリソースを監視する」をご覧ください。
Azure Cosmos DB の警告ルール
次の表に、Azure Cosmos DB の一般的および推奨される警告ルールを示します。
アラートの種類 | 条件 | 説明 |
---|---|---|
要求ユニットのレート制限 (メトリック アラート) | ディメンション名: StatusCode、演算子: Equals、ディメンション値: 429 | コンテナーまたはデータベースが、プロビジョニングされたスループット制限を超えるとアラートが表示されます。 |
リージョンのフェールオーバー | 演算子: Greater than、集計の種類: Count、しきい値: 1 | 1 つのリージョンがフェールオーバーされたとき。 このアラートは、サービスが管理するフェールオーバーを有効にしなかった場合に役立ちます。 |
キーのローテーション (アクティビティ ログ アラート) | イベント レベル: Informational、ステータス: started | アカウント キーがローテーションされるとアラートが表示されます。 新しいキーを使用してアプリケーションを更新できます。 |
Azure Cosmos DB のアラートを作成する方法の詳細と手順については、「メトリックに関するアラートを作成する」を参照してください。 論理パーティション キーのストレージが 20 GB に近づいているかどうかを監視するアラートを作成するには、「論理パーティション キーのサイズに関するアラートを作成する」を参照してください。
Advisor の推奨事項
一部のサービスでは、リソースの操作中にクリティカルな条件や差し迫った変更が発生した場合は、ポータルのサービス [概要] ページにアラートが表示されます。 アラートの詳細と推奨される修正は、左側のメニューの [監視] の下の [アドバイザーのレコメンデーション] に表示されます。 通常の操作中、アドバイザーのレコメンデーションは表示されません。
Azure Advisor の詳細については、Azure Advisor の概要に関するページをご覧ください。
関連するコンテンツ
- Azure Cosmos DB 用に作成されるメトリック、ログ、その他の重要な値のリファレンスについては、「Azure Cosmos DB の監視データのリファレンス」を参照してください。
- Azure リソースの監視に関する一般的な詳細情報については、「Azure Monitor を使用した Azure リソースの監視」を参照してください。