Use the live trace tool for Azure SignalR Service

  • Article

The live trace tool is a single web application for capturing and displaying live traces in Azure SignalR Service. The live traces can be collected in real time without any dependency on other services.

You can enable and disable the live trace feature with a single selection. You can also choose any log category that you're interested in.

Note

Live traces are counted as outbound messages.

Using Microsoft Entra ID to access the live trace tool is not supported.

Open the live trace tool

When you enable an access key, you use an access token to authenticate the live trace tool. Otherwise, you use Microsoft Entra ID to authenticate the tool.

You can check whether you enabled an access key by going to the Keys page for Azure SignalR Service in the Azure portal.

Steps if you enabled an access key

  1. Go to the Azure portal and your Azure SignalR Service page.
  2. On the left menu, under Monitoring, select Live trace settings.
  3. Select Enable Live Trace.
  4. Select the Save button, and then wait for the changes to take effect.
  5. Select Open Live Trace Tool.

Screenshot of selections for opening the live trace tool.

Steps if you didn't enable an access key

Assign live trace tool API permission to yourself

  1. Go to the Azure portal and your Azure SignalR Service page.
  2. Select Access control (IAM).
  3. On the new page, select +Add, and then select Role assignment.
  4. On the new page, select the Job function roles tab, select the SignalR Service Owner role, and then select Next.
  5. On the Members page, click +Select members.
  6. On the new panel, search for and select members, and then click Select.
  7. Select Review + assign, and wait for the completion notification.

Open the tool

  1. Go to the Azure portal and your Azure SignalR Service page.
  2. On the left menu, under Monitoring, select Live trace settings.
  3. Select Enable Live Trace.
  4. Select the Save button, and then wait for the changes to take effect.
  5. Select Open Live Trace Tool.

Screenshot of opening the tool for live tracing.

Capture live traces

In the live trace tool, you can:

  • Begin to capture real-time live traces from the Azure SignalR Service instance.
  • Clear the captured real-time live traces.
  • Export live traces to a file. The currently supported file format is CSV.
  • Filter the captured real-time live traces with one specific keyword. Separators (for example, space, comma, or semicolon), if present, are treated as part of the keyword.

Screenshot of capturing live traces with the live trace tool.

The real-time live traces that the tool captures contain detailed information for troubleshooting.

Name Description
Time Log event time.
Log Level Log event level: Trace, Debug, Informational, Warning, or Error.
Event Name Operation name of the log event.
Message Detailed message of the log event.
Exception Runtime exception of the Azure Web PubSub service.
Hub User-defined hub name.
Connection ID Identity of the connection.
Connection Type Type of the connection. Allowed values are Server (connections between server and service) and Client (connections between client and service).
User ID Identity of the user.
IP IP address of the client.
Server Sticky Routing mode of the client. Allowed values are Disabled, Preferred, and Required. For more information, see ServerStickyMode.
Transport Transport that the client can use to send HTTP requests. Allowed values are WebSockets, ServerSentEvents, and LongPolling. For more information, see HttpTransportType.
Message Tracing ID Unique identifier for a message.
Route Template Route template of the API.
Http Method HTTP method: POST, GET, PUT, or DELETE.
URL Uniform resource locator.
Trace ID Unique identifier to represent a request.
Status Code HTTP response code.
Duration Duration between receiving and processing the request.
Headers Additional information that the client and the server pass with an HTTP request or response.
Invocation ID Unique identifier to represent an invocation (available only for ASP.NET SignalR).
Message Type Type of the message. Examples include BroadcastDataMessage, JoinGroupMessage, and LeaveGroupMessage.

Next steps

Learn how to handle common problems with the live trace tool: