Azure SignalR Service monitoring data reference

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

See Monitor Azure SignalR Service for details on the data you can collect for Azure SignalR Service 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.

Metrics for Azure SignalR Service are in the Errors, Saturation, or Traffic categories.

Supported metrics for Microsoft.SignalRService/SignalR

The following table lists the metrics available for the Microsoft.SignalRService/SignalR 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	Metric	Name in REST API	Unit	Aggregation	Dimensions	Time Grains	DS Export
Traffic	Connection Close Count The count of connections closed by various reasons.	ConnectionCloseCount	Count	Total (Sum)	Endpoint, ConnectionCloseCategory	PT1M	Yes
Traffic	Connection Count The amount of user connection.	ConnectionCount	Count	Maximum	Endpoint	PT1M	Yes
Traffic	Connection Open Count The count of new connections opened.	ConnectionOpenCount	Count	Total (Sum)	Endpoint	PT1M	Yes
Traffic	Connection Quota Utilization The percentage of connection connected relative to connection quota.	ConnectionQuotaUtilization	Percent	Minimum, Maximum, Average	<none>	PT1M	Yes
Traffic	Inbound Traffic The inbound traffic of service	InboundTraffic	Bytes	Total (Sum)	<none>	PT1M	Yes
Traffic	Message Count The total amount of messages.	MessageCount	Count	Total (Sum)	<none>	PT1M	Yes
Traffic	Outbound Traffic The outbound traffic of service	OutboundTraffic	Bytes	Total (Sum)	<none>	PT1M	Yes
Saturation	Server Load SignalR server load.	ServerLoad	Percent	Minimum, Maximum, Average	<none>	PT1M	No
Errors	System Errors The percentage of system errors	SystemErrors	Percent	Maximum	<none>	PT1M	Yes
Errors	User Errors The percentage of user errors	UserErrors	Percent	Maximum	<none>	PT1M	Yes

Supported metrics for Microsoft.SignalRService/SignalR/replicas

The following table lists the metrics available for the Microsoft.SignalRService/SignalR/replicas 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	Metric	Name in REST API	Unit	Aggregation	Dimensions	Time Grains	DS Export
Traffic	Connection Close Count The count of connections closed by various reasons.	ConnectionCloseCount	Count	Total (Sum)	Endpoint, ConnectionCloseCategory	PT1M	Yes
Traffic	Connection Count The amount of user connection.	ConnectionCount	Count	Maximum	Endpoint	PT1M	Yes
Traffic	Connection Open Count The count of new connections opened.	ConnectionOpenCount	Count	Total (Sum)	Endpoint	PT1M	Yes
Traffic	Connection Quota Utilization The percentage of connection connected relative to connection quota.	ConnectionQuotaUtilization	Percent	Minimum, Maximum, Average	<none>	PT1M	Yes
Traffic	Inbound Traffic The inbound traffic of service	InboundTraffic	Bytes	Total (Sum)	<none>	PT1M	Yes
Traffic	Message Count The total amount of messages.	MessageCount	Count	Total (Sum)	<none>	PT1M	Yes
Traffic	Outbound Traffic The outbound traffic of service	OutboundTraffic	Bytes	Total (Sum)	<none>	PT1M	Yes
Saturation	Server Load SignalR server load.	ServerLoad	Percent	Minimum, Maximum, Average	<none>	PT1M	No
Errors	System Errors The percentage of system errors	SystemErrors	Percent	Maximum	<none>	PT1M	Yes
Errors	User Errors The percentage of user errors	UserErrors	Percent	Maximum	<none>	PT1M	Yes

For more details about the metrics for Azure SignalR Service, see Azure SignalR Service metrics.

Note

The metrics aggregation types appear in metrics explorer in the Azure portal as Count, Avg, Min, Max, and Sum.

Count is the count of sampling data received. Count is defined as a general metrics aggregation type and can't be excluded from the list of available aggregation types. It's not generally useful for SignalR Service but can sometimes be used to check if the sampling data has been sent to metrics.

Metric dimensions

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

This service has the following dimensions associated with its metrics.

Endpoint

Describes the type of connection. Includes dimension values: Client, Server, and LiveTrace.

ConnectionCloseCategory

Gives the reason for closing the connection. Includes the following dimension values.

Value	Description
Normal	Connection closed normally.
Throttled	With Message count/rate or connection throttling, check Connection Count and Message Count current usage and your resource limits.
PingTimeout	Connection ping timeout.
NoAvailableServerConnection	Client connection can't be established and doesn't pass handshake because there's no available server connection.
InvokeUpstreamFailed	Upstream invoke failed.
SlowClient	Too many unsent messages queued up at service side.
HandshakeError	Connection terminated in the handshake phase, which could be caused by the remote party closing the WebSocket connection without completing the close handshake. HandshakeError is caused by a network issue. Check browser settings to see if the client is able to create a websocket connection.
ServerConnectionNotFound	Target hub server not available. This value is by design and reconnection should be done after this drop.
ServerConnectionClosed	Client connection closed because the corresponding server connection was dropped. When app server uses Azure SignalR Service SDK, in the background, it initiates server connections to the remote Azure SignalR Service. Each client connection to the service is associated with one of the server connections to route traffic between the client and app server. Once a server connection is closed, all the client connections it serves are closed with the ServerConnectionDropped message.
ServiceTransientError	Internal server error.
BadRequest	A bad request is caused by an invalid hub name, wrong payload, or a malformed request.
ClosedByAppServer	App server asked the service to close the client.
ServiceReload	Service reload is triggered when a connection is dropped due to an internal service component reload. This event doesn't indicate a malfunction and is part of normal service operation.
ServiceModeSwitched	Connection closed after service mode switched, such as from Serverless mode to Default mode.
Unauthorized	The connection is unauthorized.

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.SignalRService/SignalR

Category	Category display name	Log table	Supports basic log plan	Supports ingestion-time transformation	Example queries	Costs to export
AllLogs	Azure SignalR Service Logs.	SignalRServiceDiagnosticLogs Azure SignalR service diagnostic logs.	No	Yes	Queries	No

Supported resource logs for Microsoft.SignalRService/SignalR/replicas

Category	Category display name	Log table	Supports basic log plan	Supports ingestion-time transformation	Example queries	Costs to export
AllLogs	Azure SignalR Service Logs.		No	No		Yes

Resource Log table mapping

Field names for Log Analytics vary slightly from field names for Storage destinations.

Archive log schema for a storage account

Archive log JSON strings include the following elements:

Format

Name	Description
time	Log event time.
level	Log event level.
resourceId	Resource ID of the Azure SignalR Service.
location	Location of the Azure SignalR Service.
category	Category of the log event.
operationName	Operation name of the event.
callerIpAddress	IP address of the server/client.
properties	Detailed properties related to this log event, as listed in the following table.

Properties

Name	Description
type	Type of the log event. Currently, ConnectivityLogs type is available, to provide information about connectivity to the Azure SignalR Service.
collection	Collection of the log event. Allowed values are Connection, Authorization, or Throttling.
connectionId	Identity of the connection.
transportType	Transport type of the connection. Allowed values are Websockets, ServerSentEvents, or LongPolling.
connectionType	Type of the connection. Allowed values are Server or Client. Server is connection from server side and Client is connection from client side.
userId	Identity of the user.
message	Detailed message of log event.

Archive logs schema for Log Analytics

Archive log columns include the following elements:

Name	Description
TimeGenerated	Log event time.
Collection	Collection of the log event. Allowed values are: Connection, Authorization, and Throttling.
OperationName	Operation name of the event.
Location	Location of the Azure SignalR Service.
Level	Log event level.
CallerIpAddress	IP address of the server/client.
Message	Detailed message of log event.
UserId	Identity of the user.
ConnectionId	Identity of the connection.
ConnectionType	Type of the connection. Allowed values are: Server or Client. Server is connection from server side and Client is connection from client side.
TransportType	Transport type of the connection. Allowed values are: Websockets, ServerSentEvents, or LongPolling

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.

SignalR

Microsoft.SignalRService/SignalR

• AzureActivity
• AzureMetrics
• SignalRServiceDiagnosticLogs

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.

• Microsoft.SignalRService resource provider operations

Related content

• See Monitor Azure SignalR Service for a description of monitoring Azure SignalR Service.
• See Monitor Azure resources with Azure Monitor for details on monitoring Azure resources.
• See Use diagnostic logs to monitor SignalR Service for detailed instructions on how to enable, query, and troubleshoot with Azure SignalR Service logs.