Skip to content

Commit fdea16a

Browse files
Merge pull request #18232 from ronmiab/rb-shireen-2
Remote support - Updated text and images
2 parents c45aacc + 95c571d commit fdea16a

10 files changed

+627
-642
lines changed
143 KB
Loading
-20.2 KB
Loading

azure-local/concepts/observability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The following table describes the types of data, their storage location, default
104104

105105
| Types Of data | Description | Data storage location | Default setting | Retention period | How data can be viewed |
106106
|--|--|--|--|--|--|
107-
| Telemetry | Telemetry data includes performance metrics, usage patterns, and other information related to user behavior and system health. It doesn't contain any personally identifiable information. | Telemetry data is always stored within the US. | It is enabled by default. To change the default setting, see [Telemetry and diagnostics settings](./telemetry-and-diagnostics-overview.md#telemetry-and-diagnostics-settings). | The data is retained for up to two years. | You can view data in \\\\\<NodeName>\c$\GMACache\TelemetryCache\Tables/\*.tsf. |
107+
| Telemetry | Telemetry data includes performance metrics, usage patterns, and other information related to user behavior and system health. It doesn't contain any personally identifiable information. | Telemetry data is always stored within the US. | It is enabled by default. For more information on telemetry, see [Telemetry and diagnostics overview](./telemetry-and-diagnostics-overview.md). | The data is retained for up to two years. | You can view data in \\\\\<NodeName>\c$\GMACache\TelemetryCache\Tables/\*.tsf. |
108108
| Diagnostics | Diagnostics data helps Microsoft detect, diagnose, and fix problems to restore service health and improve products. | Diagnostics data is stored either globally or in the EU, based on the customer’s deployment choice. | Various methods exist to transmit diagnostic data. For details, see [Diagnostics](#diagnostics)| Typically retained for 30 days, potentially longer for ongoing support issues. | You can view data in the `C:\observability` folder of every machine. |
109109
| Metrics | Metrics are numerical values collected at regular intervals, describing aspects of a system. | Metrics data is sent to the respective region in which resource is deployed. | Enabled by default and can be disabled anytime. | Platform metrics are stored for 93 days, however, you can only query (in the Metrics tile) for a maximum of 30 days' worth of data on any single chart. | You can use metrics explorer to interactively analyze the data in your metric database. |
110110
| Billing and census | Billing data includes the system ID and the number of physical cores and hours used. Census data is required to enable basic management from Azure and includes system information (system name and ID, system connection status, storage pool ID, trial days remaining and billing model), machine information (number of machines, machine name, OS version, machine manufacturer, model and serial number, number of physical cores and memory size), and basic configuration such as, enablement of Azure verification for VMs, Azure managed identity and diagnostics level setting. | Billing and census data is sent to the respective resource region where the customer registered the device. | Billing is always enabled as it is required to charge for Azure Local usage. Census data is also always enabled, as it includes the minimal information required to manage Azure Local from Azure. | Data is deleted when the resource is deleted, except for billing data, which is retained. | To view billing data, navigate to the Azure Local system resource page in Azure portal, select **Overview** in the left pane, in the Essentials section select the **Billing status** link, followed by **View Cost Management**. To view census data, select **JSON View** located in the top right corner of the Essentials section. |

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

Lines changed: 59 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -6,111 +6,110 @@ ms.author: robess
66
ms.topic: how-to
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: 07/31/2025
1210
---
1311
# Azure Local telemetry and diagnostics extension
1412

1513
[!INCLUDE [applies-to](../includes/hci-applies-to-23h2-22h2.md)]
1614

17-
This article provides a brief overview, benefits, and available options for the telemetry and diagnostics extension used for your Azure Local.
15+
This article gives an overview, lists benefits, and describes options for the telemetry and diagnostics extension in Azure Local.
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.
22-
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.
24-
25-
For more information, see [Azure Arc extension management on Azure Local](../manage/arc-extension-management.md#azure-managed-extensions-in-azure-local).
26-
27-
## Benefits
28-
29-
Some of the advantages of the telemetry and diagnostics extension include:
30-
31-
- **Improved compliance:** Enables the telemetry and diagnostics data to comply with regional service and data residency requirements during data uploads.
32-
33-
- **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.
34-
35-
- **Reduced update impact:** Allows non-disruptive update of your Azure Local instance and doesn't require a reboot of the host machine.
36-
37-
- **Resource consumption controls:** Ensures that no more than 5% CPU is consumed. Control of the process is enforced via the Azure Arc extension framework.
38-
39-
## Telemetry and diagnostics settings
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.
4020

41-
You maintain control over whether you send telemetry data to Microsoft, even after you've installed and run the telemetry extension.
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":::
4222

43-
To access the options to send telemetry data, follow these steps:
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.
4424

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":::
25+
For more information, see [Azure Arc extension management on Azure Local](../manage/arc-extension-management.md#azure-managed-extensions-in-azure-local).
4826

49-
2. Choose one of the following options for sharing telemetry data:
27+
### Test observability
28+
29+
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.
30+
31+
Here's sample output:
32+
33+
```output
34+
Test-Observability Report
35+
Overall Result: PASS
36+
General Information
37+
GCSEnvironment: DiagnosticsPROD
38+
GCSGenevaAccount: AzureEdgeObsPPE
39+
GCSNamespace: AEOppeDiag
40+
AEOAssemblyBuild: 99.9999.0.2
41+
AEOClusternodeName: V-HOST1
42+
AEONodeid: cluster-test1
43+
AEOClusterNodeARCResourceUri: /Subscription/<subscriptionid>/
44+
AEODeviceArmResourceUri: /Subscription/<subscriptionid>/
45+
AEORegion: westeurope
46+
AEOStampid: cluster-test1
47+
AEOClusterName: my-cluster
48+
AEOOSBuild: 10.0.25398.763
49+
Test Name: TestTenantJSON
50+
Overall Result: PASS
51+
Has Repair Action: No
52+
Repair Description: N/A
53+
```
5054

51-
- **Off:** Select this option to not send system data to Microsoft.
55+
## Benefits
5256

53-
- **Basic:** Select this option to send Microsoft the minimum system data required to keep systems current, secure, and operating properly.
57+
Some advantages of the telemetry and diagnostics extension include:
5458

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**.
59+
- **Improved compliance:** Lets telemetry and diagnostics data comply with regional service and data residency requirements during data uploads.
5660

57-
Some of the benefits of enhanced data sharing include:
61+
- **Simplified log gathering and faster case resolution:** Lets you easily collect diagnostics logs. Microsoft Support and the engineering team use these logs to fix system issues quickly.
5862

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.
63+
- **Reduced update impact:** Lets you update your Azure Local instance without disruption and doesn't require a reboot of the host machine.
6164

62-
## Diagnostic data collection
65+
- **Resource consumption controls:** Makes sure that no more than 5 percent CPU is used. The Azure Arc extension framework enforces control of the process.
6366

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.
67+
## Prerequisites
6568

66-
For more information, see [Collect diagnostic logs](../manage/collect-logs.md).
69+
To use the telemetry and diagnostics extension, make sure you have an Azure Local instance is deployed and running.
6770

6871
## Data collection consent
6972

7073
Microsoft collects data in accordance with its [standard privacy practices](https://privacy.microsoft.com/). The new telemetry agent doesn't override your existing control setting.
7174

7275
If you withdraw your consent for data collection, any data collected before withdrawal isn't affected. Microsoft continues to handle and use the data collected in accordance with the terms that were in place at the time of the data collection.
7376

74-
Here are a couple of things to consider with data collection:
77+
Consider these points about data collection:
7578

76-
- Understand how Microsoft handles and uses your data. Review Microsoft's privacy practices and policies.
79+
- Learn how Microsoft handles and uses your data. Review Microsoft's privacy practices and policies.
7780

78-
- Understand the implications of consenting to data collection and the withdrawal of consent. Consult with legal or privacy professionals to ensure complete understanding.
81+
- Learn the implications of consenting to data collection and withdrawing consent. Consult legal or privacy professionals to make sure you understand.
7982

8083
### Data privacy considerations
8184

8285
Azure Local routes system data back to a protected cloud storage location. Only Microsoft personnel with a valid business need are given access to the system data. Microsoft doesn't share personal customer data with third parties, except at the customer's discretion or for the limited purposes described in the [Microsoft Privacy Statement](https://privacy.microsoft.com/privacystatement). Data sharing decisions are made by an internal Microsoft team including privacy, legal, and data management stakeholders.
8386

8487
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.
8588

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.
89+
## Diagnostic data collection
9590

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`.
91+
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:
9892

99-
### Error code 9
93+
- `Send-DiagnosticData`
94+
- The Azure portal
10095

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.
96+
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.
10297

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.
98+
For more information, see [Collect diagnostic logs](../manage/collect-logs.md).
10499

105-
**Suggested resolution:** Free up the disk space to allow the extension to continue.
100+
To collect and send diagnostic logs to Microsoft using the Azure portal, follow these steps:
106101

107-
### Error code 12
102+
1. In the Azure portal, navigate to your Azure Local instance.
103+
1. In the left pane, under **Settings**, select **Diagnostics and Remote Support**.
104+
1. Select **Send logs**.
105+
1. In the Diagnostics pane, set your **Log start time** and **Log end time**.
106+
1. Select the **Collect and upload logs** button.
108107

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.
108+
:::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":::
110109

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.
110+
## Support operations
112111

113-
**Suggested resolution:** Verify Azure Local registration.
112+
You can grant remote access to Microsoft support by using remote support operations. After you enable 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).
114113

115114
## Next step
116115

0 commit comments

Comments
 (0)