Muokkaa

Jaa

Azure Cosmos DB monitoring data reference

  • Artikkeli

This article contains all the monitoring reference information for this service.

See Monitor Azure Cosmos DB for details on the data you can collect for Azure Cosmos DB and how to use it.

Metrics

This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

For a list of all Azure Monitor supported metrics, including Azure Cosmos DB, see Azure Monitor supported metrics.

Supported metrics for Microsoft.DocumentDB/DatabaseAccounts

The following table lists the metrics available for the Microsoft.DocumentDB/DatabaseAccounts resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.

Category: Requests

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Region Added

Region Added		 AddRegion Count Count Region PT5M No
Autoscaled RU

Autoscaled RU consumption with Per Region and Per Partition Autoscale		 AutoscaledRU Count Maximum DatabaseName, CollectionName, PhysicalPartitionId, Region PT1M, PT5M, PT1H, P1D No
Autoscale Max Throughput

Autoscale Max Throughput		 AutoscaleMaxThroughput 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 Bytes Total (Sum), Average CollectionName, DatabaseName, Region PT5M No
Backup Mode Update

Backup Mode Update		 BackupModeUpdate Count Count BackupMode PT5M No
Periodic Backup Policy Interval Update

Periodic Backup Policy Interval Update. Valid range: 60 -1440 minutes.		 BackupPolicyIntervalUpdate Count Count BackupIntervalInHours PT5M No
Periodic Backup Policy Redundancy Update

Periodic Backup Policy Redundancy Update		 BackupPolicyRedundancyUpdate Count Count BackupRedundancy PT5M No
Periodic Backup Policy Retention Update

Periodic Backup Policy Retention Update. Valid range: 8 - 720 hours.		 BackupPolicyRetentionUpdate Count Count BackupRetentionIntervalInHours PT5M No
Periodic Backup Policy Update

Periodic Backup Policy Update		 BackupPolicyUpdate Count Count BackupPolicy PT5M No
Cassandra Connection Closures

Number of Cassandra connections that were closed, reported at a 1 minute granularity		 CassandraConnectionClosures Count Average, Minimum, Maximum, Total (Sum) APIType, Region, ClosureReason PT1M No
Cassandra Connector Average ReplicationLatency

Cassandra Connector Average ReplicationLatency		 CassandraConnectorAvgReplicationLatency MilliSeconds Average <none> PT5M No
Cassandra Connector Replication Health Status

Cassandra Connector Replication Health Status		 CassandraConnectorReplicationHealthStatus Count Count NotStarted, ReplicationInProgress, Error PT5M No
Cassandra Keyspace Created

Cassandra Keyspace Created		 CassandraKeyspaceCreate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Cassandra Keyspace Deleted

Cassandra Keyspace Deleted		 CassandraKeyspaceDelete Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Cassandra Keyspace Throughput Updated

Cassandra Keyspace Throughput Updated		 CassandraKeyspaceThroughputUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Cassandra Keyspace Updated

Cassandra Keyspace Updated		 CassandraKeyspaceUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Cassandra Request Charges

RUs consumed for Cassandra requests made		 CassandraRequestCharges Count Total (Sum), Average, Minimum, Maximum APIType, DatabaseName, CollectionName, Region, OperationType, ResourceType PT1M No
Cassandra Requests

Number of Cassandra requests made		 CassandraRequests Count Count APIType, DatabaseName, CollectionName, Region, OperationType, ResourceType, ErrorCode PT1M No
Cassandra Table Created

Cassandra Table Created		 CassandraTableCreate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Cassandra Table Deleted

Cassandra Table Deleted		 CassandraTableDelete Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Cassandra Table Throughput Updated

Cassandra Table Throughput Updated		 CassandraTableThroughputUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Cassandra Table Updated

Cassandra Table Updated		 CassandraTableUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
ContinuousBackupMode Tier Update

ContinuousBackupMode Tier Update		 ContinuousTierUpdate Count Count ContinuousBackupTier PT5M No
Account Created

Account Created		 CreateAccount Count Count <none> PT5M No
Data Usage

Total data usage reported at 5 minutes granularity		 DataUsage Bytes Total (Sum), Average, Maximum, Minimum CollectionName, DatabaseName, Region PT5M, PT15M, PT30M, PT1H No
DedicatedGatewayAverageCPUUsage

Average CPU usage across dedicated gateway instances		 DedicatedGatewayAverageCPUUsage 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 Bytes Average Region PT5M No
DedicatedGatewayCPUUsage

CPU usage across dedicated gateway instances		 DedicatedGatewayCPUUsage Percent Average, Maximum, Minimum Region, ApplicationType PT1M No
DedicatedGatewayMaximumCPUUsage

Average Maximum CPU usage across dedicated gateway instances		 DedicatedGatewayMaximumCPUUsage Percent Average, Maximum Region, MetricType PT5M No
DedicatedGatewayMemoryUsage

Memory usage across dedicated gateway instances		 DedicatedGatewayMemoryUsage Bytes Average, Maximum, Minimum Region, ApplicationType PT1M No
DedicatedGatewayRequests

Requests at the dedicated gateway		 DedicatedGatewayRequests Count Count DatabaseName, CollectionName, CacheExercised, OperationName, Region, CacheHit PT1M No
Account Deleted

Account Deleted		 DeleteAccount Count Count <none> PT5M No
Document Count

Total document count reported at 5 minutes, 1 hour and 1 day granularity		 DocumentCount Count Total (Sum), Average CollectionName, DatabaseName, Region PT5M, PT1H, P1D No
Document Quota

Total storage quota reported at 5 minutes granularity		 DocumentQuota Bytes Total (Sum), Average CollectionName, DatabaseName, Region PT5M No
Gremlin Database Created

Gremlin Database Created		 GremlinDatabaseCreate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Gremlin Database Deleted

Gremlin Database Deleted		 GremlinDatabaseDelete Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Gremlin Database Throughput Updated

Gremlin Database Throughput Updated		 GremlinDatabaseThroughputUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Gremlin Database Updated

Gremlin Database Updated		 GremlinDatabaseUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Gremlin Graph Created

Gremlin Graph Created		 GremlinGraphCreate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Gremlin Graph Deleted

Gremlin Graph Deleted		 GremlinGraphDelete Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Gremlin Graph Throughput Updated

Gremlin Graph Throughput Updated		 GremlinGraphThroughputUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Gremlin Graph Updated

Gremlin Graph Updated		 GremlinGraphUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Gremlin Request Charges

Request Units consumed for Gremlin requests made		 GremlinRequestCharges Count Total (Sum), Average, Minimum, Maximum APIType, DatabaseName, CollectionName, Region PT1M No
Gremlin Requests

Number of Gremlin requests made		 GremlinRequests Count Count APIType, DatabaseName, CollectionName, Region, ErrorCode PT1M No
Index Usage

Total index usage reported at 5 minutes granularity		 IndexUsage Bytes Total (Sum), Average, Maximum, Minimum CollectionName, DatabaseName, Region PT5M, PT15M, PT30M, PT1H No
IntegratedCacheEvictedEntriesSize

Size of the entries evicted from the integrated cache		 IntegratedCacheEvictedEntriesSize Bytes Average Region PT5M No
IntegratedCacheItemExpirationCount

Number of items evicted from the integrated cache due to TTL expiration		 IntegratedCacheItemExpirationCount 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 Percent Average Region, CacheEntryType PT5M No
IntegratedCacheQueryExpirationCount

Number of queries evicted from the integrated cache due to TTL expiration		 IntegratedCacheQueryExpirationCount 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 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 Count Maximum Region, TargetContainerName, BuildType PT1M No
Materialized Views Builder Average CPU Usage

Average CPU usage across materialized view builder instances, which are used for populating data in materialized views		 MaterializedViewsBuilderAverageCPUUsage 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 Bytes Average Region PT5M No
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 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 Count Count DatabaseName, CollectionName, Region, StatusCode, Role PT1M No
Mongo Collection Created

Mongo Collection Created		 MongoCollectionCreate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Mongo Collection Deleted

Mongo Collection Deleted		 MongoCollectionDelete Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Mongo Collection Throughput Updated

Mongo Collection Throughput Updated		 MongoCollectionThroughputUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Mongo Collection Updated

Mongo Collection Updated		 MongoCollectionUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Mongo Database Deleted

Mongo Database Deleted		 MongoDatabaseDelete Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Mongo Database Throughput Updated

Mongo Database Throughput Updated		 MongoDatabaseThroughputUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Mongo Database Created

Mongo Database Created		 MongoDBDatabaseCreate Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Mongo Database Updated

Mongo Database Updated		 MongoDBDatabaseUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Mongo Request Charge

Mongo Request Units Consumed		 MongoRequestCharge Count Total (Sum), Average, Maximum DatabaseName, CollectionName, Region, CommandName, ErrorCode, Status PT1M No
Mongo Requests

Number of Mongo Requests Made		 MongoRequests Count Count DatabaseName, CollectionName, Region, CommandName, ErrorCode, Status PT1M No
Normalized RU Consumption

Max RU consumption percentage per minute		 NormalizedRUConsumption Percent Maximum, Average CollectionName, DatabaseName, Region, PartitionKeyRangeId, CollectionRid, PhysicalPartitionId, OfferOwnerRid PT1M, PT5M, PT1H, P1D No
Region Offlined

Region Offlined		 OfflineRegion Count Count Region, StatusCode, Role, OperationName PT1M No
Region Onlined

Region Onlined		 OnlineRegion Count Count Region, StatusCode, Role, OperationName PT1M No
Physical Partition Count

Physical Partition Count		 PhysicalPartitionCount Count Maximum CollectionName, DatabaseName, IsSharedThroughputOffer, OfferOwnerRid, Region PT5M No
Physical Partition Size

Physical Partition Size in bytes		 PhysicalPartitionSizeInfo Bytes Maximum, Average CollectionName, DatabaseName, PhysicalPartitionId, OfferOwnerRid, Region PT1M, PT5M, PT1H, P1D No
Physical Partition Throughput

Physical Partition Throughput		 PhysicalPartitionThroughputInfo Count Maximum CollectionName, DatabaseName, PhysicalPartitionId, OfferOwnerRid, Region PT5M, PT1H, P1D No
Provisioned Throughput

Provisioned Throughput		 ProvisionedThroughput Count Maximum DatabaseName, CollectionName, Region PT5M, PT1H, P1D No
Region Failed Over

Region Failed Over		 RegionFailover Count Count <none> PT5M No
Region Removed

Region Removed		 RemoveRegion Count Count Region PT5M No
P99 Replication Latency

P99 Replication Latency across source and target regions for geo-enabled account		 ReplicationLatency 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 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 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 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 Percent Minimum, Average, Maximum IsExternal PT1H No
Sql Container Created

Sql Container Created		 SqlContainerCreate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Sql Container Deleted

Sql Container Deleted		 SqlContainerDelete Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Sql Container Throughput Updated

Sql Container Throughput Updated		 SqlContainerThroughputUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Sql Container Updated

Sql Container Updated		 SqlContainerUpdate Count Count ResourceName, ChildResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Sql Database Created

Sql Database Created		 SqlDatabaseCreate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Sql Database Deleted

Sql Database Deleted		 SqlDatabaseDelete Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
Sql Database Throughput Updated

Sql Database Throughput Updated		 SqlDatabaseThroughputUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
Sql Database Updated

Sql Database Updated		 SqlDatabaseUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
AzureTable Table Created

AzureTable Table Created		 TableTableCreate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
AzureTable Table Deleted

AzureTable Table Deleted		 TableTableDelete Count Count ResourceName, ApiKind, ApiKindResourceType, OperationType PT5M No
AzureTable Table Throughput Updated

AzureTable Table Throughput Updated		 TableTableThroughputUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest PT5M No
AzureTable Table Updated

AzureTable Table Updated		 TableTableUpdate Count Count ResourceName, ApiKind, ApiKindResourceType, IsThroughputRequest, OperationType PT5M No
Total Requests

Number of requests made		 TotalRequests Count Count DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, CapacityType, PriorityLevel, ConnectionMode, IsExternal PT1M No
Total Requests (Preview)

Number of SQL requests		 TotalRequestsPreview Count Count DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, PriorityLevel, IsExternal PT1M No
Total Request Units

SQL Request Units consumed		 TotalRequestUnits 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 Count Total (Sum), Average, Maximum DatabaseName, CollectionName, Region, StatusCode, OperationType, Status, CapacityType, PriorityLevel PT1M No
Account Keys Updated

Account Keys Updated		 UpdateAccountKeys Count Count KeyType PT5M No
Account Network Settings Updated

Account Network Settings Updated		 UpdateAccountNetworkSettings Count Count <none> PT5M No
Account Replication Settings Updated

Account Replication Settings Updated		 UpdateAccountReplicationSettings Count Count <none> PT5M No
Account Diagnostic Settings Updated

Account Diagnostic Settings Updated		 UpdateDiagnosticsSettings Count Count DiagnosticSettingsName, ResourceGroupName PT5M No

Supported metrics for Microsoft.DocumentDB/cassandraClusters

The following table lists the metrics available for the Microsoft.DocumentDB/cassandraClusters resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.

Category: Cassandra Cache

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
cache capacity

Cache capacity (bytes).		 cassandra_cache_capacity Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, cache_name PT1M No
cache entries

Total number of cache entries.		 cassandra_cache_entries Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, cache_name PT1M No
cache hit rate

All time cache hit rate.		 cassandra_cache_hit_rate Percent Average cassandra_datacenter, cassandra_node, cache_name PT1M No
cache hits

Number of cache hits.		 cassandra_cache_hits Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, cache_name PT1M No
cache miss latency average (microseconds)

Average cache miss latency (microseconds).		 cassandra_cache_miss_latency_histogram Count Average cassandra_datacenter, cassandra_node, quantile PT1M No
cache miss latency p99 (microseconds)

p99 latency of misses.		 cassandra_cache_miss_latency_p99 Count Average cassandra_datacenter, cassandra_node, cache_name PT1M No
cache requests

Number of cache requests.		 cassandra_cache_requests Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, cache_name PT1M No
occupied cache size

Size of occupied cache (bytes).		 cassandra_cache_size Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, cache_name PT1M No

Category: Cassandra Client

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
auth failure (deprecated)

Number of failed client authentication requests.		 cassandra_client_auth_failure Count Total (Sum) cassandra_datacenter, cassandra_node PT1M No
auth failure (deprecated)

Number of failed client authentication requests.		 cassandra_client_auth_failure2 Count Total (Sum) cassandra_datacenter, cassandra_node PT1M No
client auth failure

Number of failed client authentication requests.		 cassandra_client_auth_failure3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
client auth success

Number of successful client authentication requests.		 cassandra_client_auth_success Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
connected native clients

Number of connected native clients.		 cassandra_client_connected_native_clients Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No

Category: Cassandra Client Request

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
condition not met

Cumulative number of transaction preconditions did not match current values.		 cassandra_client_request_condition_not_met Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, request_type PT1M No
contention average

How many contended reads/writes were encountered in average.		 cassandra_client_request_contention_histogram Count Average cassandra_datacenter, cassandra_node, request_type PT1M No
contention p99

p99 how many contended writes were encountered.		 cassandra_client_request_contention_histogram_p99 Count Average cassandra_datacenter, cassandra_node, request_type PT1M No
failures (deprecated)

Number of transaction failures encountered.		 cassandra_client_request_failures Count Total (Sum) cassandra_datacenter, cassandra_node, request_type PT1M No
failures (deprecated)

Number of transaction failures encountered.		 cassandra_client_request_failures2 Count Total (Sum) cassandra_datacenter, cassandra_node, request_type PT1M No
client failures

Cumulative number of transaction failures encountered.		 cassandra_client_request_failures3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, request_type PT1M No
client request latency average (microseconds)

Average client request latency (microseconds).		 cassandra_client_request_latency_histogram Count Average cassandra_datacenter, cassandra_node, quantile, request_type PT1M No
client request latency max (microseconds)

Maximum client request latency (microseconds).		 cassandra_client_request_latency_max Count Maximum ClusterResourceName, DataCenterResourceName, Address, request_type PT1M No
client request latency p99 (microseconds)

p99 client request latency (microseconds).		 cassandra_client_request_latency_p99 Count Average cassandra_datacenter, cassandra_node, request_type PT1M No
timeouts (deprecated)

Number of timeouts encountered.		 cassandra_client_request_timeouts Count Total (Sum) cassandra_datacenter, cassandra_node, request_type PT1M No
timeouts (deprecated)

Number of timeouts encountered.		 cassandra_client_request_timeouts2 Count Total (Sum) cassandra_datacenter, cassandra_node, request_type PT1M No
client timeouts

Cumulative number of timeouts encountered in client requests.		 cassandra_client_request_timeouts3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, request_type PT1M No
unfinished commit

Cumulative number of transactions that were committed on write.		 cassandra_client_request_unfinished_commit Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, request_type PT1M No

Category: Cassandra CommitLog

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Commit latency on waiting average (microseconds).

Average time spent waiting on CL fsync (microseconds); for Periodic this is only occurs when the sync is lagging its sync interval.		 cassandra_commit_log_waiting_on_commit_latency_histogram Count Average cassandra_datacenter, cassandra_node, quantile PT1M No

Category: Cassandra CQL

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
prepared statements executed

Total number of prepared statements executed.		 cassandra_cql_prepared_statements_executed Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
regular statements executed

Total number of non prepared statements executed.		 cassandra_cql_regular_statements_executed Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No

Category: Cassandra DroppedMessage

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
dropped messages count

Total count of dropped messages.		 cassandra_dropped_message_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, message_type PT1M No
cross-node dropped latency

Average dropped latency across nodes.		 cassandra_dropped_message_cross_node_latency MilliSeconds Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, message_type PT1M No
cross-node dropped latency p99

99th percentile of dropped latency across nodes.		 cassandra_dropped_message_cross_node_latency_p99 MilliSeconds Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, message_type PT1M No
internal dropped latency

Average dropped latency within node.		 cassandra_dropped_message_internal_latency MilliSeconds Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, message_type PT1M No
dropped messages rate

Rate of dropped messages.		 cassandra_dropped_message_rate Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, message_type PT1M No

Category: Cassandra HintsService

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
hints failed rate

Rate of the hints that failed deliver.		 cassandra_hints_failed_rate Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
hints succeeded rate

Rate of the hints successfully delivered.		 cassandra_hints_succeeded_rate Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
hints timed out rate

Rate of the hints that timed out.		 cassandra_hints_timed_out_rate Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No

Category: Cassandra JVM

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
jvm gc count

Total number of collections that have occurred.		 cassandra_jvm_gc_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
jvm gc time

Approximate accumulated collection elapsed time.		 cassandra_jvm_gc_time MilliSeconds Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No

Category: Cassandra Storage

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
total hints

Cumulative number of total hints in storage.		 cassandra_storage_total_hints_counter_total Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No
total hints in progress

Number of total hints in progress.		 cassandra_storage_total_hints_in_progress_counter_total Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node PT1M No

Category: Cassandra Table

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
all memtables live data size

Total amount of live data stored in the memtables (2i and pending flush memtables included) that resides off-heap, excluding any data structure overhead.		 cassandra_table_all_memtables_live_data_size Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
all memtables off heap size

Total amount of data stored in the memtables (2i and pending flush memtables included) that resides off-heap.		 cassandra_table_all_memtables_off_heap_size Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
bloom filter disk space used

Disk space used by bloom filter (bytes).		 cassandra_table_bloom_filter_disk_space_used Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
bloom filter false positives

Number of false positives on table's bloom filter.		 cassandra_table_bloom_filter_false_positives Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
bloom filter false ratio

False positive ratio of table's bloom filter.		 cassandra_table_bloom_filter_false_ratio Percent Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
bloom filter off-heap memory used

Off-heap memory used by bloom filter.		 cassandra_table_bloom_filter_off_heap_memory_used Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
bytes flushed

Total number of bytes flushed since server [re]start.		 cassandra_table_bytes_flushed Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas commit average (microseconds)

Average latency of paxos commit round.		 cassandra_table_cas_commit Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas commit p99 (microseconds)

p99 latency of paxos commit round.		 cassandra_table_cas_commit_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas prepare average (microseconds)

Average latency of paxos prepare round.		 cassandra_table_cas_prepare Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas prepare p99 (microseconds)

p99 latency of paxos prepare round.		 cassandra_table_cas_prepare_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas propose average (microseconds)

Average latency of paxos propose round.		 cassandra_table_cas_propose Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
cas propose p99 (microseconds)

p99 latency of paxos propose round.		 cassandra_table_cas_propose_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
col update time delta average

Average column update time delta on this table.		 cassandra_table_col_update_time_delta_histogram Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
col update time delta p99

p99 column update time delta on this table.		 cassandra_table_col_update_time_delta_histogram_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
compaction bytes written

Total number of bytes written by compaction since server [re]start.		 cassandra_table_compaction_bytes_written Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
compression metadata off-heap memory used

Off-heap memory used by compression metadata.		 cassandra_table_compression_metadata_off_heap_memory_used Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
compression ratio

Current compression ratio for all SSTables.		 cassandra_table_compression_ratio Percent Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
coordinator read latency average (microseconds)

Average coordinator read latency for this table.		 cassandra_table_coordinator_read_latency Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
coordinator read latency p99 (microseconds)

p99 coordinator read latency for this table.		 cassandra_table_coordinator_read_latency_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
coordinator scan latency average (microseconds)

Average coordinator range scan latency for this table.		 cassandra_table_coordinator_scan_latency Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
coordinator scan latency p99 (microseconds)

p99 coordinator range scan latency for this table.		 cassandra_table_coordinator_scan_latency_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
dropped mutations (deprecated)

Number of dropped mutations on this table.		 cassandra_table_dropped_mutations Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
dropped mutations (deprecated)

Number of dropped mutations on this table.		 cassandra_table_dropped_mutations2 Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
dropped mutations

Total number of dropped mutations on this table.		 cassandra_table_dropped_mutations3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
estimated column count average

Estimated number of columns in average.		 cassandra_table_estimated_column_count_histogram Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
estimated column count p99

p99 estimated number of columns.		 cassandra_table_estimated_column_count_histogram_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
estimated partition count

Approximate number of keys in table.		 cassandra_table_estimated_partition_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
estimated partition size average

Estimated partition size in average.		 cassandra_table_estimated_partition_size_histogram Bytes Average cassandra_datacenter, cassandra_node, quantile, table, keyspace PT1M No
estimated partition size p99

p99 estimated partition size (bytes).		 cassandra_table_estimated_partition_size_histogram_p99 Bytes Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
index summary off-heap memory used

Off-heap memory used by index summary.		 cassandra_table_index_summary_off_heap_memory_used Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
key cache hit rate

Key cache hit rate for this table.		 cassandra_table_key_cache_hit_rate Percent Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
live disk space used

Disk space used by SSTables belonging to this table (bytes).		 cassandra_table_live_disk_space_used Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
live scanned average

Average live cells scanned in queries on this table.		 cassandra_table_live_scanned_histogram Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
live scanned p99

p99 live cells scanned in queries on this table.		 cassandra_table_live_scanned_histogram_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
live sstable count

Number of SSTables on disk for this table.		 cassandra_table_live_sstable_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
max partition size

Size of the largest compacted partition (bytes).		 cassandra_table_max_partition_size Bytes Maximum cassandra_datacenter, cassandra_node, table, keyspace PT1M No
mean partition size

Size of the average compacted partition (bytes).		 cassandra_table_mean_partition_size Bytes Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
memtable columns count

Total number of columns present in the memtable.		 cassandra_table_memtable_columns_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
memtable off heap size

Total amount of data stored in the memtable that resides off-heap, including column related overhead and partitions overwritten.		 cassandra_table_memtable_off_heap_size Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
memtable on heap size

Total amount of data stored in the memtable that resides on-heap, including column related overhead and partitions overwritten.		 cassandra_table_memtable_on_heap_size Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
memtable switch count

Number of times flush has resulted in the memtable being switched out.		 cassandra_table_memtable_switch_count Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
min partition size

Size of the smallest compacted partition (bytes).		 cassandra_table_min_partition_size Bytes Minimum cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending compactions (deprecated)

Estimate of number of pending compactions for this table.		 cassandra_table_pending_compactions Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending compactions (deprecated)

Estimate of number of pending compactions for this table.		 cassandra_table_pending_compactions2 Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending compactions

Estimate of number of pending compactions for this table.		 cassandra_table_pending_compactions3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending flushes (deprecated)

Estimated number of flush tasks pending for this table.		 cassandra_table_pending_flushes Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending flushes (deprecated)

Estimated number of flush tasks pending for this table.		 cassandra_table_pending_flushes2 Count Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M No
pending flushes

Estimated number of flush tasks pending for this table.		 cassandra_table_pending_flushes3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
percent repaired

Percent of table data that is repaired on disk.		 cassandra_table_percent_repaired Percent Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
range latency average (microseconds)

Average local range scan latency for this table.		 cassandra_table_range_latency Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
range latency p99 (microseconds)

p99 local range scan latency for this table.		 cassandra_table_range_latency_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
read latency average (microseconds)

Average local read latency for this table.		 cassandra_table_read_latency Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
read latency p99 (microseconds)

p99 local read latency for this table.		 cassandra_table_read_latency_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
row cache hit

Number of table row cache hits.		 cassandra_table_row_cache_hit Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
row cache hit out of range

Number of table row cache hits that do not satisfy the query filter, thus went to disk.		 cassandra_table_row_cache_hit_out_of_range Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
row cache miss

Number of table row cache misses.		 cassandra_table_row_cache_miss Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
speculative retries

Number of times speculative retries were sent for this table.		 cassandra_table_speculative_retries Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
sstables per read average

Average number of sstable data files accessed per single partition read. SSTables skipped due to Bloom Filters, min-max key or partition index lookup are not taken into account.		 cassandra_table_sstables_per_read_histogram Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
sstables per read p99

p99 number of sstable data files accessed per single partition read. SSTables skipped due to Bloom Filters, min-max key or partition index lookup are not taken into account.		 cassandra_table_sstables_per_read_histogram_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
tombstone scanned average

Average tombstones scanned in queries on this table.		 cassandra_table_tombstone_scanned_histogram Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
tombstone scanned p99

p99 tombstones scanned in queries on this table.		 cassandra_table_tombstone_scanned_histogram_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
total disk space used (deprecated)

Total disk space used by SSTables belonging to this table, including obsolete ones waiting to be GC'd.		 cassandra_table_total_disk_space_used Bytes Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D No
total disk space used (deprecated)

Total disk space used by SSTables belonging to this table, including obsolete ones waiting to be GC'd.		 cassandra_table_total_disk_space_used2 Bytes Total (Sum) cassandra_datacenter, cassandra_node, table, keyspace PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D No
total disk space used

Total disk space used by SSTables belonging to this table, including obsolete ones waiting to be GC'd.		 cassandra_table_total_disk_space_used3 Bytes Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, table, keyspace PT1M No
view lock acquire time average

Average time taken acquiring a partition lock for materialized view updates on this table.		 cassandra_table_view_lock_acquire_time Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
view lock acquire time p99

p99 time taken acquiring a partition lock for materialized view updates on this table.		 cassandra_table_view_lock_acquire_time_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
view read time average

Average time taken during the local read of a materialized view update.		 cassandra_table_view_read_time Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
view read time p99

p99 time taken during the local read of a materialized view update.		 cassandra_table_view_read_time_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
waiting on free memtable space average

Average time spent waiting for free memtable space, either on- or off-heap.		 cassandra_table_waiting_on_free_memtable_space Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
waiting on free memtable space p99

p99 time spent waiting for free memtable space, either on- or off-heap.		 cassandra_table_waiting_on_free_memtable_space_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
write latency average (microseconds)

Average local write latency for this table.		 cassandra_table_write_latency Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No
write latency p99 (microseconds)

p99 local write latency for this table.		 cassandra_table_write_latency_p99 Count Average cassandra_datacenter, cassandra_node, table, keyspace PT1M No

Category: Cassandra ThreadPool

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
active tasks

Number of tasks being actively worked on by this pool.		 cassandra_thread_pools_active_tasks Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
currently blocked tasks (deprecated)

Number of tasks that are currently blocked due to queue saturation but on retry will become unblocked.		 cassandra_thread_pools_currently_blocked_tasks Count Total (Sum) cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
currently blocked tasks (deprecated)

Number of tasks that are currently blocked due to queue saturation but on retry will become unblocked.		 cassandra_thread_pools_currently_blocked_tasks2 Count Total (Sum) cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
currently blocked tasks

Number of tasks that are currently blocked due to queue saturation but on retry will become unblocked.		 cassandra_thread_pools_currently_blocked_tasks3 Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
max pool size

Maximum number of threads in this pool.		 cassandra_thread_pools_max_pool_size Count Maximum cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
pending tasks

Number of queued tasks queued up on this pool.		 cassandra_thread_pools_pending_tasks Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No
total blocked tasks

Total number of tasks that were blocked due to queue saturation.		 cassandra_thread_pools_total_blocked_tasks Count Average, Minimum, Maximum, Count cassandra_datacenter, cassandra_node, pool_name, pool_type PT1M No

Category: System

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
CPU usage active

CPU usage (active).		 cpu Percent Average ClusterResourceName, DataCenterResourceName, Address, Kind, CPU PT1M Yes
disk utilization

Disk utilization rate.		 disk_utilization Percent Average ClusterResourceName, DataCenterResourceName, Address PT1M Yes
disk I/O merged reads

Cumulative disk I/O merged reads.		 diskio_merged_reads Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O merged writes

Cumulative disk I/O merged writes.		 diskio_merged_writes Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O read bytes

Cumulative disk I/O read bytes.		 diskio_read_bytes Bytes Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O read time (milliseconds)

Cumulative disk I/O read time (milliseconds).		 diskio_read_time MilliSeconds Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O read counts

Cumulative disk I/O read counts.		 diskio_reads Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O write bytes

Cumulative disk I/O write bytes.		 diskio_write_bytes Bytes Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O write time (milliseconds)

Cumulative disk I/O write time (milliseconds).		 diskio_write_time MilliSeconds Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
disk I/O write counts

Cumulative disk I/O write counts.		 diskio_writes Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
network received bytes

Cumulative network received bytes.		 ethtool_rx_bytes Bytes Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
network received packets

Cumulative network received packets.		 ethtool_rx_packets Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
network transmitted bytes

Cumulative network transmitted bytes.		 ethtool_tx_bytes Bytes Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
network transmitted packets

Cumulative network transmitted packets.		 ethtool_tx_packets Count Average, Minimum, Maximum, Count ClusterResourceName, DataCenterResourceName, Address, Kind PT1M No
IOPS (including throughput)

I/O operations and bytes per second.		 iops Count Average ClusterResourceName, DataCenterResourceName, Address, Kind PT1M Yes
memory utilization

Memory utilization rate.		 percent_mem Percent Average ClusterResourceName, DataCenterResourceName, Address PT1M Yes
RAID array degraded

Whether RAID array is degraded. 1 means degraded, 0 means not degraded.		 raid_array_degraded Count Average, Maximum, Minimum DataCenterResourceName, Address, RaidArrayName, RaidArrayType PT1M No
RAID array rebuild

Percentage of RAID array rebuild.		 raid_array_rebuild Percent Average, Minimum, Maximum DataCenterResourceName, Address, RaidArrayName, RaidArrayType PT1M No
average CPU usage active

Average CPU usage (active) across all the CPUs.		 total_cpu Percent Average ClusterResourceName, DataCenterResourceName, Address, Kind PT1M Yes

Supported metrics for Microsoft.DocumentDB/mongoClusters

The following table lists the metrics available for the Microsoft.DocumentDB/mongoClusters resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.

Category: Latency

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Mongo request duration

The end-to-end duration in milliseconds of client Mongo DB requests handled by the Mongo cluster. Updated every 60 seconds.		 MongoRequestDurationMs Milliseconds Average, Count, Maximum, Minimum, Total (Sum) Authentication, CollectionName, DatabaseName, ErrorCode, Operation, Protocol, ServerName, StatusCode, StatusCodeClass, StatusText PT1M Yes

Category: Saturation

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Autoscale Utilization percent

Percent Autoscale utilization		 AutoscaleUtilizationPercent Percent Average, Maximum, Minimum <none> PT1M No
Committed Memory percent

Percentage of Commit Memory Limit allocated by applications on node		 CommittedMemoryPercent Percent Average, Maximum, Minimum ServerName PT1M No
CPU percent

Percent CPU utilization on node		 CpuPercent Percent Average, Maximum, Minimum ServerName PT1M No
Memory percent

Percent memory utilization on node		 MemoryPercent Percent Average, Maximum, Minimum ServerName PT1M No
Storage percent

Percent of available storage used on node		 StoragePercent Percent Average, Maximum, Minimum ServerName PT1M No
Storage used

Quantity of available storage used on node		 StorageUsed Bytes Average, Maximum, Minimum ServerName PT1M No

Category: Traffic

Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
IOPS

Disk IO operations per second on node		 IOPS Count Average, Maximum, Minimum ServerName PT1M Yes

Metrics by category

The following tables list Azure Cosmos DB metrics categorized by metric type.

Request metrics

  • TotalRequests (Total Requests)
  • MetadataRequests (Metadata Requests)
  • MongoRequests (Mongo Requests)

Request Unit metrics

  • MongoRequestCharge (Mongo Request Charge)
  • TotalRequestUnits (Total Request Units)
  • ProvisionedThroughput (Provisioned Throughput)
  • AutoscaleMaxThroughput (Autoscale Max Throughput)
  • PhysicalPartitionThroughputInfo (Physical Partition Throughput Info)

Storage metrics

  • AvailableStorage (Available Storage)
  • DataUsage (Data Usage)
  • IndexUsage (Index Usage)
  • DocumentQuota (Document Quota)
  • DocumentCount (Document Count)
  • PhysicalPartitionSizeInfo (Physical Partition Size Info)

Latency metrics

  • ReplicationLatency (Replication Latency)
  • Server Side Latency

Availability metrics

  • ServiceAvailability (Service Availability)

API for Cassandra metrics

  • CassandraRequests (Cassandra Requests)
  • CassandraRequestCharges (Cassandra Request Charges)
  • CassandraConnectionClosures (Cassandra Connection Closures)

Error codes for Cassandra

The following table lists error codes for your API for Cassandra account. For sample queries, see Server diagnostics for Azure Cosmos DB for Apache Cassandra

Status code Error code Description
200 -1 Successful
400 8704 The query is correct but an invalid syntax.
400 8192 The submitted query has a syntax error. Review your query.
400 8960 The query is invalid because of some configuration issue.
401 8448 The logged user does not have the right permissions to perform the query.
403 8448 Forbidden response as the user may not have the necessary permissions to carry out the request.
404 5376 A non-timeout exception during a write request as a result of response not found.
405 0 Server-side Cassandra error. The error rarely occurs, open a support ticket.
408 4608 Timeout during a read request.
408 4352 Timeout exception during a write serviceRequest.
409 9216 Attempting to create a keyspace or table that already exist.
412 5376 Precondition failure. To ensure data integrity, we ensure that the write request based on the read response is true. A non-timeout write request exception is returned.
413 5376 This non-timeout exception during a write request is because of payload maybe too large. Currently, there is a limit of 2MB per row.
417 9472 The exception is thrown when a prepared statement is not cached on the server node. It should be transient/non-blocking.
423 5376 There is a lock because a write request that is currently processing.
429 4097 Overload exception is as a result of RU shortage or high request rate. Probably need more RU to handle the higher volume request. In, native Cassandra this can be interpreted as one of the VMs not having enough CPU. We advise reviewing current data model to ensure that you do not have excessive skews that might be causing hot partitions.
449 5376 Concurrent execution exception. This occurs to ensure only one write update at a time for a given row.
500 0 Server cassandraError: something unexpected happened. This indicates a server-side bug.
503 4096 Service unavailable.
256 This may be because of invalid connection credentials. Please check your connection credentials.
10 A client message triggered protocol violation. An example is query message sent before a startup one has been sent.

Metric dimensions

For information about what metric dimensions are, see Multi-dimensional metrics.

This service has the following dimensions associated with its metrics.

Microsoft.DocumentDB/DatabaseAccounts

  • ApiKindResourceType
  • APIType
  • ApplicationType
  • BuildType
  • CacheEntryType
  • CacheExercised
  • CacheHit
  • CapacityType
  • ChildResourceName
  • ClosureReason
  • CommandName
  • ConnectionMode
  • DiagnosticSettingsName
  • Error
  • ErrorCode
  • IsExternal
  • IsSharedThroughputOffer
  • IsThroughputRequest
  • KeyType
  • MetricType
  • NotStarted
  • OfferOwnerRid
  • PartitionKeyRangeId
  • PhysicalPartitionId
  • PhysicalPartitionId
  • PriorityLevel
  • PublicAPIType
  • ReplicationInProgress
  • ResourceGroupName
  • ResourceName
  • Role
  • SourceRegion
  • TargetContainerName
  • TargetRegion

Microsoft.DocumentDB/cassandraClusters

  • cassandra_datacenter
  • cassandra_node
  • cache_name

Microsoft.DocumentDB/mongoClusters

  • ServerName

Resource logs

This section lists the types of resource logs you can collect for this service. The section pulls from the list of all resource logs category types supported in Azure Monitor.

Supported resource logs for Microsoft.DocumentDB/DatabaseAccounts

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
CassandraRequests CassandraRequests CDBCassandraRequests

This table details data plane operations, specifically for Cassandra API accounts.

 Yes Yes No
ControlPlaneRequests ControlPlaneRequests CDBControlPlaneRequests

This table details all control plane operations executed on the account, which include modifications to the regional failover policy, indexing policy, IAM role assignments, backup/restore policies, VNet and firewall rules, private links as well as updates and deletes of the account.

 Yes Yes No
DataPlaneRequests DataPlaneRequests CDBDataPlaneRequests

The DataPlaneRequests table captures every data plane operation for the Cosmos DB account. Data Plane requests are operations executed to create, update, delete or retrieve data within the account.

 Yes Yes No
GremlinRequests GremlinRequests CDBGremlinRequests

This table details data plane operations, specifically for Graph API accounts.

 Yes Yes No
MongoRequests MongoRequests CDBMongoRequests

This table details data plane operations, specifically for Mongo API accounts.

 Yes Yes No
PartitionKeyRUConsumption PartitionKeyRUConsumption CDBPartitionKeyRUConsumption

This table details the RU (Request Unit) consumption for logical partition keys in each region, within each of their physical partitions. This data can be used to identify hot partitions from a request volume perspective.

 Yes Yes No
PartitionKeyStatistics PartitionKeyStatistics CDBPartitionKeyStatistics

This table provides outlier logical partition keys that have consumed more storage space than others. Statistics are based on a sub-sampling of partition keys within the collection and hence these are approximate. Partition keys that are below 1GB of storage may not show up in the reported statistics.

 Yes Yes No
QueryRuntimeStatistics QueryRuntimeStatistics CDBQueryRuntimeStatistics

This table details query operations executed against a SQL API account. By default, the query text and its parameters are obfuscated to avoid logging PII data with full text query logging available by request.

 Yes Yes No
TableApiRequests TableApiRequests CDBTableApiRequests

This table details data plane operations, specifically for Table API accounts.

 Yes No Yes

Supported resource logs for Microsoft.DocumentDB/cassandraClusters

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
CassandraAudit CassandraAudit AzureDiagnostics

Logs from multiple Azure resources.

 No No Queries Yes
CassandraLogs CassandraLogs AzureDiagnostics

Logs from multiple Azure resources.

 No No Queries Yes

Supported resource logs for Microsoft.DocumentDB/mongoClusters

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
vCoreMongoRequests vCoreMongoRequests AzureDiagnostics

Logs from multiple Azure resources.

 No No Queries Yes

Azure Monitor Logs tables

This section lists the Azure Monitor Logs tables relevant to this service, which are available for query by Log Analytics using Kusto queries. The tables contain resource log data and possibly more depending on what is collected and routed to them.

Azure Cosmos DB

Microsoft.DocumentDb/databaseAccounts

Azure Managed Instance for Apache Cassandra

Microsoft.DocumentDB/cassandraClusters

Azure Cosmos DB for MongoDB (vCore)

Microsoft.DocumentDB/mongoClusters

Azure Cosmos DB resource logs properties

The following table lists properties of resource logs in Azure Cosmos DB. The resource logs are collected into Azure Monitor Logs or Azure Storage.

Azure Storage field or property Azure Monitor Logs property Description
time TimeGenerated The date and time (UTC) when the operation occurred.
resourceId Resource The Azure Cosmos DB account for which logs are enabled.
category Category For Azure Cosmos DB, DataPlaneRequests, MongoRequests, QueryRuntimeStatistics, PartitionKeyStatistics, PartitionKeyRUConsumption, ControlPlaneRequests, CassandraRequests, GremlinRequests are the available log types.
operationName OperationName Name of the operation. The operation name can be Create, Update, Read, ReadFeed, Delete, Replace, Execute, SqlQuery, Query, JSQuery, Head, HeadFeed, or Upsert.
properties n/a The contents of this field are described in the rows that follow.
activityId activityId_g The unique GUID for the logged operation.
userAgent userAgent_s A string that specifies the client user agent from which, the request was sent. The format of user agent is {user agent name}/{version}.
requestResourceType requestResourceType_s The type of the resource accessed. This value can be database, container, document, attachment, user, permission, stored procedure, trigger, user-defined function, or an offer.
statusCode statusCode_s The response status of the operation.
requestResourceId ResourceId The resourceId that pertains to the request. Depending on the operation performed, this value may point to databaseRid, collectionRid, or documentRid.
clientIpAddress clientIpAddress_s The client's IP address.
requestCharge requestCharge_s The number of RUs that are used by the operation
collectionRid collectionId_s The unique ID for the collection.
duration duration_d The duration of the operation, in milliseconds.
requestLength requestLength_s The length of the request, in bytes.
responseLength responseLength_s The length of the response, in bytes.
resourceTokenPermissionId resourceTokenPermissionId_s This property indicates the permission ID that you have specified for an alternative authentication method.
resourceTokenPermissionMode resourceTokenPermissionMode_s This property indicates the permission mode that you have set when creating the resource token. The permission mode can have values such as "all" or "read".
resourceTokenUserRid resourceTokenUserRid_s The value points to the resource ID of the user for alternate authentication methods.
responseLength responseLength_s The length of the response, in bytes.

Activity log

The linked table lists the operations that can be recorded in the activity log for this service. These operations are a subset of all the possible resource provider operations in the activity log.

For more information on the schema of activity log entries, see Activity Log schema.

Related content