Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following table lists the metrics available for the Microsoft.DocumentDB/DatabaseAccounts resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Advanced platform metrics - A premium, paid tier of platform metrics in Azure Monitor that provide more granular observability for Azure resources.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
- Dimensions - Dimensions available for the metric.
- Time Grains - Intervals at which the metric is sampled. For example,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export -S Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.
For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
For a list of supported logs, see Supported log categories - Microsoft.DocumentDB/DatabaseAccounts
Category: Requests
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Region Added Region Added |
AddRegion |
No | Count | Count | Region |
PT5M | No |
| Autoscaled RU Autoscaled RU consumption with Per Region and Per Partition Autoscale |
AutoscaledRU |
No | Count | Maximum | DatabaseName, CollectionName, PhysicalPartitionId, Region |
PT1M, PT5M, PT1H, P1D | No |
| Autoscale Max Throughput Autoscale Max Throughput |
AutoscaleMaxThroughput |
No | Count | Maximum | DatabaseName, CollectionName |
PT5M, PT1H | No |
| (deprecated) Available Storage "Available Storage"will be removed from Azure Monitor at the end of September 2023. Cosmos DB collection storage size is now unlimited. The only restriction is that the storage size for each logical partition key is 20GB. You can enable PartitionKeyStatistics in Diagnostic Log to know the storage consumption for top partition keys. For more info about Cosmos DB storage quota, please check this doc /azure/cosmos-db/concepts-limits. After deprecation, the remaining alert rules still defined on the deprecated metric will be automatically disabled post the deprecation date. |
AvailableStorage |
No | Bytes | Total (Sum), Average | CollectionName, DatabaseName, Region |
PT5M | No |
| Backup Mode Update Backup Mode Update |
BackupModeUpdate |
No | Count | Count | BackupMode |
PT5M | No |
| Periodic Backup Policy Interval Update Periodic Backup Policy Interval Update. Valid range: 60 -1440 minutes. |
BackupPolicyIntervalUpdate |
No | Count | Count | BackupIntervalInHours |
PT5M | No |
| Periodic Backup Policy Redundancy Update Periodic Backup Policy Redundancy Update |
BackupPolicyRedundancyUpdate |
No | Count | Count | BackupRedundancy |
PT5M | No |
| Periodic Backup Policy Retention Update Periodic Backup Policy Retention Update. Valid range: 8 - 720 hours. |
BackupPolicyRetentionUpdate |
No | Count | Count | BackupRetentionIntervalInHours |
PT5M | No |
| Periodic Backup Policy Update Periodic Backup Policy Update |
BackupPolicyUpdate |
No | Count | Count | BackupPolicy |
PT5M | No |
| Cassandra Connection Closures Number of Cassandra connections that were closed, reported at a 1 minute granularity |
CassandraConnectionClosures |
No | Count | Average, Minimum, Maximum, Total (Sum) | APIType, Region, ClosureReason |
PT1M | No |
| (deprecated) Cassandra Connector Average ReplicationLatency Cassandra Connector Average ReplicationLatency |
CassandraConnectorAvgReplicationLatency |
No | MilliSeconds | Average | <none> | PT5M | No |
| (deprecated) Cassandra Connector Replication Health Status Cassandra Connector Replication Health Status |
CassandraConnectorReplicationHealthStatus |
No | Count | Count | NotStarted, ReplicationInProgress, Error |
PT5M | No |
| Cassandra Keyspace Created Cassandra Keyspace Created |
CassandraKeyspaceCreate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Cassandra Keyspace Deleted Cassandra Keyspace Deleted |
CassandraKeyspaceDelete |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Cassandra Keyspace Throughput Updated Cassandra Keyspace Throughput Updated |
CassandraKeyspaceThroughputUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Cassandra Keyspace Updated Cassandra Keyspace Updated |
CassandraKeyspaceUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Cassandra Request Charges RUs consumed for Cassandra requests made |
CassandraRequestCharges |
No | Count | Total (Sum), Average, Minimum, Maximum | APIType, DatabaseName, CollectionName, Region, OperationType, ResourceType |
PT1M | No |
| Cassandra Requests Number of Cassandra requests made |
CassandraRequests |
No | Count | Count | APIType, DatabaseName, CollectionName, Region, OperationType, ResourceType, ErrorCode |
PT1M | No |
| Cassandra Table Created Cassandra Table Created |
CassandraTableCreate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Cassandra Table Deleted Cassandra Table Deleted |
CassandraTableDelete |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Cassandra Table Throughput Updated Cassandra Table Throughput Updated |
CassandraTableThroughputUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Cassandra Table Updated Cassandra Table Updated |
CassandraTableUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| ContinuousBackupMode Tier Update ContinuousBackupMode Tier Update |
ContinuousTierUpdate |
No | Count | Count | ContinuousBackupTier |
PT5M | No |
| Account Created Account Created |
CreateAccount |
No | Count | Count | <none> | PT5M | No |
| Data Usage Total data usage reported at 5 minutes granularity |
DataUsage |
No | Bytes | Total (Sum), Average, Maximum, Minimum | CollectionName, DatabaseName, Region |
PT5M, PT15M, PT30M, PT1H | No |
| DedicatedGatewayAverageCPUUsage Average CPU usage across dedicated gateway instances |
DedicatedGatewayAverageCPUUsage |
No | Percent | Average | Region, MetricType |
PT5M | No |
| DedicatedGatewayAverageMemoryUsage Average memory usage across dedicated gateway instances, which is used for both routing requests and caching data |
DedicatedGatewayAverageMemoryUsage |
No | Bytes | Average | Region |
PT5M | No |
| DedicatedGatewayCPUUsage CPU usage across dedicated gateway instances |
DedicatedGatewayCPUUsage |
No | Percent | Average, Maximum, Minimum | Region, ApplicationType |
PT1M | No |
| DedicatedGatewayMaximumCPUUsage Average Maximum CPU usage across dedicated gateway instances |
DedicatedGatewayMaximumCPUUsage |
No | Percent | Average, Maximum | Region, MetricType |
PT5M | No |
| DedicatedGatewayMemoryUsage Memory usage across dedicated gateway instances |
DedicatedGatewayMemoryUsage |
No | Bytes | Average, Maximum, Minimum | Region, ApplicationType |
PT1M | No |
| DedicatedGatewayRequests Requests at the dedicated gateway |
DedicatedGatewayRequests |
No | Count | Count | DatabaseName, CollectionName, CacheExercised, OperationName, Region, CacheHit |
PT1M | No |
| Account Deleted Account Deleted |
DeleteAccount |
No | Count | Count | <none> | PT5M | No |
| (deprecated) Document Count Total document count reported at 5 minutes, 1 hour and 1 day granularity |
DocumentCount |
No | Count | Total (Sum), Average | CollectionName, DatabaseName, Region |
PT5M, PT1H, P1D | No |
| Document Count Total document count reported at 5 minutes, 1 hour and 1 day granularity |
DocumentCountV2 |
No | Count | Total (Sum), Average | CollectionName, DatabaseName, Region |
PT5M, PT1H, P1D | No |
| Document Quota Total storage quota reported at 5 minutes granularity |
DocumentQuota |
No | Bytes | Total (Sum), Average | CollectionName, DatabaseName, Region |
PT5M | No |
| Global Secondary Index Catchup Gap In Minutes Maximum time difference in minutes between data in source container and data propagated to global secondary index |
GlobalSecondaryIndexCatchupGapInMinutes |
No | Count | Maximum | Region, TargetContainerName, BuildType |
PT1M | No |
| Global Secondary Index Propagation Latency In Seconds Average time difference in seconds between data in source container and data propagated to global secondary index |
GlobalSecondaryIndexPropagationLatencyInSeconds |
No | Count | Average | Region, TargetContainerName, TargetContainerStatus, BuildType |
PT1M | No |
| Gremlin Database Created Gremlin Database Created |
GremlinDatabaseCreate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Gremlin Database Deleted Gremlin Database Deleted |
GremlinDatabaseDelete |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Gremlin Database Throughput Updated Gremlin Database Throughput Updated |
GremlinDatabaseThroughputUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Gremlin Database Updated Gremlin Database Updated |
GremlinDatabaseUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Gremlin Graph Created Gremlin Graph Created |
GremlinGraphCreate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Gremlin Graph Deleted Gremlin Graph Deleted |
GremlinGraphDelete |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Gremlin Graph Throughput Updated Gremlin Graph Throughput Updated |
GremlinGraphThroughputUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Gremlin Graph Updated Gremlin Graph Updated |
GremlinGraphUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Gremlin Request Charges Request Units consumed for Gremlin requests made |
GremlinRequestCharges |
No | Count | Total (Sum), Average, Minimum, Maximum | APIType, DatabaseName, CollectionName, Region |
PT1M | No |
| Gremlin Requests Number of Gremlin requests made |
GremlinRequests |
No | Count | Count | APIType, DatabaseName, CollectionName, Region, ErrorCode |
PT1M | No |
| Index Usage Total index usage reported at 5 minutes granularity |
IndexUsage |
No | Bytes | Total (Sum), Average, Maximum, Minimum | CollectionName, DatabaseName, Region, IsLeakedPartition |
PT5M, PT15M, PT30M, PT1H | No |
| IntegratedCacheEvictedEntriesSize Size of the entries evicted from the integrated cache |
IntegratedCacheEvictedEntriesSize |
No | Bytes | Average | Region |
PT5M | No |
| IntegratedCacheItemExpirationCount Number of items evicted from the integrated cache due to TTL expiration |
IntegratedCacheItemExpirationCount |
No | Count | Average | Region, CacheEntryType |
PT5M | No |
| IntegratedCacheItemHitRate Number of point reads that used the integrated cache divided by number of point reads routed through the dedicated gateway with eventual consistency |
IntegratedCacheItemHitRate |
No | Percent | Average | Region, CacheEntryType |
PT5M | No |
| IntegratedCacheQueryExpirationCount Number of queries evicted from the integrated cache due to TTL expiration |
IntegratedCacheQueryExpirationCount |
No | Count | Average | Region, CacheEntryType |
PT5M | No |
| IntegratedCacheQueryHitRate Number of queries that used the integrated cache divided by number of queries routed through the dedicated gateway with eventual consistency |
IntegratedCacheQueryHitRate |
No | Percent | Average | Region, CacheEntryType |
PT5M | No |
| Materialized View Catchup Gap In Minutes Maximum time difference in minutes between data in source container and data propagated to materialized view |
MaterializedViewCatchupGapInMinutes |
No | Count | Maximum | Region, TargetContainerName, BuildType |
PT1M | No |
| (deprecated) Materialized Views Builder Average CPU Usage Average CPU usage across materialized view builder instances, which are used for populating data in materialized views |
MaterializedViewsBuilderAverageCPUUsage |
No | Percent | Average | Region, MetricType |
PT5M | No |
| Materialized Views Builder Average Memory Usage Average memory usage across materialized view builder instances, which are used for populating data in materialized views |
MaterializedViewsBuilderAverageMemoryUsage |
No | Bytes | Average | Region, InstanceId, ApplicationType |
PT5M | No |
| Materialized Views Builder CPU Usage CPU usage across materialized view builder instances, which are used for populating data in materialized views |
MaterializedViewsBuilderCPUUsage |
No | Percent | Average, Maximum | Region, InstanceId, ApplicationType |
PT5M | No |
| (deprecated) Materialized Views Builder Maximum CPU Usage Average Maximum CPU usage across materialized view builder instances, which are used for populating data in materialized views |
MaterializedViewsBuilderMaximumCPUUsage |
No | Percent | Average, Maximum | Region, MetricType |
PT5M | No |
| Metadata Requests Count of metadata requests. Cosmos DB maintains system metadata collection for each account, that allows you to enumerate collections, databases, etc, and their configurations, free of charge. |
MetadataRequests |
No | Count | Count | DatabaseName, CollectionName, Region, StatusCode, Role |
PT1M | No |
| Mongo Collection Created Mongo Collection Created |
MongoCollectionCreate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Mongo Collection Deleted Mongo Collection Deleted |
MongoCollectionDelete |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Mongo Collection Throughput Updated Mongo Collection Throughput Updated |
MongoCollectionThroughputUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Mongo Collection Updated Mongo Collection Updated |
MongoCollectionUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Mongo Database Deleted Mongo Database Deleted |
MongoDatabaseDelete |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Mongo Database Throughput Updated Mongo Database Throughput Updated |
MongoDatabaseThroughputUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Mongo Database Created Mongo Database Created |
MongoDBDatabaseCreate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Mongo Database Updated Mongo Database Updated |
MongoDBDatabaseUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Mongo Request Charge Mongo Request Units Consumed |
MongoRequestCharge |
No | Count | Total (Sum), Average, Maximum | DatabaseName, CollectionName, Region, CommandName, ErrorCode, Status |
PT1M | No |
| Mongo Requests Number of Mongo Requests Made |
MongoRequests |
No | Count | Count | DatabaseName, CollectionName, Region, CommandName, ErrorCode, Status |
PT1M | No |
| Normalized RU Consumption Max RU consumption percentage per minute |
NormalizedRUConsumption |
No | Percent | Maximum, Average | CollectionName, DatabaseName, Region, PartitionKeyRangeId, CollectionRid, PhysicalPartitionId, OfferOwnerRid |
PT1M, PT5M, PT1H, P1D | No |
| Region Offlined Region Offlined |
OfflineRegion |
No | Count | Count | Region, StatusCode |
PT1M | No |
| Region Onlined Region Onlined |
OnlineRegion |
No | Count | Count | Region, StatusCode |
PT1M | No |
| Partition Global Write Status Global Write Status of Each Partition |
PartitionGlobalWriteStatus |
No | Count | Total (Sum) | WriteStatus, Region |
PT1M | No |
| Physical Partition Count Physical Partition Count |
PhysicalPartitionCount |
No | Count | Maximum | CollectionName, DatabaseName, IsSharedThroughputOffer, OfferOwnerRid, Region |
PT5M | No |
| Physical Partition Size Physical Partition Size in bytes |
PhysicalPartitionSizeInfo |
No | Bytes | Maximum, Average | CollectionName, DatabaseName, PhysicalPartitionId, OfferOwnerRid, Region |
PT1M, PT5M, PT1H, P1D | No |
| Physical Partition Throughput Physical Partition Throughput |
PhysicalPartitionThroughputInfo |
No | Count | Maximum | CollectionName, DatabaseName, PhysicalPartitionId, OfferOwnerRid, Region |
PT5M, PT1H, P1D | No |
| Provisioned Throughput Provisioned Throughput |
ProvisionedThroughput |
No | Count | Maximum | DatabaseName, CollectionName, Region |
PT5M, PT1H, P1D | No |
| Region Failed Over Region Failed Over |
RegionFailover |
No | Count | Count | <none> | PT5M | No |
| Region Removed Region Removed |
RemoveRegion |
No | Count | Count | Region |
PT5M | No |
| P99 Replication Latency P99 Replication Latency across source and target regions for geo-enabled account |
ReplicationLatency |
No | MilliSeconds | Minimum, Maximum, Average | SourceRegion, TargetRegion |
PT1M | No |
| (deprecated) Server Side Latency "Server Side Latency" will be removed from Azure Monitor at the end of August 2025. Please use "Server Side Latency Direct" and "Server Side Latency Gateway" to monitor the latency instead. For more info about latency metrics, please refer to this /azure/cosmos-db/monitor-server-side-latency. |
ServerSideLatency |
No | MilliSeconds | Average, Minimum, Maximum, Total (Sum) | DatabaseName, CollectionName, Region, ConnectionMode, OperationType, PublicAPIType |
PT1M, PT5M, PT1H, P1D | No |
| Server Side Latency Direct Server Side Latency in Direct Connection Mode |
ServerSideLatencyDirect |
No | MilliSeconds | Average, Minimum, Maximum, Total (Sum) | DatabaseName, CollectionName, Region, ConnectionMode, OperationType, PublicAPIType, APIType, IsExternal |
PT1M, PT5M, PT1H, P1D | No |
| Server Side Latency Gateway Server Side Latency in Gateway Connection Mode |
ServerSideLatencyGateway |
No | MilliSeconds | Average, Minimum, Maximum, Total (Sum) | DatabaseName, CollectionName, Region, ConnectionMode, OperationType, PublicAPIType, APIType, IsExternal |
PT1M, PT5M, PT1H, P1D | No |
| Service Availability Account requests availability at one hour, day or month granularity |
ServiceAvailability |
No | Percent | Minimum, Average, Maximum | IsExternal |
PT1H | No |
| Sql Container Created Sql Container Created |
SqlContainerCreate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Sql Container Deleted Sql Container Deleted |
SqlContainerDelete |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Sql Container Throughput Updated Sql Container Throughput Updated |
SqlContainerThroughputUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Sql Container Updated Sql Container Updated |
SqlContainerUpdate |
No | Count | Count | ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Sql Database Created Sql Database Created |
SqlDatabaseCreate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Sql Database Deleted Sql Database Deleted |
SqlDatabaseDelete |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| Sql Database Throughput Updated Sql Database Throughput Updated |
SqlDatabaseThroughputUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| Sql Database Updated Sql Database Updated |
SqlDatabaseUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| AzureTable Table Created AzureTable Table Created |
TableTableCreate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| AzureTable Table Deleted AzureTable Table Deleted |
TableTableDelete |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, OperationType |
PT5M | No |
| AzureTable Table Throughput Updated AzureTable Table Throughput Updated |
TableTableThroughputUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest |
PT5M | No |
| AzureTable Table Updated AzureTable Table Updated |
TableTableUpdate |
No | Count | Count | ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType |
PT5M | No |
| Total Requests Number of requests made |
TotalRequests |
No | Count | Count | DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, CapacityType, PriorityLevel, ConnectionMode, IsExternal |
PT1M | No |
| Total Requests (Preview) Number of SQL requests |
TotalRequestsPreview |
No | Count | Count | DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, PriorityLevel, IsExternal, ThroughputBucket |
PT1M | No |
| Total Request Units SQL Request Units consumed |
TotalRequestUnits |
No | Count | Total (Sum), Average, Maximum | DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, CapacityType, PriorityLevel |
PT1M | No |
| Total Request Units (Preview) Request Units consumed with CapacityType |
TotalRequestUnitsPreview |
No | Count | Total (Sum), Average, Maximum | DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, CapacityType, PriorityLevel, ThroughputBucket |
PT1M | No |
| Account Keys Updated Account Keys Updated |
UpdateAccountKeys |
No | Count | Count | KeyType |
PT5M | No |
| Account Network Settings Updated Account Network Settings Updated |
UpdateAccountNetworkSettings |
No | Count | Count | <none> | PT5M | No |
| Account Replication Settings Updated Account Replication Settings Updated |
UpdateAccountReplicationSettings |
No | Count | Count | <none> | PT5M | No |
| Account Diagnostic Settings Updated Account Diagnostic Settings Updated |
UpdateDiagnosticsSettings |
No | Count | Count | DiagnosticSettingsName, ResourceGroupName |
PT5M | No |