Edit

Supported metrics for Microsoft.DocumentDB/mongoClusters

The following table lists the metrics available for the Microsoft.DocumentDB/mongoClusters 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, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every 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/mongoClusters

Category: Latency

Metric Name in REST API Advanced platform metrics 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 No 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 Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
Autoscale Utilization percent

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

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

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

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

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

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

Category: Traffic

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

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

Network bytes sent on node
NetworkBytesEgress No Bytes Average, Maximum, Minimum, Total (Sum) ServerName PT1M Yes
Network bytes ingress

Network bytes received on node
NetworkBytesIngress No Bytes Average, Maximum, Minimum, Total (Sum) ServerName PT1M Yes

Next steps