Azure Relay metrics in Azure Monitor
Azure Relay metrics give you the state of resources in your Azure subscription. With a rich set of metrics data, you can assess the overall health of your Relay resources, not only at the namespace level, but also at the entity level. These statistics can be important as they help you to monitor the state of Azure Relay. Metrics can also help troubleshoot root-cause issues without needing to contact Azure support.
Azure Monitor provides unified user interfaces for monitoring across various Azure services. For more information, see Monitoring in Microsoft Azure and the Retrieve Azure Monitor metrics with .NET sample on GitHub.
Important
This article applies only to the Hybrid Connections feature of Azure Relay, not to the WCF Relay.
Access metrics
Azure Monitor provides multiple ways to access metrics. You can either access metrics through the Azure portal, or use the Azure Monitor APIs (REST and .NET) and analysis solutions such as Operation Management Suite and Event Hubs. For more information, see Monitoring data collected by Azure Monitor.
Metrics are enabled by default, and you can access the most recent 30 days of data. If you need to retain data for a longer period of time, you can archive metrics data to an Azure Storage account. It's configured in diagnostic settings in Azure Monitor.
Access metrics in the portal
You can monitor metrics over time in the Azure portal. The following example shows how to view successful requests and incoming requests at the account level:
You can also access metrics directly via the namespace. To do so, select your namespace and then select Metrics.
For metrics supporting dimensions, you must filter with the desired dimension value.
Billing
Using metrics in Azure Monitor is currently free while in preview. However, if you use additional solutions that ingest metrics data, you may be billed by these solutions. For example, you're billed by Azure Storage if you archive metrics data to an Azure Storage account. You're also billed by Azure Monitor logs if you stream metrics data to Azure Monitor logs for advanced analysis.
The following metrics give you an overview of the health of your service.
Note
We are deprecating several metrics as they are moved under a different name. This might require you to update your references. Metrics marked with the "deprecated" keyword will not be supported going forward.
All metrics values are sent to Azure Monitor every minute. The time granularity defines the time interval for which metrics values are presented. The supported time interval for all Azure Relay metrics is 1 minute.
Connection metrics
Metric Name | Description |
---|---|
ListenerConnections-Success | The number of successful listener connections made to Azure Relay over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
ListenerConnections-ClientError | The number of client errors on listener connections over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
ListenerConnections-ServerError | The number of server errors on the listener connections over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
SenderConnections-Success | The number of successful sender connections made over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
SenderConnections-ClientError | The number of client errors on sender connections over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
SenderConnections-ServerError | The number of server errors on sender connections over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
ListenerConnections-TotalRequests | The total number of listener connections over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
SenderConnections-TotalRequests | The connection requests made by the senders over a specified period. Unit: Count Aggregation Type: Total Dimension: EntityName |
ActiveConnections | The number of active connections. This value is a point-in-time value. Unit: Count Aggregation Type: Total Dimension: EntityName |
ActiveListeners | The number of active listeners. This value is a point-in-time value. Unit: Count Aggregation Type: Total Dimension: EntityName |
ListenerDisconnects | The number of disconnected listeners over a specified period. Unit: Bytes Aggregation Type: Total Dimension: EntityName |
SenderDisconnects | The number of disconnected senders over a specified period. Unit: Bytes Aggregation Type: Total Dimension: EntityName |
Memory usage metrics
Metric Name | Description |
---|---|
BytesTransferred | The number of bytes transferred over a specified period. Unit: Bytes Aggregation Type: Total Dimension: EntityName |
Metrics dimensions
Azure Relay supports the following dimensions for metrics in Azure Monitor. Adding dimensions to your metrics is optional. If you don't add dimensions, metrics are specified at the namespace level.
Dimension name | Description |
---|---|
EntityName | Azure Relay supports messaging entities under the namespace. |
Next steps
See the Azure Monitoring overview.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for