You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-signalr/signalr-tutorial-diagnostic-logs.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,38 @@
1
1
---
2
-
title: Diagnostic Logs for Azure SignalR Service
3
-
description: Learn how to set up diagnostic logs for Azure SignalR Service and how to utilize it to self-troubleshoot.
2
+
title: Resource Logs for Azure SignalR Service
3
+
description: Learn how to set up resource logs for Azure SignalR Service and how to utilize it to self-troubleshoot.
4
4
author: wanlwanl
5
5
ms.service: signalr
6
6
ms.topic: conceptual
7
7
ms.date: 12/17/2019
8
8
ms.author: wanl
9
9
---
10
10
11
-
# Diagnostic Logs for Azure SignalR Service
11
+
# Resource logs for Azure SignalR Service
12
12
13
-
This tutorial covers what are diagnostic logs for Azure SignalR Service and how to set up diagnostic logs and how to troubleshoot with diagnostic logs.
13
+
This tutorial discusses what resource logs for Azure SignalR Service are, how to set them up, and how to troubleshoot with them.
14
14
15
15
## Prerequisites
16
-
To enable diagnostic logs, you'll need somewhere to store your log data. This tutorial uses Azure Storage and Log Analytics.
16
+
To enable resource logs, you'll need somewhere to store your log data. This tutorial uses Azure Storage and Log Analytics.
17
17
18
-
*[Azure storage](../azure-monitor/platform/resource-logs-collect-storage.md) - Retains diagnostic logs for policy audit, static analysis, or backup.
18
+
*[Azure storage](../azure-monitor/platform/resource-logs-collect-storage.md) - Retains resource logs for policy audit, static analysis, or backup.
19
19
*[Log Analytics](../azure-monitor/platform/resource-logs-collect-workspace.md) - A flexible log search and analytics tool that allows for analysis of raw logs generated by an Azure resource.
20
20
21
-
## Set up diagnostic logs for an Azure SignalR Service
21
+
## Set up resource logs for an Azure SignalR Service
22
22
23
-
You can view diagnostic logs for Azure SignalR Service. These logs provide richer view of connectivity to your Azure SignalR Service instance. The diagnostic logs provide detailed information of every connection. For example, basic information (user ID, connection ID and transport type and so on) and event information (connect, disconnect and abort event and so on) of the connection. Diagnostic logs can be used for issue identification, connection tracking and analysis.
23
+
You can view resource logs for Azure SignalR Service. These logs provide richer view of connectivity to your Azure SignalR Service instance. The resource logs provide detailed information of every connection. For example, basic information (user ID, connection ID and transport type and so on) and event information (connect, disconnect and abort event and so on) of the connection. resource logs can be used for issue identification, connection tracking and analysis.
24
24
25
-
### Enable diagnostic logs
25
+
### Enable resource logs
26
26
27
-
Diagnostic logs are disabled by default. To enable diagnostic logs, follow these steps:
27
+
Resource logs are disabled by default. To enable resource logs, follow these steps:
28
28
29
29
1. In the [Azure portal](https://portal.azure.com), under **Monitoring**, click **Diagnostic settings**.
30
30
31
31

1. Set the archive target that you want. Currently, we support **Archive to a storage account** and **Send to Log Analytics**.
38
38
@@ -45,17 +45,17 @@ Diagnostic logs are disabled by default. To enable diagnostic logs, follow these
45
45
46
46
New settings take effect in about 10 minutes. After that, logs appear in the configured archival target, in the **Diagnostics logs** pane.
47
47
48
-
For more information about configuring diagnostics, see the [overview of Azure diagnostic logs](../azure-monitor/platform/platform-logs-overview.md).
48
+
For more information about configuring diagnostics, see the [overview of Azure resource logs](../azure-monitor/platform/platform-logs-overview.md).
49
49
50
-
### Diagnostic logs categories
50
+
### Resource logs categories
51
51
52
-
Azure SignalR Service captures diagnostic logs in one category:
52
+
Azure SignalR Service captures resource logs in one category:
53
53
54
54
***All Logs**: Track connections that connect to Azure SignalR Service. The logs provide information about the connect/disconnect, authentication and throttling. For more information, see the next section.
55
55
56
56
### Archive to a storage account
57
57
58
-
Logs are stored in the storage account that configured in **Diagnostics logs** pane. A container named `insights-logs-alllogs` is created automatically to store diagnostic 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`.
58
+
Logs are stored in the storage account that configured in **Diagnostics logs** pane. A container named `insights-logs-alllogs` 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`.
59
59
60
60
All logs are stored in JavaScript Object Notation (JSON) format. Each entry has string fields that use the format described in the following sections.
61
61
@@ -111,13 +111,13 @@ The following code is an example of an archive log JSON string:
111
111
112
112
### Archive logs schema for Log Analytics
113
113
114
-
To view diagnostic logs, follow these steps:
114
+
To view resource logs, follow these steps:
115
115
116
116
1. Click `Logs` in your target Log Analytics.
117
117
118
118

119
119
120
-
2. Enter `SignalRServiceDiagnosticLogs` and select time range to query diagnostic logs. For advanced query, see [Get started with Log Analytics in Azure Monitor](../azure-monitor/log-query/get-started-portal.md)
120
+
2. Enter `SignalRServiceDiagnosticLogs` and select time range to query resource logs. For advanced query, see [Get started with Log Analytics in Azure Monitor](../azure-monitor/log-query/get-started-portal.md)
121
121
122
122

123
123
@@ -137,11 +137,11 @@ ConnectionId | Identity of the connection
137
137
ConnectionType | Type of the connection. Allowed values are: `Server`\|`Client`. `Server`: connection from server side; `Client`: connection from client side
138
138
TransportType | Transport type of the connection. Allowed values are: `Websockets`\|`ServerSentEvents`\|`LongPolling`
139
139
140
-
### Troubleshooting with diagnostic logs
140
+
### Troubleshooting with resource logs
141
141
142
-
To troubleshoot for Azure SignalR Service, you can enable server/client side logs to capture failures. At present, Azure SignalR Service exposes diagnostic logs, you can also enable logs for service side.
142
+
To troubleshoot for Azure SignalR Service, you can enable server/client side logs to capture failures. At present, Azure SignalR Service exposes resource logs, you can also enable logs for service side.
143
143
144
-
When encountering connection unexpected growing or dropping situation, you can take advantage of diagnostic logs to troubleshoot.
144
+
When encountering connection unexpected growing or dropping situation, you can take advantage of resource logs to troubleshoot.
145
145
146
146
Typical issues are often about connections' unexpected quantity changes, connections reach connection limits and authorization failure. See the next sections about how to troubleshoot.
147
147
@@ -151,7 +151,7 @@ Typical issues are often about connections' unexpected quantity changes, connect
151
151
152
152
If you encounter unexpected connections drop, firstly enable logs in service, server and client sides.
153
153
154
-
If a connection disconnects, the diagnostic logs will record this disconnecting event, you will see `ConnectionAborted` or `ConnectionEnded` in `operationName`.
154
+
If a connection disconnects, the resource logs will record this disconnecting event, you will see `ConnectionAborted` or `ConnectionEnded` in `operationName`.
155
155
156
156
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`.
157
157
@@ -168,20 +168,20 @@ Server connection dropped | Server connection drops with unknown error, consider
168
168
169
169
##### Unexpected connection growing
170
170
171
-
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 diagnostic 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.
171
+
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.
172
172
173
173
#### Authorization failure
174
174
175
-
If you get 401 Unauthorized returned for client requests, check your diagnostic logs. If you encounter `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.
175
+
If you get 401 Unauthorized returned for client requests, check your resource logs. If you encounter `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.
176
176
177
177
178
178
#### Throttling
179
179
180
-
If you find that you cannot establish SignalR client connections to Azure SignalR Service, check your diagnostic logs. If you encounter `Connection count reaches limit` in diagnostic log, you establish too many connections to SignalR Service, which reach the connection count limit. Consider scaling up your SignalR Service. If you encounter `Message count reaches limit` in diagnostic 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 SignalR Service to standard tier to send additional messages. For more information, see [Azure SignalR Service Pricing](https://azure.microsoft.com/pricing/details/signalr-service/).
180
+
If you find that you cannot establish SignalR client connections to Azure SignalR Service, check your resource logs. If you encounter `Connection count reaches limit` in resource log, you establish too many connections to SignalR Service, which reach the connection count limit. Consider scaling up your SignalR Service. If you encounter `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 SignalR Service to standard tier to send additional messages. For more information, see [Azure SignalR Service Pricing](https://azure.microsoft.com/pricing/details/signalr-service/).
181
181
182
182
### Get help
183
183
184
-
We recommend you troubleshoot by yourself first. Most issues are caused by app server or network issues. Follow [troubleshooting guide with diagnostic log](#troubleshooting-with-diagnostic-logs) and [basic trouble shooting guide](https://github.com/Azure/azure-signalr/blob/dev/docs/tsg.md) to find the root cause.
184
+
We recommend you troubleshoot by yourself first. Most issues are caused by app server or network issues. Follow [troubleshooting guide with resource log](#troubleshooting-with-diagnostic-logs) and [basic trouble shooting guide](https://github.com/Azure/azure-signalr/blob/dev/docs/tsg.md) to find the root cause.
185
185
If the issue still can't be resolved, then consider open an issue in GitHub or create ticket in Azure Portal.
186
186
Provide:
187
187
1. Time range about 30 minutes when the issue occurs
Copy file name to clipboardExpand all lines: articles/bastion/diagnostic-logs.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: 'Enable and work with Azure Bastion diagnostic logs'
2
+
title: 'Enable and work with Azure Bastion resource logs'
3
3
description: In this article, learn how to enable and work with Azure Bastion diagnostic logs.
4
4
services: bastion
5
5
author: charwen
@@ -11,11 +11,11 @@ ms.author: charwen
11
11
12
12
---
13
13
14
-
# Enable and work with Bastion diagnostic logs
14
+
# Enable and work with Bastion resource logs
15
15
16
16
As users connect to workloads using Azure Bastion, Bastion can log diagnostics of the remote sessions. You can then use the diagnostics to view which users connected to which workloads, at what time, from where, and other such relevant logging information. In order to use the diagnostics, you must enable diagnostics logs on Azure Bastion. This article helps you enable diagnostics logs, and then view the logs.
17
17
18
-
## <aname="enable"></a>Enable the diagnostics log
18
+
## <aname="enable"></a>Enable the resource log
19
19
20
20
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure Bastion resource and select **Diagnostics settings** from the Azure Bastion page.
21
21
@@ -40,7 +40,7 @@ To access your diagnostics logs, you can directly use the storage account that y
40
40
2. As you navigate to inside the container, you see various folders in your blog. These folders indicate the resource hierarchy for your Azure Bastion resource.
3. Navigate to the full hierarchy of your Azure Bastion resource whose diagnostics logs you wish to access/view. The 'y=', 'm=', 'd=', 'h=' and 'm=' indicate the year, month, day, hour, and minute respectively for the diagnostic logs.
43
+
3. Navigate to the full hierarchy of your Azure Bastion resource whose diagnostics logs you wish to access/view. The 'y=', 'm=', 'd=', 'h=' and 'm=' indicate the year, month, day, hour, and minute respectively for the resource logs.
0 commit comments