Skip to content

Commit 206fd8d

Browse files
committed
Updated text and images
1 parent e0d7a10 commit 206fd8d

File tree

8 files changed

+532
-592
lines changed

8 files changed

+532
-592
lines changed
143 KB
Loading
-20.2 KB
Loading

azure-local/concepts/telemetry-and-diagnostics-overview.md

Lines changed: 60 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ ms.author: robess
66
ms.topic: conceptual
77
ms.service: azure-local
88
ms.reviewer: shisab
9-
ms.date: 10/22/2024
10-
11-
# CustomerIntent: As a content writer for Azure Local, I want to share viable information on the telemetry and diagnostics extension that will help users understand the feature and ways they can benefit from using it.
9+
ms.date: 06/18/2025
1210
---
1311
# Azure Local telemetry and diagnostics extension
1412

@@ -18,12 +16,20 @@ This article provides a brief overview, benefits, and available options for the
1816

1917
## About the extension
2018

21-
The Telemetry and Diagnostics Arc extension (shown as AzureEdgeTelemetryAndDiagnostics in the Azure portal) enables the collection of telemetry and diagnostics information from your Azure Local instance. This information helps Microsoft gain valuable insights into the system's behavior.
19+
The Telemetry and Diagnostics Arc extension, shown as AzureEdgeTelemetryAndDiagnostics in the Azure portal, enables the collection of telemetry and diagnostics information from your Azure Local instance. This data provides Microsoft with valuable insights into the system's behavior.
20+
21+
:::image type="content" source="../concepts/media/telemetry-and-diagnostics-overview/telemetry-diagnostics-extension-1.png" alt-text="Screenshot of the Telemetry and Diagnostics extension in the Azure portal." lightbox="../concepts/media/telemetry-and-diagnostics-overview/telemetry-diagnostics-extension-1.png":::
2222

23-
Use the telemetry and diagnostics extension to monitor and assess the performance, functionality, and overall health of your Azure Local. Microsoft can also use the diagnostics information from this extension to troubleshoot and address any potential issues in your system.
23+
Use the telemetry and diagnostics extension to monitor and assess the performance, functionality, and overall health of your Azure Local environment. The diagnostic information collection through this extension helps Microsoft more effectively troubleshoot and address any potential issues in your system.
2424

2525
For more information, see [Azure Arc extension management on Azure Local](../manage/arc-extension-management.md#azure-managed-extensions-in-azure-local).
2626

27+
## Prerequisites
28+
29+
To use the telemetry and diagnostics extension, you must have:
30+
31+
- An Azure Local instance deployed and running.
32+
2733
## Benefits
2834

2935
Some of the advantages of the telemetry and diagnostics extension include:
@@ -32,38 +38,30 @@ Some of the advantages of the telemetry and diagnostics extension include:
3238

3339
- **Simplified log gathering and faster case resolution:** Lets you easily collect diagnostics logs. These logs are used by Microsoft Support and engineering team to resolve any system issues quickly.
3440

35-
- **Reduced update impact:** Allows non-disruptive update of your Azure Local instance and doesn't require a reboot of the host machine.
41+
- **Reduced update impact:** Allows nondisruptive update of your Azure Local instance and doesn't require a reboot of the host machine.
3642

3743
- **Resource consumption controls:** Ensures that no more than 5% CPU is consumed. Control of the process is enforced via the Azure Arc extension framework.
3844

39-
## Telemetry and diagnostics settings
40-
41-
You maintain control over whether you send telemetry data to Microsoft, even after you've installed and run the telemetry extension.
42-
43-
To access the options to send telemetry data, follow these steps:
44-
45-
1. Go to your Azure Local resource in the Azure portal. In the left-pane, go to **Settings** and then select **Extensions**.
46-
47-
:::image type="content" source="media/telemetry-and-diagnostics-overview/telemetry-diagnostics-extension-1.png" alt-text="Screenshot of the extension settings screen." lightbox="media/telemetry-and-diagnostics-overview/telemetry-diagnostics-extension-1.png":::
48-
49-
2. Choose one of the following options for sharing telemetry data:
50-
51-
- **Off:** Select this option to not send system data to Microsoft.
45+
## Diagnostic data collection
5246

53-
- **Basic:** Select this option to send Microsoft the minimum system data required to keep systems current, secure, and operating properly.
47+
To identify and fix issues with your Azure Local solution, you can collect and send diagnostic logs to Microsoft using one of the following methods:
5448

55-
- **Enhanced:** Select this option to send more system data to help Microsoft identify and fix operational issues and for product improvements. We strongly recommend that you enable **enhanced diagnostics**.
49+
- `Send-DiagnosticData`
50+
- The Azure portal
5651

57-
Some of the benefits of enhanced data sharing include:
52+
To manually collect and send diagnostic logs to Microsoft, use the `Send-DiagnosticData` cmdlet from any Azure Local machine. We recommend that you use this cmdlet to upload diagnostic data before opening a support case.
5853

59-
- Retention of system data for up to a month.
60-
- Automatic capture of error and diagnostics information for speedier issue resolution. No operator intervention is required.
54+
For more information, see [Collect diagnostic logs](../manage/collect-logs.md).
6155

62-
## Diagnostic data collection
56+
To collect and send diagnostic logs to Microsoft using the Azure portal, follow these steps:
6357

64-
To identify and fix issues with your Azure Local solution, you can collect and send diagnostic logs to Microsoft. To manually collect and send diagnostic logs to Microsoft, use the `Send-DiagnosticData` cmdlet from any Azure Local machine. We recommend that you use this cmdlet to upload diagnostic data before opening a support case.
58+
1. In the Azure portal, navigate to your Azure Local instance.
59+
1. In the left pane, under **Settings**, select **Diagnostics and Remote Support**.
60+
1. Select **Send logs**.
61+
1. In the Diagnostics pane, set your **Log start time** and **Log end time**.
62+
1. Click the **Collect and upload logs** button.
6563

66-
For more information, see [Collect diagnostic logs](../manage/collect-logs.md).
64+
:::image type="content" source="../concepts/media/telemetry-and-diagnostics-overview/send-logs-azure-portal.png" alt-text="Screenshot of the steps to collect and send diagnostics logs via the Azure portal." lightbox="../concepts/media/telemetry-and-diagnostics-overview/send-logs-azure-portal.png":::
6765

6866
## Data collection consent
6967

@@ -83,34 +81,41 @@ Azure Local routes system data back to a protected cloud storage location. Only
8381

8482
Don't include any confidential information or personal information in resource or file names. For example, VM names, volume names, configuration file names, storage file names (VHD names), or system resource names.
8583

86-
## Error handling
87-
88-
The following section discusses the error codes, messages and suggested resolution for any issues that you may experience with the telemetry and diagnostics extension:
89-
90-
### Error code 1
91-
92-
**Error message:** An unhandled exception has occurred.
93-
94-
**Cause:** If an unhandled exception occurs, an error message is displayed. You can find the complete error message and its stack trace in the Extension logs.
95-
96-
**Suggested resolution:** Check the generic error message and contact Microsoft Support. Collect the logs from the following path and provide these logs to Microsoft Support:
97-
`C:\ProgramData\GuestConfig\extension_logs\Microsoft.AzureStack.Observability.TelemetrAndDiagnostics\ObservabilityExtension.log`.
98-
99-
### Error code 9
100-
101-
**Error message:** There's insufficient disk space available on the drive. To proceed with the extension installation, delete some files to free up space.
102-
103-
**Cause:** The extension validates as a pre-installation step and requires a minimum of 20 GB of space for the GMA cache on the system drive. If the drive doesn't have enough space, the extension raises an error message for this issue.
104-
105-
**Suggested resolution:** Free up the disk space to allow the extension to continue.
106-
107-
### Error code 12
108-
109-
**Error message:** The extension can't create the tenant JSON configuration files if either the `Get-AzureStackHCI` or `Get-ClusterNode` cmdlet isn't available to retrieve the necessary information.
110-
111-
**Cause:** The extension uses the `Get-AzureStackHCI` and `Get-ClusterNode` cmdlets to identify parameters and retrieve information needed to create the tenant JSONs. If these cmdlets aren't present, the extension raises an error message with an indication that it can't proceed without them.
112-
113-
**Suggested resolution:** Verify Azure Local registration.
84+
## Test observability
85+
86+
Test Observability is a feature designed to diagnose issues related to the telemetry and diagnostics extension. This feature ensures the proper functionality of the data transmission pipeline to Microsoft. It validates the existence and accuracy of configuration files, checks the status of relevant services, and confirms endpoint connectivity.
87+
88+
Here's sample output:
89+
90+
```output
91+
Test-Observability Report
92+
Overall Result: PASS
93+
General Information
94+
GCSEnvironment: DiagnosticsPROD
95+
GCSGenevaAccount: AzureEdgeObsPPE
96+
GCSNamespace: AEOppeDiag
97+
AEOAssemblyBuild: 99.9999.0.2
98+
AEOClusternodeName: V-HOST1
99+
AEONodeid: cluster-test1
100+
AEOClusterNodeARCResourceUri: /Subscription/<subscriptionid>/
101+
AEODeviceArmResourceUri: /Subscription/<subscriptionid>/
102+
AEORegion: westeurope
103+
AEOStampid: cluster-test1
104+
AEOClusterName: my-cluster
105+
AEOOSBuild: 10.0.25398.763
106+
Test Name: TestTenantJSON
107+
Overall Result: PASS
108+
Has Repair Action: No
109+
Repair Description: N/A
110+
```
111+
112+
## Support operations
113+
114+
You can grant remote access to Microsoft support by using remote support operations. After enabling remote support, assign a specific access level to Microsoft support based on your requirements. For more information, see [Enable remote support diagnostics](../manage/get-remote-support.md#enable-remote-support-diagnostics) and the [List of Microsoft support operations](../manage/remote-support-arc-extension.md#list-of-microsoft-support-operations).
115+
116+
## Troubleshoot telemetry and diagnostic errors
117+
118+
For information on troubleshootings Arc extension errors, see [Troubleshoot Arc extensions on Azure Local](../manage/troubleshoot-arc-enabled-extensions.md).
114119

115120
## Next step
116121

azure-local/manage/arc-extension-management.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: robess
66
ms.topic: how-to
77
ms.custom: devx-track-azurecli, devx-track-azurepowershell
88
ms.reviewer: arduppal
9-
ms.date: 10/22/2024
9+
ms.date: 06/18/2025
1010
---
1111

1212
# Azure Arc extension management on Azure Local
@@ -17,7 +17,7 @@ This article describes how to install, upgrade, and manage Azure Arc extensions
1717

1818
## Customer-managed Azure Arc extensions on Azure Local
1919

20-
You can install, uninstall and update Azure Arc extensions on your Azure Local. Azure Arc lets you run hybrid services like monitoring and Windows Admin Center in the Azure portal.
20+
You can install, uninstall, and update Azure Arc extensions on your Azure Local. Azure Arc lets you run hybrid services like monitoring and Windows Admin Center in the Azure portal.
2121

2222
Here are the individual extensions you can install and manage.
2323

@@ -45,7 +45,7 @@ You can install extensions from the **Capabilities** tab for your Azure Local Ar
4545
When you install an extension in the Azure portal, it's a cluster-aware operation. The extension is installed on all nodes of the system. If you add more nodes to your system, all the extensions installed on your system are automatically added to the new servers.
4646

4747
### [Azure CLI](#tab/azurecli)
48-
Azure CLI is available to install in Windows, macOS and Linux environments. It can also be run in Azure Cloud Shell. For more information, refer [Quickstart for Azure Cloud Shell](/azure/cloud-shell/quickstart).
48+
Azure CLI is available to install in Windows, macOS, and Linux environments. It can also be run in Azure Cloud Shell. For more information, refer [Quickstart for Azure Cloud Shell](/azure/cloud-shell/quickstart).
4949

5050
Launch [Azure Cloud Shell](https://shell.azure.com/) and use Bash to install an extension following these steps:
5151
1. Set up parameters from your subscription, resource group, and clusters
@@ -107,7 +107,7 @@ Launch [Azure Cloud Shell](https://shell.azure.com/) and use Bash to install an
107107
done
108108
```
109109
110-
1. To install the Azure Site Recovery extension on all the systems under the resource group run the following command:
110+
1. To install the Azure Site Recovery extension on all the systems under the resource group, run the following command:
111111
```azurecli
112112
asrSubscription="00000000-0000-0000-0000-000000000000" # Replace with your ASR subscription ID
113113
asrResourceGroup="asr-rg" # Replace with your ASR resource group
@@ -253,7 +253,7 @@ You can check the status of an extension on each server from the **Extensions**
253253
:::image type="content" source="media/arc-extension-management/arc-extension-status-view.png" alt-text="Screenshot of the different extension statuses in the Azure portal." lightbox="media/arc-extension-management/arc-extension-status-view.png":::
254254
255255
### [Azure CLI](#tab/azurecli)
256-
Azure CLI is available to install in Windows, macOS and Linux environments. It can also be run in Azure Cloud Shell. For more information, refer [Quickstart for Azure Cloud Shell](/azure/cloud-shell/quickstart).
256+
Azure CLI is available to install in Windows, macOS, and Linux environments. It can also be run in Azure Cloud Shell. For more information, refer [Quickstart for Azure Cloud Shell](/azure/cloud-shell/quickstart).
257257
258258
Launch [Azure Cloud Shell](https://shell.azure.com/) and use Bash to check the status of an extension following these steps:
259259
@@ -316,7 +316,7 @@ Launch [Azure Cloud Shell](https://shell.azure.com/) and use PowerShell to check
316316
317317
## How the extension upgrade works
318318
319-
When published by the extension publisher team, the extension upgrade process replaces the existing extension version with a newly supported one. By default, the automatic extension upgrade feature is enabled for all extensions deployed on Azure Local Arc-enabled clusters unless you explicitly opt-out of automatic upgrades.
319+
When published by the extension publisher team, the extension upgrade process replaces the existing extension version with a newly supported one. By default, the automatic extension upgrade feature is enabled for all extensions deployed on Azure Local Arc-enabled clusters unless you explicitly opt out of automatic upgrades.
320320
321321
Currently, automatic extension upgrades are only supported in the Windows Admin Center extension, but more extensions will be added in the future.
322322
@@ -341,7 +341,7 @@ To enable an automatic upgrade, navigate to the **Extensions** page and perform
341341
:::image type="content" source="media/arc-extension-management/arc-extension-enable-auto-upgrade-2.png" alt-text="Screenshot of the notification to enable auto upgrade in the Azure portal." lightbox="media/arc-extension-management/arc-extension-enable-auto-upgrade-2.png":::
342342
343343
### [Azure CLI](#tab/azurecli)
344-
To install and enable auto upgrade for a specific extension like `AzureMonitorWindowsAgent` run the following command:
344+
To install and enable auto upgrade for a specific extension like `AzureMonitorWindowsAgent`, run the following command:
345345
346346
```azurecli
347347
clusterName="HCICluster" # Replace with your cluster name
@@ -362,7 +362,7 @@ az stack-hci extension create \
362362
```
363363

364364
### [Azure PowerShell](#tab/azurepowershell)
365-
To install and enable auto upgrade for a specific extension like `AzureMonitorWindowsAgent` run the following command:
365+
To install and enable auto upgrade for a specific extension like `AzureMonitorWindowsAgent`, run the following command:
366366

367367
```powershell
368368
$clusterName = "HCICluster" # Replace with your cluster name
@@ -458,7 +458,7 @@ If desired, you can uninstall some extensions from your Azure Local in the Azure
458458

459459
### [Azure CLI](#tab/azurecli)
460460

461-
To remove a specific extension like `AzureMonitorWindowsAgent` run the following command:
461+
To remove a specific extension like `AzureMonitorWindowsAgent`, run the following command:
462462
```azurecli
463463
extensionName="AzureMonitorWindowsAgent" # Replace with the extension name
464464
resourceGroup="hcicluster-rg" # Replace with your resource group name
@@ -472,7 +472,7 @@ az stack-hci extension delete \
472472
```
473473

474474
### [Azure PowerShell](#tab/azurepowershell)
475-
To remove a specific extension like `AzureMonitorWindowsAgent` run the following command:
475+
To remove a specific extension like `AzureMonitorWindowsAgent`, run the following command:
476476
```powershell
477477
$clusterName = "HCICluster" # Replace with your cluster name
478478
$resourceGroup = "hcicluster-rg" # Replace with your resource group name
@@ -485,17 +485,8 @@ Remove-AzStackHciExtension `
485485
-ArcSettingName "default" `
486486
-Name "${extensionName}"
487487
```
488-
---
489-
490-
## Troubleshooting extension errors
491-
492-
**Extension Status**: Failed
493488

494-
:::image type="content" source="media/arc-extension-management/arc-extension-troubleshoot-extension-1.png" alt-text="Screenshot of how to troubleshoot an extension in the Azure portal." lightbox="media/arc-extension-management/arc-extension-troubleshoot-extension-1.png":::
495-
496-
**Recommendation**: For an extension with a failed status, select the **Failed (View details)** link. View all the information about the failure and apply the troubleshooting tips.
497-
498-
:::image type="content" source="media/arc-extension-management/arc-extension-troubleshoot-extension-2.png" alt-text="Screenshot of tips to troubleshoot a failed extension." lightbox="media/arc-extension-management/arc-extension-troubleshoot-extension-2.png":::
489+
---
499490

500491
## Next step
501492

0 commit comments

Comments
 (0)