Collect diagnostic logs for Azure Stack HCI (preview)

Applies to: Azure Stack HCI, version 23H2

This article describes how to collect diagnostic logs for Azure Stack HCI and send them to Microsoft via the Azure portal or PowerShell. These diagnostic logs help identify and fix any issues with your Azure Stack HCI solution.

Important

This feature is currently in PREVIEW. See the Supplemental Terms of Use for Microsoft Azure Previews for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

About on-demand log collection

On-demand log collection refers to the process of manually gathering and sending diagnostic logs to Microsoft. These logs are stored in the Kusto database, where Microsoft Support can access them to help resolve your reported issues. The collected diagnostic data is retained for up to 30 days and is managed according to Microsoft’s standard privacy practices.

When to use on-demand log collection

You can perform on-demand log collection in the following scenarios:

  • When Microsoft Support requests logs for an open case
  • When a cluster is connected and registered
  • When observability components are operational and installed
  • When a cluster is only partially registered
  • For issues unrelated to registration failures

For more information on other log collection methods in Azure Stack HCI and their appropriate use cases, see Diagnostics.

Prerequisites

Before you collect on-demand logs, you must complete the following prerequisites:

  • You must have access to an Azure Stack HCI cluster that is deployed and registered.
  • You must have installed the AzureEdgeTelemetryAndDiagnostics extension to collect telemetry and diagnostics information from your Azure Stack HCI system. For information about the extension, see Azure Stack HCI telemetry and diagnostics extension overview.

Collect logs for Azure Stack HCI

You can perform on-demand log collection using any of the following methods:

  • (Recommended) The Azure portal. Use this method when you want to collect and send logs at the cluster level.

  • 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 roles only.

Keep in mind the following information before you start log collection:

  • The time required for log collection depends on the time range you specify. The longer the time range, the more time it'll take for log collection. Therefore, we recommend limiting the time range to only the logs you need.
  • Log collections longer than 24 hours aren't supported.
  • Attempting multiple log collections simultaneously will result in a failure.

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

  1. In the Azure portal, go to the Azure Stack HCI cluster resource.

  2. In the left pane, under Settings, select Diagnostics and Remote Support.

  3. To collect and send logs now, select Send logs.

    Screenshot shows the Send logs button.

  4. In the Send diagnostic logs to Microsoft pane, select the Log start time and Log end time, and then select the Collect and upload logs button.

    Screenshot shows the Send logs pane.

    You get a notification that it can take up to 30 minutes to collect diagnostic logs.

  5. The Log activity table shows the status of log collections. For more details on a specific log collection, select the link under Time collected and review the details in the Log detail pane. If you encounter an issue and need help from Microsoft Support, they might request the Correlation ID to locate the logs.

    Screenshot shows the Log details pane.

Provide required information in a support case

If you encounter an issue and need help from Microsoft Support, they might ask for specific information to locate your logs.

Follow these steps to provide the required information in the Azure portal:

  1. In the Diagnostics tab, under Log activity, select the link under Time collected for the relevant log collection.

  2. In the Log detail pane, note the value of Correlation ID, and share it with Microsoft Support for troubleshooting purposes.

    Screenshot shows the Log details pane.

Next steps