Supported metrics for Microsoft.HDInsight/clusters

The following table lists the metrics available for the Microsoft.HDInsight/clusters 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.
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- 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.

Category Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Availability Categorized Gateway Requests

Number of gateway requests by categories (1xx/2xx/3xx/4xx/5xx)
CategorizedGatewayRequests Count Count, Total (Sum) HttpStatus PT1M, PT1H, P1D Yes
Availability Gateway Requests

Number of gateway requests
GatewayRequests Count Count, Total (Sum) HttpStatus PT1M, PT1H, P1D Yes
Availability REST proxy Consumer RequestThroughput

Number of consumer requests to Kafka REST proxy
KafkaRestProxy.ConsumerRequest.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Consumer Unsuccessful Requests

Consumer request exceptions
KafkaRestProxy.ConsumerRequestFail.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Consumer RequestLatency

Message latency in a consumer request through Kafka REST proxy
KafkaRestProxy.ConsumerRequestTime.p95 Milliseconds Average Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Consumer Request Backlog

Consumer REST proxy queue length
KafkaRestProxy.ConsumerRequestWaitingInQueueTime.p95 Milliseconds Average Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Producer MessageThroughput

Number of producer messages through Kafka REST proxy
KafkaRestProxy.MessagesIn.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Consumer MessageThroughput

Number of consumer messages through Kafka REST proxy
KafkaRestProxy.MessagesOut.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy ConcurrentConnections

Number of concurrent connections through Kafka REST proxy
KafkaRestProxy.OpenConnections Count Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Producer RequestThroughput

Number of producer requests to Kafka REST proxy
KafkaRestProxy.ProducerRequest.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Producer Unsuccessful Requests

Producer request exceptions
KafkaRestProxy.ProducerRequestFail.m1_delta CountPerSecond Total (Sum) Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Producer RequestLatency

Message latency in a producer request through Kafka REST proxy
KafkaRestProxy.ProducerRequestTime.p95 Milliseconds Average Machine, Topic PT1M, PT1H, P1D Yes
Availability REST proxy Producer Request Backlog

Producer REST proxy queue length
KafkaRestProxy.ProducerRequestWaitingInQueueTime.p95 Milliseconds Average Machine, Topic PT1M, PT1H, P1D Yes
Availability Number of Active Workers

Number of Active Workers
NumActiveWorkers Count Average, Maximum, Minimum MetricName PT1M, PT1H, P1D Yes
Availability Pending CPU

Pending CPU Requests in YARN
PendingCPU Count Average, Maximum, Minimum <none> PT1M, PT1H, P1D Yes
Availability Pending Memory

Pending Memory Requests in YARN
PendingMemory Count Average, Maximum, Minimum <none> PT1M, PT1H, P1D Yes

Next steps