Azure Cosmos DB データの監視のリファレンスMonitoring Azure Cosmos DB data reference

適用対象: SQL API Cassandra API Gremlin API Table API MongoDB 用 Azure Cosmos DB API

この記事では、Azure Cosmos DB のパフォーマンスと可用性を分析する目的で収集されるログとメトリック データのリファレンスを提供します。This article provides a reference of log and metric data collected to analyze the performance and availability of Azure Cosmos DB. Azure Cosmos DB の監視データの収集と分析の詳細については、Azure Cosmos DB の監視に関する記事を参照してください。See the Monitor Azure Cosmos DB article for details on collecting and analyzing monitoring data for Azure Cosmos DB.

メトリックMetrics

Azure Cosmos DB に対応するすべてのメトリックは、Cosmos DB 標準メトリック 名前空間に格納されています。All the metrics corresponding to Azure Cosmos DB are stored in the namespace Cosmos DB standard metrics. すべての Azure Monitor サポート メトリック (Azure Cosmos DB を含む) の一覧については、Azure Monitor でサポートされているメトリックに関するページを参照してください。For a list of all Azure Monitor support metrics (including Azure Cosmos DB), see Azure Monitor supported metrics. このセクションには、Azure Cosmos DB 用に自動的に収集されたすべてのプラットフォーム メトリックが一覧表示されています。This section lists all the automatically collected platform metrics collected for Azure Cosmos DB.

要求のメトリックRequest metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description DimensionsDimensions 時間の細分性Time granularities 従来のメトリックのマッピングLegacy metric mapping 使用法Usage
TotalRequests (要求の合計数)TotalRequests (Total Requests) カウント (カウント)Count (Count) 行われた要求の数Number of requests made DatabaseName、CollectionName、Region、StatusCodeDatabaseName, CollectionName, Region, StatusCode AllAll TotalRequests、Http 2xx、Http 3xx、Http 400、Http 401、内部サーバー エラー、サービス使用不可、要求の調整、1 秒あたりの平均要求数TotalRequests, Http 2xx, Http 3xx, Http 400, Http 401, Internal Server error, Service Unavailable, Throttled Requests, Average Requests per Second 分単位の細分性で、コンテナーの状態コードごとの要求数を監視するために使用されます。Used to monitor requests per status code, container at a minute granularity. 1 秒あたりの平均要求数を取得するには、分単位の Count 集計を使用して 60 で割ります。To get average requests per second, use Count aggregation at minute and divide by 60.
MetadataRequests (メタデータの要求数)MetadataRequests (Metadata Requests) カウント (カウント)Count (Count) メタデータの要求数。Count of metadata requests. Azure Cosmos DB ではアカウントごとにシステム メタデータ コンテナーが保持されており、コレクションやデータベースなどとそれらの構成を無料で列挙できます。Azure Cosmos DB maintains system metadata container for each account, that allows you to enumerate collections, databases, etc., and their configurations, free of charge. DatabaseName、CollectionName、Region、StatusCodeDatabaseName, CollectionName, Region, StatusCode AllAll メタデータ要求によるスロットルを監視するために使用されます。Used to monitor throttles due to metadata requests.
MongoRequests (Mongo 要求数)MongoRequests (Mongo Requests) カウント (カウント)Count (Count) 実行された Mongo 要求の数Number of Mongo Requests Made DatabaseName、CollectionName、Region、CommandName、ErrorCodeDatabaseName, CollectionName, Region, CommandName, ErrorCode AllAll Mongo クエリ要求率、Mongo 更新要求率、Mongo 削除要求率、Mongo 挿入要求率、Mongo カウント要求率Mongo Query Request Rate, Mongo Update Request Rate, Mongo Delete Request Rate, Mongo Insert Request Rate, Mongo Count Request Rate Mongo 要求エラー、コマンドのタイプごとの使用量を監視するために使用されます。Used to monitor Mongo request errors, usages per command type.

要求ユニット メトリックRequest Unit metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description DimensionsDimensions 時間の細分性Time granularities 従来のメトリックのマッピングLegacy metric mapping 使用法Usage
MongoRequestCharge (Mongo 要求の料金)MongoRequestCharge (Mongo Request Charge) カウント (合計)Count (Total) 使用された Mongo 要求の単位数Mongo Request Units Consumed DatabaseName、CollectionName、Region、CommandName、ErrorCodeDatabaseName, CollectionName, Region, CommandName, ErrorCode AllAll Mongo クエリ要求の料金、Mongo 更新要求の料金、Mongo 削除要求の料金、Mongo 挿入要求の料金、Mongo カウント要求の料金Mongo Query Request Charge, Mongo Update Request Charge, Mongo Delete Request Charge, Mongo Insert Request Charge, Mongo Count Request Charge 1 分間の Mongo リソース RU を監視するために使用されます。Used to monitor Mongo resource RUs in a minute.
TotalRequestUnits (合計要求ユニット数)TotalRequestUnits (Total Request Units) カウント (合計)Count (Total) 消費された要求の単位数Request Units consumed DatabaseName、CollectionName、Region、StatusCodeDatabaseName, CollectionName, Region, StatusCode AllAll TotalRequestUnitsTotalRequestUnits 1 分単位の細分性で RU の合計使用量を監視するために使用されます。Used to monitor Total RU usage at a minute granularity. 1 秒あたりの RU の平均使用量を取得するには、分単位の合計量を使用して 60 で割ります。To get average RU consumed per second, use Total aggregation at minute and divide by 60.
ProvisionedThroughput (プロビジョニングされたスループット)ProvisionedThroughput (Provisioned Throughput) カウント (最大)Count (Maximum) コンテナー単位の細分性でプロビジョニングされたスループットProvisioned throughput at container granularity DatabaseName、ContainerNameDatabaseName, ContainerName 5 M5M コンテナーあたりのプロビジョニングされたスループットを監視するために使用されます。Used to monitor provisioned throughput per container.

Storage のメトリックStorage metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description DimensionsDimensions 時間の細分性Time granularities 従来のメトリックのマッピングLegacy metric mapping 使用法Usage
AvailableStorage (使用可能なストレージ)AvailableStorage (Available Storage) バイト (合計)Bytes (Total) リージョンあたりの 5 分単位の細分性で報告された使用可能なストレージの合計Total available storage reported at 5-minutes granularity per region DatabaseName、CollectionName、RegionDatabaseName, CollectionName, Region 5 M5M 使用可能なストレージAvailable Storage 使用可能なストレージ容量を監視するために使用されます (固定ストレージ コレクションにのみ適用されます)。最小の細分性は 5 分にする必要があります。Used to monitor available storage capacity (applicable only for fixed storage collections) Minimum granularity should be 5 minutes.
DataUsage (データ利用状況)DataUsage (Data Usage) バイト (合計)Bytes (Total) リージョンあたりの 5 分単位の細分性で報告されたデータ使用量の合計Total data usage reported at 5-minutes granularity per region DatabaseName、CollectionName、RegionDatabaseName, CollectionName, Region 5 M5M データ サイズData size コンテナーおよびリージョンでの合計データ使用量を監視するために使用されます。最小の細分性は 5 分にする必要があります。Used to monitor total data usage at container and region, minimum granularity should be 5 minutes.
IndexUsage (インデックスの使用量)IndexUsage (Index Usage) バイト (合計)Bytes (Total) リージョンあたりの 5 分単位の細分性で報告されたインデックス使用量の合計Total Index usage reported at 5-minutes granularity per region DatabaseName、CollectionName、RegionDatabaseName, CollectionName, Region 5 M5M インデックス サイズIndex Size コンテナーおよびリージョンでの合計データ使用量を監視するために使用されます。最小の細分性は 5 分にする必要があります。Used to monitor total data usage at container and region, minimum granularity should be 5 minutes.
DocumentQuota (ドキュメントのクォータ)DocumentQuota (Document Quota) バイト (合計)Bytes (Total) リージョンあたりの 5 分単位の細分性で報告されたストレージ クォータの合計。Total storage quota reported at 5-minutes granularity per region. DatabaseName、CollectionName、RegionDatabaseName, CollectionName, Region 5 M5M ストレージの容量Storage Capacity コンテナーおよびリージョンでの合計クォータを監視するために使用されます。最小の細分性は 5 分にする必要があります。Used to monitor total quota at container and region, minimum granularity should be 5 minutes.
DocumentCount (ドキュメント数)DocumentCount (Document Count) カウント (合計)Count (Total) リージョンあたりの 5 分単位の細分性で報告された合計ドキュメント数Total document count reported at 5-minutes granularity per region DatabaseName、CollectionName、RegionDatabaseName, CollectionName, Region 5 M5M ドキュメント数Document Count コンテナーおよびリージョンでのドキュメント数を監視するために使用されます。最小の細分性は 5 分にする必要があります。Used to monitor document count at container and region, minimum granularity should be 5 minutes.

待機時間のメトリックLatency metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description DimensionsDimensions 時間の細分性Time granularities 使用法Usage
ReplicationLatency (レプリケーションの待機時間)ReplicationLatency (Replication Latency) ミリ秒 (最小、最大、平均)MilliSeconds (Minimum, Maximum, Average) geo 対応アカウントのソースおよびターゲット リージョン全体の P99 のレプリケーション待機時間P99 Replication Latency across source and target regions for geo-enabled account SourceRegion、TargetRegionSourceRegion, TargetRegion AllAll geo レプリケートされたアカウントの任意の 2 つのリージョン間で P99 のレプリケーション待機時間を監視するために使用されます。Used to monitor P99 replication latency between any two regions for a geo-replicated account.
サーバー側の待機時間Server Side Latency ミリ秒 (平均)MilliSeconds (Average) サーバーが要求の処理に要した時間。Time taken by the server to process the request. CollectionName、ConnectionMode、DatabaseName、OperationType、PublicAPIType、RegionCollectionName, ConnectionMode, DatabaseName, OperationType, PublicAPIType, Region AllAll Azure Cosmos DB サーバーでの要求の待機時間の監視に使用されます。Used to monitor the request latency on the Azure Cosmos DB server.

可用性のメトリックAvailability metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description 時間の細分性Time granularities 従来のメトリックのマッピングLegacy metric mapping 使用法Usage
ServiceAvailability (サービスの可用性)ServiceAvailability (Service Availability) パーセント (最小、最大)Percent (Minimum, Maximum) アカウントは 1 時間単位の細分性で可用性を要求しますAccount requests availability at one hour granularity 1 時間1H サービスの可用性Service Availability 成功した要求の合計数に対する割合を表します。Represents the percent of total passed requests. 状態コードが 410、500、または 503 の場合、要求はシステム エラーのために失敗したと見なされます。時間単位の細分性でアカウントの可用性を監視するために使用されます。A request is considered to be failed due to system error if the status code is 410, 500 or 503 Used to monitor availability of the account at hour granularity.

Cassandra API のメトリックCassandra API metrics

メトリック (メトリックの表示名)Metric (Metric Display Name) ユニット (集計の種類)Unit (Aggregation Type) 説明Description DimensionsDimensions 時間の細分性Time granularities 使用法Usage
CassandraRequests (Cassandra 要求)CassandraRequests (Cassandra Requests) カウント (カウント)Count (Count) 実行された Cassandra API 要求の数Number of Cassandra API requests made DatabaseName、CollectionName、ErrorCode、Region、OperationType、ResourceTypeDatabaseName, CollectionName, ErrorCode, Region, OperationType, ResourceType AllAll Cassandra 要求を 1 単単位の細分性で監視するために使用されます。Used to monitor Cassandra requests at a minute granularity. 1 秒あたりの平均要求数を取得するには、分単位の Count 集計を使用して 60 で割ります。To get average requests per second, use Count aggregation at minute and divide by 60.
CassandraRequestCharges (Cassandra 要求の料金)CassandraRequestCharges (Cassandra Request Charges) カウント (Sum、Min、Max、Avg)Count (Sum, Min, Max, Avg) Cassandra API によって使用される要求ユニット数Request units consumed by the Cassandra API DatabaseName、CollectionName、Region、OperationType、ResourceTypeDatabaseName, CollectionName, Region, OperationType, ResourceType AllAll Cassandra API アカウントによって 1 分あたりで使用される RU を監視するために使用されます。Used to monitor RUs used per minute by a Cassandra API account.
CassandraConnectionClosures (Cassandra 接続の終了)CassandraConnectionClosures (Cassandra Connection Closures) カウント (カウント)Count (Count) 終了した Cassandra 接続の数Number of Cassandra Connections closed ClosureReason、RegionClosureReason, Region AllAll クライアントと Azure Cosmos DB Cassandra API の間の接続を監視するために使用されます。Used to monitor the connectivity between clients and the Azure Cosmos DB Cassandra API.

詳細については、Azure Monitor でサポートされているすべてのプラットフォーム メトリックの一覧を参照してください。For more information, see a list of all platform metrics supported in Azure Monitor.

リソース ログResource logs

次の表に、Azure Cosmos DB のリソース ログのプロパティを示します。The following table lists the properties of resource logs in Azure Cosmos DB. リソース ログは Azure Monitor ログまたは Azure Storage に収集されます。The resource logs are collected into Azure Monitor Logs or Azure Storage. Azure Monitor では、ログは MICROSOFT.DOCUMENTDB という名前のリソース プロバイダー** の下にある、AzureDiagnostics テーブルに収集されます。In Azure Monitor, logs are collected in the AzureDiagnostics table under the resource provider** name of MICROSOFT.DOCUMENTDB.

Azure Storage のフィールドまたはプロパティAzure Storage field or property Azure Monitor ログのプロパティAzure Monitor Logs property 説明Description
timetime TimeGeneratedTimeGenerated 操作が発生した日時 (UTC)。The date and time (UTC) when the operation occurred.
resourceIdresourceId リソースResource ログが有効になっている Azure Cosmos DB アカウント。The Azure Cosmos DB account for which logs are enabled.
categorycategory カテゴリCategory Azure Cosmos DB の場合、利用できるログの種類には DataPlaneRequestsMongoRequestsQueryRuntimeStatisticsPartitionKeyStatisticsPartitionKeyRUConsumptionControlPlaneRequestsCassandraRequestsGremlinRequests があります。For Azure Cosmos DB, DataPlaneRequests, MongoRequests, QueryRuntimeStatistics, PartitionKeyStatistics, PartitionKeyRUConsumption, ControlPlaneRequests, CassandraRequests, GremlinRequests are the available log types.
operationNameoperationName OperationNameOperationName 操作の名前。Name of the operation. 操作名は、CreateUpdateReadReadFeedDeleteReplaceExecuteSqlQueryQueryJSQueryHeadHeadFeedUpsert のいずれかです。The operation name can be Create, Update, Read, ReadFeed, Delete, Replace, Execute, SqlQuery, Query, JSQuery, Head, HeadFeed, or Upsert.
propertiesproperties 該当なしn/a このフィールドの内容については、以下の行を参照してください。The contents of this field are described in the rows that follow.
activityIdactivityId activityId_gactivityId_g ログに記録された操作の一意の GUID。The unique GUID for the logged operation.
userAgentuserAgent userAgent_suserAgent_s 要求の送信元であったクライアント ユーザー エージェントを示す文字列。A string that specifies the client user agent from which, the request was sent. ユーザー エージェントの形式は {user agent name}/{version} です。The format of user agent is {user agent name}/{version}.
requestResourceTyperequestResourceType requestResourceType_srequestResourceType_s アクセスされたリソースの種類。The type of the resource accessed. この値は、database、container、document、attachment、user、permission、stored procedure、trigger、user-defined function、offer のいずれかです。This value can be database, container, document, attachment, user, permission, stored procedure, trigger, user-defined function, or an offer.
statusCodestatusCode statusCode_sstatusCode_s 操作の応答状態。The response status of the operation.
requestResourceIdrequestResourceId ResourceIdResourceId 要求に関連するリソース ID。The resourceId that pertains to the request. 実行された操作に応じて、この値は databaseRidcollectionRid、または documentRidを指すことがあります。Depending on the operation performed, this value may point to databaseRid, collectionRid, or documentRid.
clientIpAddressclientIpAddress clientIpAddress_sclientIpAddress_s クライアントの IP アドレス。The client's IP address.
requestChargerequestCharge requestCharge_srequestCharge_s 操作で使用された 1 秒あたりの RU 数The number of RU/s that are used by the operation
collectionRidcollectionRid collectionId_scollectionId_s コレクションの一意の ID。The unique ID for the collection.
durationduration duration_dduration_d 操作時間 (ミリ秒)。The duration of the operation, in milliseconds.
requestLengthrequestLength requestLength_srequestLength_s 要求の長さ (バイト単位)。The length of the request, in bytes.
responseLengthresponseLength responseLength_sresponseLength_s 応答の長さ (バイト単位)。The length of the response, in bytes.
resourceTokenPermissionIdresourceTokenPermissionId resourceTokenPermissionId_sresourceTokenPermissionId_s このプロパティは、指定したリソース トークンのアクセス許可 ID を示します。This property indicates the resource token permission Id that you have specified. アクセス許可の詳細については、データへのアクセスのセキュリティ保護に関するページを参照してください。To learn more about permissions, see the Secure access to your data article.
resourceTokenPermissionModeresourceTokenPermissionMode resourceTokenPermissionMode_sresourceTokenPermissionMode_s このプロパティは、リソース トークンの作成時に設定したアクセス許可モードを示します。This property indicates the permission mode that you have set when creating the resource token. アクセス許可モードとして指定できるのは、"all" や "read" などの値です。The permission mode can have values such as "all" or "read". アクセス許可の詳細については、データへのアクセスのセキュリティ保護に関するページを参照してください。To learn more about permissions, see the Secure access to your data article.
resourceTokenUserRidresourceTokenUserRid resourceTokenUserRid_sresourceTokenUserRid_s リソース トークンが認証に使われると、この値は空ではありません。This value is non-empty when resource tokens are used for authentication. 値は、ユーザーのリソース ID を示します。The value points to the resource ID of the user.
responseLengthresponseLength responseLength_sresponseLength_s 応答の長さ (バイト単位)。The length of the response, in bytes.

すべての Azure Monitor ログ カテゴリと関連スキーマのリンクの一覧については、Azure Monitor のログ カテゴリとスキーマに関するページを参照してください。For a list of all Azure Monitor log categories and links to associated schemas, see Azure Monitor Logs categories and schemas.

Azure Monitor ログ テーブルAzure Monitor Logs tables

Azure Cosmos DB は、Azure Monitor ログの Kusto テーブルを使用します。Azure Cosmos DB uses Kusto tables from Azure Monitor Logs. これらのテーブルに対して Log Analytics を使用してクエリを実行できます。You can query these tables with Log analytics. Kusto bales が使用する一覧については、Azure Monitor ログのテーブル参照に関する記事を参照してください。For a list of Kusto bales uses, see the Azure Monitor Logs table reference article.

参照See Also