Supported metrics for Microsoft.Relay/clusters

The following table lists the metrics available for the Microsoft.Relay/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.
  • 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 - Shows whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.

For information on exporting metrics, see - Create diagnostic settings in Azure Monitor.

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

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

Total ActiveConnections across the Relay Cluster.
ActiveConnections No Count Maximum, Minimum, Average <none> PT1M No
ActiveListeners

Total ActiveListeners across the Relay Cluster.
ActiveListeners No Count Maximum, Minimum, Average <none> PT1M No
AvailableMemory

Available memory for the Relay Cluster as a percentage of total memory.
AvailableMemory No Percent Maximum Role PT1M No
BytesTransferred

Total BytesTransferred across the Relay Cluster.
BytesTransferred No Bytes Total (Sum) <none> PT1M Yes
CPU

CPU utilization for the Relay Cluster as a percentage
CPU No Percent Maximum Role, Instance PT1M No
ListenerConnections-ClientError

ClientError on ListenerConnections across the Relay Cluster.
ListenerConnections-ClientError No Count Total (Sum) OperationResult PT1M No
ListenerConnections-ServerError

ServerError on ListenerConnections across the Relay Cluster.
ListenerConnections-ServerError No Count Total (Sum) OperationResult PT1M No
ListenerConnections-Success

Successful ListenerConnections across the Relay Cluster.
ListenerConnections-Success No Count Total (Sum) OperationResult PT1M No
ListenerConnections-TotalRequests

Total ListenerConnections across the Relay Cluster.
ListenerConnections-TotalRequests No Count Total (Sum) <none> PT1M No
ListenerDisconnects

Total ListenerDisconnects across the Relay Cluster.
ListenerDisconnects No Count Total (Sum) <none> PT1M No
SenderConnections-ClientError

ClientError on SenderConnections across the Relay Cluster.
SenderConnections-ClientError No Count Total (Sum) OperationResult PT1M No
SenderConnections-ServerError

ServerError on SenderConnections across the Relay Cluster.
SenderConnections-ServerError No Count Total (Sum) OperationResult PT1M No
SenderConnections-Success

Successful SenderConnections across the Relay Cluster.
SenderConnections-Success No Count Total (Sum) OperationResult PT1M No
SenderConnections-TotalRequests

Total SenderConnections requests across the Relay Cluster.
SenderConnections-TotalRequests No Count Total (Sum) <none> PT1M No
SenderDisconnects

Total SenderDisconnects across the Relay Cluster.
SenderDisconnects No Count Total (Sum) <none> PT1M No

Next steps