How to use live trace tool for Azure SignalR service
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 click. You can also choose any log category that you're interested.
Note
Please note that the live traces will be counted as outbound messages.
Launch the live trace tool
Go to the Azure portal.
Check Enable Live Trace.
click Save button in tool bar and wait for the changes take effect.
On the Diagnostic Settings page of your Azure Web PubSub service instance, select Open Live Trace Tool.
Capture live traces
The live trace tool provides some fundamental functionalities to help you capture the live traces for troubleshooting.
- Capture: Begin to capture the real time live traces from Azure Web PubSub instance with live trace tool.
- Clear: Clear the captured real time live traces.
- Export: Export live traces to a file. The current supported file format is CSV file.
- Log filter: The live trace tool allows you filtering the captured real time live traces with one specific key word. The common separator (for example, space, comma, semicolon, and so on) will be treated as part of the key word.
- Status: The status shows whether the live trace tool is connected or disconnected with the specific instance.
The real time live traces captured by live trace tool contain detailed information for troubleshooting.
| Name | Description |
|---|---|
| Time | Log event time |
| Log Level | Log event level (Trace/Debug/Informational/Warning/Error) |
| Event Name | Operation name of the event |
| Message | Detailed message of log event |
| Exception | The run-time exception of 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 | The IP address of client |
| Server Sticky | Routing mode of client. Allowed values are Disabled, Preferred and Required. For more information, see ServerStickyMode |
| Transport | The 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 | The unique identifier for a message |
| Route Template | The route template of the API |
| Http Method | The Http method (POST/GET/PUT/DELETE) |
| URL | The uniform resource locator |
| Trace ID | The unique identifier to represent a request |
| Status Code | the Http response code |
| Duration | The duration between the request is received and processed |
| Headers | The additional information passed by the client and the server with an HTTP request or response |
| Invocation ID | The unique identifier to represent a invocation (only available for ASP.NET SignalR) |
| Message Type | The type of the message (BroadcastDataMessage/JoinGroupMessage/LeaveGroupMessage/...) |
Next Steps
In this guide, you learned about how to use live trace tool. You could also learn how to handle the common issues:
- Troubleshooting guides: For how to troubleshoot typical issues based on live traces, see our troubleshooting guide.
- Troubleshooting methods: For self-diagnosis to find the root cause directly or narrow down the issue, see our troubleshooting methods introduction.