Fix a few more issues

grminch · grminch · commit e8198962621e · 2022-07-22T13:16:17.000-07:00
diff --git a/articles/azure-web-pubsub/howto-troubleshoot-resource-logs.md b/articles/azure-web-pubsub/howto-troubleshoot-resource-logs.md
@@ -1,64 +1,52 @@
 ---
 title: How to troubleshoot with Azure Web PubSub service resource logs
-description: Learn how to get and troubleshoot with resource logs
+description: Learn what resource logs are and how to use them for troubleshooting common problems.
 author: wanlwanl
 ms.author: wanl
 ms.service: azure-web-pubsub
 ms.topic: how-to 
-ms.date: 04/01/2022
+ms.date: 07/21/2022
 ---
 
 # How to troubleshoot with resource logs
 
-This how-to guide shows you the options to get the resource logs and how to troubleshoot with them.
+This how-to guide provides an overview of Azure Web PubSub resource logs and some tips for using the logs to troubleshoot certain problems.  Logs can be used for issue identification, connection tracking, message tracing, HTTP request tracing, and analysis.
 
-## What's the resource logs?
+## <a id="whats-are-resource-logs">What are resource logs?</a> 
 
-The resource logs provide richer view of connectivity, messaging and HTTP request information to the Azure Web PubSub service instance. They can be used for issue identification, connection tracking, message tracing, HTTP request tracing and analysis.
+There are three types of resource logs: *Connectivity*, *Messaging*, and *HTTP requests*.
+- **Connectivity** logs provide detailed information for Azure Web PubSub hub connections. For example, basic information (user ID, connection ID, and so on) and event information (connect, disconnect, and so on).
+- **Messaging** logs provide tracing information for the Azure Web PubSub hub messages received and sent via Azure Web PubSub service. For example, tracing ID and message type of the message.
+- **HTTP requests** logs provide tracing information for HTTP requests to the Azure Web PubSub service. For example, HTTP method and status code. Typically the HTTP request is recorded when it arrives at or leave from service.
 
-There are three types of logs: connectivity log, messaging log and HTTP request logs.
+## <a id="capture-resource-logs-with-live-trace-tool">Capture resource logs by using the live trace tool</a>
 
-### Connectivity logs
-
-Connectivity logs provide detailed information for Azure Web PubSub hub connections. For example, basic information (user ID, connection ID, and so on) and event information (connect, disconnect, and abort event, and so on). That's why the connectivity log is helpful to troubleshoot connection-related issues.
-
-### Messaging logs
-
-Messaging logs provide tracing information for the Azure Web PubSub hub messages received and sent via Azure Web PubSub service. For example, tracing ID and message type of the message. Typically the message is recorded when it arrives at or leaves from service. So messaging logs are helpful for troubleshooting message-related issues.
-
-### HTTP request logs
-
-Http request logs provide tracing information for HTTP requests to the Azure Web PubSub service. For example, HTTP method and status code. Typically the HTTP request is recorded when it arrives at or leave from service. So HTTP request logs are helpful for troubleshooting request-related issues.
-
-## Capture resource logs with live trace tool 
-
-The Azure Web PubSub service live trace tool has ability to collect resource logs in real time, and is helpful to trace with customer's development environment. The live trace tool could capture connectivity logs, messaging logs and HTTP request logs.
-
-> [!NOTE]
-> The real-time resource logs captured by live trace tool will be billed as messages (outbound traffic).
+The Azure Web PubSub service live trace tool has ability to 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.
 
 > [!NOTE]
-> The Azure Web PubSub service instance created as free tier has the daily limit of messages (outbound traffic).
+> The following considerations apply to using the live trace tool:
+>    - The real-time resource logs captured by live trace tool will be billed as messages (outbound traffic).
+>    - The live trace tool does not currently support Azure Active Directory authentication. You must enable access keys to use live trace. Under **Settings**, select **Keys**, and then enable **Access Key**.
+>    - The Azure Web PubSub service Free Tier instance has a daily limit of 20,000 messages (outbound traffic). Live trace can cause you to unexpectedly reach the daily limit.
 
 ### Launch the live trace tool
 
-1. Go to the Azure portal. 
-2. On the **Live trace settings** page of your Azure Web PubSub service instance, check **Enable Live Trace** if it's disabled.
-3. Check any log category you need.
-4. Click **Save** button and wait until the settings take effect.
-5. Click *Open Live Trace Tool*
+1. Go to the Azure portal and your Web PubSub service.
+1. On the left menu, under **Monitoring**, select **Live trace settings.**
+1. On the **Live trace settings** page, select **Enable Live Trace**.
+1. Choose the log categories to collect.
+1. Select **Save** and then wait until the settings take effect.
+1. Select **Open Live Trace Tool**.
 
     :::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.":::
 
-> Azure Active Directory access to live trace tool is not yet supported, please enable `Access Key` in `Keys` menu.
-
 ### Capture the resource logs
 
-The live trace tool provides some fundamental functionalities to help you capture the resource logs for troubleshooting.
+The live trace tool provides functionality to help you capture the resource logs for troubleshooting.
 
-* **Capture**: Begin to capture the real-time resource logs from Azure Web PubSub instance with live trace tool.
+* **Capture**: Begin to capture the real-time resource logs from Azure Web PubSub.
 * **Clear**: Clear the captured real-time resource logs.
-* **Log filter**: The live trace tool allows you filtering the captured real-time resource logs 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. 
+* **Log filter**: The live trace tool lets you filter the captured real-time resource logs with one specific key word. The common separators (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.
 
 :::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/live-trace-tool-capture.png" alt-text="Screenshot of capturing resource logs with live trace tool.":::
@@ -68,47 +56,43 @@ The real-time resource logs captured by live trace tool contain detailed informa
 | Name | Description |
 | ------------ |  ------------------------ | 
 | Time | Log event time |
-| Log Level | Log event level (Trace/Debug/Informational/Warning/Error) |
+| Log Level | Log event level, can be  [Trace \| Debug \| Informational \| Warning \| Error] |
 | Event Name | Operation name of the event |
-| Message | Detailed message of log event |
+| Message | Detailed message for the event |
 | Exception | The run-time exception of Azure Web PubSub service |
-| Hub | User-defined Hub Name |
+| Hub | User-defined hub name |
 | Connection ID | Identity of the connection |
-| User ID | Identity of the user |
-| IP | The IP address of client |
+| User ID | User identity|
+| IP | Client IP address |
 | 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 the invocation |
 | Status Code | The Http response code |
-| Duration | The duration between the request is received and processed |
+| Duration | The duration between receiving the request and processing the request |
 | Headers | The additional information passed by the client and the server with an HTTP request or response |
 
-After the Azure Web PubSub service is GA, the live trace tool will also support to export the logs as a specific format and then help you share with others for troubleshooting. 
-
 ## Capture resource logs with Azure Monitor
 
 ### How to enable resource logs
 
-Currently Azure Web PubSub supports integrate with [Azure Storage](../azure-monitor/essentials/resource-logs.md#send-to-azure-storage).
+Currently Azure Web PubSub supports integration with [Azure Storage](../azure-monitor/essentials/resource-logs.md#send-to-azure-storage).
 
 1. Go to Azure portal.
-2. On **Diagnostic settings** page of your Azure Web PubSub service instance, click **+ Add diagnostic setting** link.
-3. In **Diagnostic setting name**, input the setting name.
-4. In **Category details**, select any log category you need.
-5. In **Destination details**, check **Archive to a storage account**.
-6. Click **Save** button to save the diagnostic setting.
-
-:::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-settings-list.png" alt-text="Screenshot of viewing diagnostic settings and create a new one":::
-
-:::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-settings-details.png" alt-text="Screenshot of configuring diagnostic setting detail":::
-
+1. On **Diagnostic settings** page of your Azure Web PubSub service instance, select **+ Add diagnostic setting**.
+    :::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-settings-list.png" alt-text="Screenshot of viewing diagnostic settings and create a new one":::
+1. In **Diagnostic setting name**, input the setting name.
+1. In **Category details**, select any log category you need.
+1. In **Destination details**, check **Archive to a storage account**.
+
+    :::image type="content" source="./media/howto-troubleshoot-diagnostic-logs/diagnostic-settings-details.png" alt-text="Screenshot of configuring diagnostic setting detail":::
+1. Select **Save** to save the diagnostic setting.
 > [!NOTE]
-> The storage account should be the same region to Azure Web PubSub service.
+> The storage account should be in the same region as Azure Web PubSub service.
 
-### Archive to Azure Storage Account
+### Archive to an Azure Storage Account
 
-Logs are stored in the storage account that configured in **Diagnostics setting** pane. A container named `insights-logs-<CATEGORY_NAME>` is created automatically to store resource logs. Inside the container, logs are stored in the file `resourceId=/SUBSCRIPTIONS/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/RESOURCEGROUPS/XXXX/PROVIDERS/MICROSOFT.SIGNALRSERVICE/SIGNALR/XXX/y=YYYY/m=MM/d=DD/h=HH/m=00/PT1H.json`. Basically, the path is combined by `resource ID` and `Date Time`. The log files are split by `hour`. Therefore, the minutes always be `m=00`.
+Logs are stored in the storage account that's configured in the **Diagnostics setting** pane. A container named `insights-logs-<CATEGORY_NAME>` is created automatically to store resource logs. Inside the container, logs are stored in the file `resourceId=/SUBSCRIPTIONS/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/RESOURCEGROUPS/XXXX/PROVIDERS/MICROSOFT.SIGNALRSERVICE/SIGNALR/XXX/y=YYYY/m=MM/d=DD/h=HH/m=00/PT1H.json`. The path is combined by `resource ID` and `Date Time`. The log files are split by `hour`. The minute value is always `m=00`.
 
 All logs are stored in JavaScript Object Notation (JSON) format. Each entry has string fields that use the format described in the following sections.
 
@@ -124,7 +108,7 @@ resourceId | Resource ID of your Azure SignalR Service
 location | Location of your Azure SignalR Service
 category | Category of the log event
 operationName | Operation name of the event
-callerIpAddress | IP address of your server/client
+callerIpAddress | IP address of your server or client
 properties | Detailed properties related to this log event. For more detail, see the properties table below
 
 **Properties Table**
@@ -166,25 +150,31 @@ The following code is an example of an archive log JSON string:
 
 ### Archive to Azure Log Analytics
 
-Once you check `Send to Log Analytics`, and select target Azure Log Analytics, the logs will be stored in the target. To view resource logs, follow these steps:
+To send logs to a Log Analytics workspace:
+1. On the **Diagnostic setting** page, under **Destination details**, select **Send to Log Analytics workspace.
+1. Select the **Subscription** you want to use.
+1. Select the **Log Analytics workspace** to use as the destination for the logs.
 
-1. Select `Logs` in your target Log Analytics.
+To view the resource logs, follow these steps:
+
+1. Select `Logs` in your target Log Analytics workspace.
 
     :::image type="content" alt-text="Log Analytics menu item" source="./media/howto-troubleshoot-diagnostic-logs/log-analytics-menu-item.png" lightbox="./media/howto-troubleshoot-diagnostic-logs/log-analytics-menu-item.png":::
 
-2. Enter `WebPubSubConnectivity`, `WebPubSubMessaging` or `WebPubSubHttpRequest` and select time range to query [connectivity log](#connectivity-logs), [messaging log](#messaging-logs) or [http request logs](#http-request-logs) correspondingly. For advanced query, see [Get started with Log Analytics in Azure Monitor](../azure-monitor/logs/log-analytics-tutorial.md)
+1. Enter `WebPubSubConnectivity`, `WebPubSubMessaging` or `WebPubSubHttpRequest`, and then select the time range to query the log. For advanced queries, see [Get started with Log Analytics in Azure Monitor](../azure-monitor/logs/log-analytics-tutorial.md).
 
     :::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":::
 
-To use sample query for SignalR service, please follow the steps below:
+
+To use a sample query for SignalR service, follow the steps below.
 1. Select `Logs` in your target Log Analytics.
-2. Select `Queries` to open query explorer.
-3. Select `Resource type` to group sample queries in resource type.
-4. Select `Run` to run the script.
+1. Select `Queries` to open query explorer.
+1. Select `Resource type` to group sample queries in resource type.
+1. Select `Run` to run the script.
     :::image type="content" alt-text="Sample query in Log Analytics" source="./media/howto-troubleshoot-diagnostic-logs/log-analytics-sample-query.png" lightbox="./media/howto-troubleshoot-diagnostic-logs/log-analytics-sample-query.png":::
 
 
-Archive log columns include elements listed in the following table:
+Archive log columns include elements listed in the following table.
 
 Name | Description
 ------- | ------- 
@@ -202,15 +192,15 @@ TransportType | Transport type of the connection. Allowed values are: `Websocket
 
 ## Troubleshoot with the resource logs
 
-When finding connection unexpected growing or dropping situation, you can take advantage of resource logs to troubleshoot. Typical issues are often about connections' unexpected quantity changes, connections reach connection limits and authorization failure.
+If you find unexpected changes in the number of connections, either increasing or decreasing, you can take advantage of resource logs to troubleshoot the problem. Typical issues are often about connections' unexpected quantity changes, connections reach connection limits, and authorization failure.
 
-### Unexpected connection number changes
+### Unexpected changes in number of connections
 
 #### Unexpected connection dropping
 
-If a connection disconnects, the resource logs will record this disconnecting event with `ConnectionAborted` or `ConnectionEnded` in `operationName`.
+If a connection disconnects, the resource logs will record the disconnection event with `ConnectionAborted` or `ConnectionEnded` in `operationName`.
 
-The difference between `ConnectionAborted` and `ConnectionEnded` is that `ConnectionEnded` is an expected disconnecting which is triggered by client or server side. While the `ConnectionAborted` is usually an unexpected connection dropping event, and aborting reason will be provided in `message`.
+The difference between `ConnectionAborted` and `ConnectionEnded` is that `ConnectionEnded` is an expected disconnection that is triggered by the client or server side. While the `ConnectionAborted` is usually an unexpected connection dropping event, and the reason for disconnection will be provided in `message`.
 
 The abort reasons are listed in the following table:
 
@@ -220,14 +210,14 @@ The abort reasons are listed in the following table:
 | Service reloading, reconnect | Azure Web PubSub service is reloading. You need to implement your own reconnect mechanism or manually reconnect to Azure Web PubSub service |
 | Internal server transient error | Transient error occurs in Azure Web PubSub service, should be auto recovered
 
-#### Unexpected connection growing
+#### Unexpected increase in connections
 
-To troubleshoot about unexpected connection growing, the first thing you need to do is to filter out the extra connections. You can add unique test user ID to your test client connection. Then verify it in with resource logs, if you see more than one client connections have the same test user ID or IP, then it is likely the client side create and establish more connections than expectation. Check your client side.
+When the number of client connections unexpectedly increases, the first thing you need to do is to filter out the superfluous connections. Add a unique test user ID to your test client connection. Then check the resource logs; if you see more than one client connection has the same test user ID or IP, then it's likely the client is creating more connections than expected. Check your client code to find the source of the extra connections.
 
 ### Authorization failure
 
-If you get 401 Unauthorized returned for client requests, check your resource logs. If you meet `Failed to validate audience. Expected Audiences: <valid audience>. Actual Audiences: <actual audience>`, it means all audiences in your access token are invalid. Try to use the valid audiences suggested in the log.
+If you get 401 Unauthorized returned for client requests, check your resource logs. If you find `Failed to validate audience. Expected Audiences: <valid audience>. Actual Audiences: <actual audience>`, it means all audiences in your access token are invalid. Try to use the valid audiences suggested in the log.
 
 ### Throttling
 
-If you find that you cannot establish client connections to Azure Web PubSub service, check your resource logs. If you meet `Connection count reaches limit` in resource log, you establish too many connections to Azure Web PubSub service, which reach the connection count limit. Consider scaling up your Azure Web PubSub service instance. If you meet `Message count reaches limit` in resource log, it means you use free tier, and you use up the quota of messages. If you want to send more messages, consider changing your Azure Web PubSub service instance to standard tier to send additional messages. For more information, see [Azure Web PubSub service Pricing](https://azure.microsoft.com/pricing/details/web-pubsub/).
+If you find that you can't establish client connections to Azure Web PubSub service, check your resource logs. If you see `Connection count reaches limit` in the resource log, you established too many connections to Azure Web PubSub service and reached the connection count limit. Consider scaling up your Azure Web PubSub service instance. If you see `Message count reaches limit` in the resource log and you're using the Free tier, it means you used up the quota of messages. If you want to send more messages, consider changing your Azure Web PubSub service instance to Standard tier. For more information, see [Azure Web PubSub service Pricing](https://azure.microsoft.com/pricing/details/web-pubsub/).
