Skip to content

Commit f1d071d

Browse files
committed
howto-troubleshoot-resource-logs
1 parent fec1d5d commit f1d071d

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/azure-web-pubsub/howto-troubleshoot-resource-logs.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,29 @@ There are three types of resource logs: _Connectivity_, _Messaging_, and _HTTP r
1818

1919
- **Connectivity** logs provide detailed information for Azure Web PubSub hub connections. They might include basic information like user ID and connection ID, or event information like connect and disconnect.
2020
- **Messaging** logs provide tracing information for hub messages that are sent or received via Azure Web PubSub service, like the tracing ID or message type.
21-
- **HTTP request** logs provide tracing information for HTTP requests to the Azure Web PubSub service, like HTTP method or status code. Typically a HTTP request is recorded when it arrives at or leaves from the service.
21+
- **HTTP request** logs provide tracing information for HTTP requests to the Azure Web PubSub service, like HTTP method or status code. Typically, an HTTP request is recorded when it arrives at or leaves from the service.
2222

2323
## Capture resource logs with the live trace tool
2424

2525
The Azure Web PubSub service live trace tool can collect resource logs in real time, which is helpful for troubleshooting problems in your development environment. The live trace tool can capture connectivity logs, messaging logs, and HTTP request logs.
2626

2727
> [!NOTE]
28-
> You should consider the following when using the live trace tool:
28+
> You should consider the following factors when using the live trace tool:
2929
>
3030
> - The real-time resource logs captured by the live trace tool are billed as messages (outbound traffic).
3131
> - The Azure Web PubSub service Free tier instance has a daily limit of 20,000 messages (outbound traffic). You can unexpectedly reach the daily limit by using live trace.
32-
> - The live trace tool does not currently support Microsoft Entra authorization. You must enable access keys to use live trace. Under **Settings**, select **Keys**, and then enable **Access Key**.
32+
> - The live trace tool doesn't currently support Microsoft Entra authorization. You must enable access keys to use live trace. Under **Settings**, select **Keys**, and then enable **Access Key**.
3333
3434
## Launch the live trace tool
3535

36-
When you enable an access key, you'll use the access token to authenticate the live trace tool. Otherwise, you'll use Microsoft Entra ID to authenticate the live trace tool. You can find out if the access key is enabled by going to your Azure SignalR Service's Keys pane in the Azure portal.
36+
When you enable an access key, you use the access token to authenticate the live trace tool. Otherwise, you use Microsoft Entra ID to authenticate the live trace tool. You can find out if the access key is enabled by going to your Azure SignalR Service's Keys pane in the Azure portal.
3737

3838
### Launch the live trace when the access key is enabled
3939

4040
1. Go to the Azure portal and your SignalR Service pane.
4141
1. From the menu on the left, under **Monitoring**, select **Live trace settings**.
4242
1. Select **Enable Live Trace**.
43-
1. Select the **Save** button. It will take a moment for the changes to take effect.
43+
1. Select the **Save** button. It takes a moment for the changes to take effect.
4444
1. When updating is complete, select **Open Live Trace Tool**.
4545

4646
:::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-logs-with-live-trace-tool.png" alt-text="Screenshot of launching the live trace tool.":::
@@ -61,7 +61,7 @@ When you enable an access key, you'll use the access token to authenticate the l
6161
1. Go to the Azure portal and your SignalR Service pane.
6262
1. From the menu on the left, under **Monitoring**, select **Live trace settings**.
6363
1. Select **Enable Live Trace**.
64-
1. Select the **Save** button. It will take a moment for the changes to take effect.
64+
1. Select the **Save** button. It takes a moment for the changes to take effect.
6565
1. When updating is complete, select **Open Live Trace Tool**.
6666

6767
:::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-logs-with-live-trace-tool.png" alt-text="Screenshot of launching the live trace tool.":::
@@ -75,10 +75,10 @@ When you enable an access key, you'll use the access token to authenticate the l
7575

7676
The live trace tool can help you capture the resource logs for troubleshooting.
7777

78-
- **Capture**: This begins to capture the real-time resource logs from Azure Web PubSub.
79-
- **Clear**: This clears the captured real-time resource logs.
80-
- **Log filter**: This filters the captured real-time resource logs with one specific keyword. The common separators like space, comma, and semicolon are treated as part of the keyword.
81-
- **Status**: The status shows whether the live trace tool is connected or disconnected with the specific instance.
78+
- **Capture** begins to capture the real-time resource logs from Azure Web PubSub.
79+
- **Clear** clears the captured real-time resource logs.
80+
- **Log filter** filters the captured real-time resource logs with one specific keyword. The common separators like space, comma, and semicolon are treated as part of the keyword.
81+
- **Status** shows whether the live trace tool is connected or disconnected with the specific instance.
8282

8383
:::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/live-trace-tool-capture.png" alt-text="Screenshot of capturing resource logs with the live trace tool.":::
8484

@@ -87,7 +87,7 @@ The real-time resource logs captured by the live trace tool contain detailed inf
8787
| Name | Description |
8888
| -------------- | ----------------------------------------------------------------------------------------------- |
8989
| Time | Log event time |
90-
| Log Level | Log event level, can be [Trace \| Debug \| Informational \| Warning \| Error] |
90+
| Log Level | Log event level can be [Trace \| Debug \| Informational \| Warning \| Error] |
9191
| Event Name | Operation name of the event |
9292
| Message | Detailed message for the event |
9393
| Exception | The run-time exception of Azure Web PubSub service |
@@ -198,7 +198,7 @@ To view the resource logs, follow these steps:
198198

199199
:::image type="content" alt-text="Query log in Log Analytics" source="./media/howto-troubleshoot-diagnostic-logs/query-log-in-log-analytics.png" lightbox="./media/howto-troubleshoot-diagnostic-logs/query-log-in-log-analytics.png":::
200200

201-
To use a sample query for SignalR service, follow the steps below.
201+
To use a sample query for SignalR service, follow these steps:
202202

203203
1. Select `Logs` in your target Log Analytics.
204204
1. Select `Queries` to open query explorer.
@@ -230,7 +230,7 @@ If you find unexpected increases or decreases in the number of connections, you
230230

231231
#### Unexpected disconnection events
232232

233-
If a connection disconnects, the resource logs will record the disconnection event with `ConnectionAborted` or `ConnectionEnded` in `operationName`.
233+
If a connection disconnects, the resource logs record the disconnection event with `ConnectionAborted` or `ConnectionEnded` in `operationName`.
234234

235235
The difference between `ConnectionAborted` and `ConnectionEnded` is that `ConnectionEnded` is an expected disconnection that is triggered by the client or server side. By contrast, `ConnectionAborted` usually refers to an event in which a connection unexpectedly drops, and the reason for disconnection is provided in `message`.
236236

0 commit comments

Comments
 (0)