Skip to content

Commit e093bfd

Browse files
author
Manika Dhiman
committed
tweaks
1 parent de8a2a0 commit e093bfd

File tree

1 file changed

+37
-39
lines changed

1 file changed

+37
-39
lines changed

azure-stack/hci/manage/collect-logs.md

Lines changed: 37 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: alkohli
66
ms.topic: how-to
77
ms.service: azure-stack
88
ms.subservice: azure-stack-hci
9-
ms.date: 06/18/2024
9+
ms.date: 06/27/2024
1010
---
1111

1212
# Collect diagnostic logs for Azure Stack HCI
@@ -25,7 +25,7 @@ Here are the scenarios in which you can perform on-demand log collection:
2525

2626
- Microsoft Support requests for logs based on an open case.
2727
- Logs are collected when a cluster is connected and registered.
28-
- Logs are collected when the Observability components are operational and installed.
28+
- Logs are collected when the observability components are operational and installed.
2929
- Logs are collected when a cluster is only partly registered.
3030
- Logs are collected for issues not related to registration failures.
3131

@@ -45,35 +45,33 @@ You can perform on-demand log collection using any of the following methods:
4545

4646
- **(Recommended) Azure portal**. Use this method when you want to collect and send logs at the cluster level.
4747

48-
- **PowerShell**. Use this method if you want to collect logs based on specific parameters. You can save them to an SMB share, send supplementary logs, or send logs for specific rules only. To collect logs and send them to Microsoft, run the `Send-DiagnosticData` cmdlet from any node within the Azure Stack HCI cluster. When you run this cmdlet, the logs are temporarily copied locally. This copy is parsed, sent to Microsoft, and then deleted from your system.
48+
- **PowerShell**. Use this method if you want to collect logs based on specific parameters. You have the option to save logs to an SMB share, send supplementary logs, or send logs for specific rules only.
4949

5050
### [Azure portal (recommended)](#tab/azureportal)
5151

5252
Follow these steps to collect diagnostic logs for your Azure Stack HCI cluster via the Azure portal:
5353

54-
1. the Azure portal, go to the Azure Stack HCI cluster resource.
54+
1. In the Azure portal, go to the Azure Stack HCI cluster resource.
5555
1. In the left pane, under **Settings**, select **Diagnostics and Remote Support**.
5656
1. On the **Get started** tab, under the **Send Diagnostics Logs** tile, select **Go to diagnostics**.
5757

5858
:::image type="content" source="./media/collect-logs/get-started-tab.png" alt-text="Screenshot shows the Get started tab." lightbox="./media/collect-logs/get-started-tab.png" :::
5959

60-
1. On the **Diagnostics** tab, under **Log activity**, review the log collection entries for your cluster. If you want more details about a specific log collection entry, select the link under **Time collected** to view more details in the **Log details** pane.
60+
1. On the **Diagnostics** tab, under **Log activity**, review log collection history for your cluster. To get more details about a specific log collection entry, select the link under **Time collected** to view more information in the **Log details** pane.
6161

6262
:::image type="content" source="./media/collect-logs/log-details-pane.png" alt-text="Screenshot shows the Log details pane." lightbox="./media/collect-logs/log-details-pane.png" :::
6363

64-
1. To collect and send logs now, select **Send logs** .
64+
1. To collect and send logs now, select **Send logs**.
6565

6666
:::image type="content" source="./media/collect-logs/diagnostics-tab.png" alt-text="Screenshot shows the Send logs button." lightbox="./media/collect-logs/diagnostics-tab.png" :::
6767

68-
1. On the **Send logs** pane on the right, select the **Log start time** and **Log end time**.
69-
70-
1. Select the **Collect and upload logs** button. By selecting this, you agree to the terms and conditions of collection logs.
68+
1. On the **Send logs** pane on the right, select the **Log start time** and **Log end time**, and then select the **Collect and upload logs** button. By doing this, you agree to the terms and conditions of collection logs.
7169

7270
:::image type="content" source="./media/collect-logs/send-logs-pane.png" alt-text="Screenshot shows the Send logs pane." lightbox="./media/collect-logs/send-logs-pane.png" :::
7371

7472
## [PowerShell](#tab/powershell)
7573

76-
Run the `Send-DiagnosticData` cmdlet from any node on your Azure Stack HCI cluster to perform on-demand log collection.
74+
To collect logs and send them to Microsoft using PowerShell, run the `Send-DiagnosticData` cmdlet from any node within the Azure Stack HCI cluster. When you run this cmdlet, the logs are temporarily copied locally. This copy is parsed, sent to Microsoft, and then deleted from your system.
7775

7876
Here are some important points to consider:
7977

@@ -221,34 +219,11 @@ Follow these steps to save logs to a local share:
221219
Send-DiagnosticData -SaveToPath <path to share> -ShareCredential $shareCredential
222220
```
223221

224-
If you have outbound connectivity from the SMB share where you saved the logs, you can run the following command to send the logs to Microsoft:
225-
226-
```powershell
227-
Send-DiagnosticData NoLogCollection -SupplementaryLogs <path-to-share> -ShareCredentail $shareCredential
228-
```
229-
230-
## Provide required information in a support case
231-
232-
If you encounter an issue and need help from Microsoft Support, they might ask for specific information to locate your logs.
233-
234-
You can obtain this information from either the output of the `Send-DiagnosticData` cmdlet or directly from the problematic page in the Azure portal.
235-
236-
### Provide information from the `Send-DiagnosticData` output
237-
238-
When you use `Send-DiagnosticData` to collect logs, it also provides key details in its output that you need to share with Microsoft Support. After you collect logs, they're sent to the Kusto database. Microsoft Support can then use the information provided to locate your logs in Kusto and help you in resolving the reported issue.
222+
If you have outbound connectivity from the SMB share where you saved the logs, you can run the following command to send the logs to Microsoft:
239223

240-
When requested, share the following information with Microsoft Support. Get this information from the `Send-DiagnosticData` output.
241-
242-
- `AEORegion`: The location where your device is registered.
243-
- `AEODeviceARMResourceUri`: A unique identifier to locate the resource, for example: `/subscriptions/<subscription GUID>/resourceGroups/<Name of Resource group>/providers/Microsoft.AzureStackHCI/clusters/<Name of Cluster>`.
244-
- `AEOClusterNodeArcResourceUri`: A unique identifier to locate the ARC resource, for example: `/subscriptions/<subscription GUID>/resourceGroups/<Name of Resource group>/providers/Microsoft.HybridCompute/Machines/<machine name>`.
245-
- `CorrelationId`: A unique identifier to locate the logs.
246-
247-
### Provide information from the Azure portal page where issue occurs
248-
249-
On the problematic page in the Azure portal, press CTRL+ALT+A to download a diagnostic file with the following information: session ID and the URL. In most cases, this information is sufficient to get Microsoft Support started on troubleshooting.
250-
251-
If you're on any of the Azure Stack HCI blades where you're experiencing issues, the current URI has the resource ID needed to debug the service.
224+
```powershell
225+
Send-DiagnosticData NoLogCollection -SupplementaryLogs <path-to-share> -ShareCredentail $shareCredential
226+
```
252227

253228
## `Send-DiagnosticData` command reference
254229

@@ -608,8 +583,8 @@ The following roles are available for filtering by the **FilterByRole** paramete
608583
| HostNetwork | Logs used to troubleshoot Network ATC, the underlying operating system component used to configure host networking. |
609584
| MOC_ARB | Management stack that enables cloud-based management of virtual machines on Azure Stack HCI and Windows Server. |
610585
| NC | Information related to the network infrastructure. |
611-
| ObservabilityLogmanTraces | Collects logs for Observability traces. These logs help with troubleshooting issues with sending diagnostic data. |
612-
| ObservabilityVolume | Collects logs for Observability volume. |
586+
| ObservabilityLogmanTraces | Collects logs for the observability traces. These logs help with troubleshooting issues with sending diagnostic data. |
587+
| ObservabilityVolume | Collects logs for the observability volume. |
613588
| OEMDiagnostics | Collects logs for OEM diagnostics, which can help to identify and resolve issues with your server hardware, such as BIOS, drivers, sensors, and more. |
614589
| OSUpdateLogs | Role that collects logs related to operating system updates on Azure Stack HCI nodes, useful for troubleshooting update-related issues. |
615590
| RemoteSupportAgent | Logs that help troubleshoot issues with remote support sessions, which are used to address customer support cases. |
@@ -618,6 +593,29 @@ The following roles are available for filtering by the **FilterByRole** paramete
618593

619594
---
620595

596+
## Provide required information in a support case
597+
598+
If you encounter an issue and need help from Microsoft Support, they might ask for specific information to locate your logs.
599+
600+
You can obtain this information directly from the problematic page in the Azure portal or from the output of the `Send-DiagnosticData` cmdlet.
601+
602+
### Provide information from the Azure portal page where issue occurs
603+
604+
On the problematic page in the Azure portal, press CTRL+ALT+A to download a diagnostic file with the following information: session ID and the URL. In most cases, this information is sufficient to get Microsoft Support started on troubleshooting.
605+
606+
If you're on any of the Azure Stack HCI blades where you're experiencing issues, the current URI has the resource ID needed to debug the service.
607+
608+
### Provide information from the `Send-DiagnosticData` output
609+
610+
When you use `Send-DiagnosticData` to collect logs, it also provides key details in its output that you need to share with Microsoft Support. After you collect logs, they're sent to the Kusto database. Microsoft Support can then use the information provided to locate your logs in Kusto and help you in resolving the reported issue.
611+
612+
When requested, share the following information with Microsoft Support. Get this information from the `Send-DiagnosticData` output.
613+
614+
- `AEORegion`: The location where your device is registered.
615+
- `AEODeviceARMResourceUri`: A unique identifier to locate the resource, for example: `/subscriptions/<subscription GUID>/resourceGroups/<Name of Resource group>/providers/Microsoft.AzureStackHCI/clusters/<Name of Cluster>`.
616+
- `AEOClusterNodeArcResourceUri`: A unique identifier to locate the ARC resource, for example: `/subscriptions/<subscription GUID>/resourceGroups/<Name of Resource group>/providers/Microsoft.HybridCompute/Machines/<machine name>`.
617+
- `CorrelationId`: A unique identifier to locate the logs.
618+
621619
## Next steps
622620

623621
- [Contact Microsoft Support](get-support.md)

0 commit comments

Comments
 (0)