Merge pull request #10060 from MicrosoftDocs/UpdateAGDiag_w_SQLLogScout_pijocoder_102825

AB#8078: Update with SQL LogScout info

Author: haywoodsloan

support/sql/database-engine/availability-groups/media/use-agdiag-diagnose-availability-group-health-events/launch-sql-log-scout-powershell.png

@@ -1,76 +1,106 @@
 ---
-title: Use AGDiag to diagnose availability group health events
-description: This article describes how to use AGDiag to diagnose availability group health events.
+title: Use AGDiag to Diagnose Availability Group Health Events
+description: This article discusses how to use AGDiag to diagnose availability group health events.
 ms.date: 05/15/2023
 ms.custom: sap:Always On Availability Groups (AG)
-ms.reviewer: cmathews, v-sidong
+ms.reviewer: cmathews, v-sidong, v-shaywood
 ---
 # Use AGDiag to diagnose availability group health events
 
 > [!NOTE]
-> To diagnose Always On availability group health issues that trigger availability group failover, see [Troubleshoot Always On Availability Groups failover](troubleshooting-availability-group-failover.md).
+> To diagnose Always On availability group health issues that trigger availability group failover, see [Troubleshoot Always On Availability Groups failover](./troubleshooting-availability-group-failover.md).
 
-AGDiag is an application that automates the manual analysis described in the article (mentioned in the **Note** section). It analyzes the cluster log and correlates and reports pertinent events from the other logs (SQL Server error logs, Windows event logs, and so on). It generates a summary report of Windows Cluster and Always On health events and then provides more detailed analysis results for each health event detected. It automates much of the work described in the article (mentioned in the **Note** section) when the proper logs are provided from the availability group primary replica at the time of the health event.
+AGDiag is an application that automates the manual analysis of cluster logs, and correlates and reports pertinent events from the other logs (SQL Server error logs, Windows event logs, and so on). AGDiag generates a summary report of Windows Cluster and Always On health events, and provides more detailed analysis results for each health event that's detected. It also automates much of its work when you provide the appropriate logs from the availability group primary replica at the time of the health event.
 
-## Use TSS to generate logs for AGDiag to diagnose
+## Generate logs for AGDiag to diagnose
 
-To diagnose an availability group health event, use the TSS to collect logs on the SQL Server instance that was in the primary role at the time of the event.
+You can use various methods to generate the logs that AGDiag takes as inputs. AGDiag relies on the following base logs to do analysis:
 
-Follow these steps to accomplish this goal:
+- Windows Cluster Diagnostic logs
+- SQL Server Error logs
+- Windows System Event logs
+- System Health Extended Events (XEL) files
+- AlwaysOn Health Session XEL files
 
-1. Download the toolset ([TSSv2.zip](https://aka.ms/getTSS)) as a zip file. For more information, see [Introduction to TroubleShootingScript toolset (TSSv2)](../../../windows-client/windows-troubleshooters/introduction-to-troubleshootingscript-toolset-tssv2.md).
+As an alternative method to manually collecting these logs, you can use either of the following log collection tools to capture them:
 
-1. Save and extract the zip file to a folder on the SQL Server instance that hosted the availability group primary replica when the failover started or the availability group was resolving.
+- LogScout
+- TSS
 
-1. Open an elevated command prompt, change the directory to the TSS folder where the zip file *TSSv2.zip* was saved and extracted, run `TSS SDP:SQLBase`, and respond to the prompts.
+### Use SQL LogScout to capture logs for AGDiag analysis
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/command-prompt-tss.png" alt-text="Screenshot of the elevated command prompt changing the directory to the TSS folder." lightbox="media/use-agdiag-diagnose-availability-group-health-events/command-prompt-tss.png":::
+To diagnose an availability group health event, use SQL LogScout to collect logs on the SQL Server instance that was in the primary role at the time of the event:
 
-1. Once the TSS SQLBase cab file has been created, extract the cab file into a folder.
+1. Download the latest [SQL LogScout](https://aka.ms/get-sqllogscout) as a .zip file.
+1. Save and extract the .zip file on the computer on which SQL Server hosts the primary replica. This system is where the failover started or the availability group was resolving.
+1. Open an elevated PowerShell Command Prompt window, and change the directory to the SQL LogScout folder in which you extracted the .zip file.
+1. Run the following command to capture the `Basic` scenario, and follow the prompts.
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/extract-tss-sqlbase-cab.png" alt-text="Screenshot of extracting the SQLBase cab file to a folder." lightbox="media/use-agdiag-diagnose-availability-group-health-events/extract-tss-sqlbase-cab.png":::
+   ```PowerShell
+   .\SQL_LogScout.ps1 -Scenario "Basic" -ServerName "<Your_Sql_Instance_Name>"
+   ```
+
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/launch-sql-log-scout-powershell.png" alt-text="Starting SQL LogScout from an elevated PowerShell Command Prompt window.":::
+
+1. When the log capture process finishes, you can point AGDiag to the `\output` folder that was created inside the SQL LogScout folder. This folder contains the logs that are collected by SQL LogScout.
+
+### Use TSS to generate logs for AGDiag to diagnose
+
+Alternatively, you can capture the logs by using TSS on the SQL Server instance that was in the primary role at the time of the event:
+
+1. Download the toolset ([TSSv2.zip](https://aka.ms/getTSS)) as a .zip file. For more information, see [Introduction to TroubleShootingScript toolset (TSSv2)](../../../windows-client/windows-troubleshooters/introduction-to-troubleshootingscript-toolset-tssv2.md).
+
+1. Save and extract the .zip file to a folder on the SQL Server instance that hosted the availability group primary replica when the failover started or the availability group was resolving.
+
+1. Open an elevated Command Prompt window, change the directory to the TSS folder where you saved and extracted the *TSSv2.zip* file, run `TSS SDP:SQLBase`, and respond to the prompts.
+
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/command-prompt-tss.png" alt-text="Using an elevated Command Prompt window to change the directory to the TSS folder." lightbox="media/use-agdiag-diagnose-availability-group-health-events/command-prompt-tss.png":::
+
+1. After TSS creates the SQLBase .cab file, extract the .cab file into a folder.
+
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/extract-tss-sqlbase-cab.png" alt-text="Extracting the SQLBase cab file to a folder." lightbox="media/use-agdiag-diagnose-availability-group-health-events/extract-tss-sqlbase-cab.png":::
 
 ## Download the AGDiag tool
 
 To download AGDiag, follow these steps:
 
 1. Open [Release AGDiag Windows Release October 2021 (signed)](https://github.com/microsoft/agdiag/releases/tag/Win2.0.0.23).
-1. Select the *agdiag.zip* link to download the tool.
+1. Select the **agdiag.zip** link to download the tool.
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-zip-download.png" alt-text="Screenshot of selecting the agdiag.zip link to download the tool." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-zip-download.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-zip-download.png" alt-text="Selecting the agdiag.zip link to download the tool." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-zip-download.png":::
 
-## Launch AGDiag and feed it the unzipped TSS logs
+## Start AGDiag and feed it the unzipped TSS logs
 
-Once the tool is downloaded, follow these steps to launch AGDiag and feed it the unzipped TSS logs:
+After you download the tool, follow these steps to launch AGDiag and feed it the unzipped TSS logs:
 
-1. Extract the zip and double-click *agdiag.exe* to launch AGDiag.
+1. Extract the .zip file, and double-click *agdiag.exe* to start AGDiag.
 
-   A dialog appears like the following one:
+   A dialog box that resembles the following box appears.
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-select-log-folder.png" alt-text="Screenshot of running the AGDiag tool." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-select-log-folder.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-select-log-folder.png" alt-text="Running the AGDiag tool." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-select-log-folder.png":::
 
-1. Select **Select Log Folder**, drill into the folder you extracted the TSS SQL Base CAB files into, and then select **OK**.
+1. Select **Select Log Folder**, drill into the folder that you extracted the TSS SQLBase .cab files into, and then select **OK**.
 
 ## Interpret the AGDiag report
 
-The AGDiag report should be launched in the default system browser. The following illustrations help you interpret the report.
+The default system browser opens the AGDiag report. The following illustrations help you interpret the report:
 
-- The following AGDiag Splash Screen describes AGDiag capabilities and version information:
+- The following AGDiag Splash Screen describes AGDiag capabilities and version information.
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-splash-screen.png" alt-text="Screenshot of the AGDiag Splash Screen." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-splash-screen.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-splash-screen.png" alt-text="AGDiag Splash Screen." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-splash-screen.png":::
 
-- AGDiag reports on the logs analyzed in the initialize section. Select the triangles (highlighted in red boxes in the following image) to expand more detailed information.
+- AGDiag reports on the logs that it analyzes in the initialize section. To see more detailed information, select the triangles (highlighted in red boxes in the following image).
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-report.png" alt-text="Screenshot of the AGDiag reports on the logs." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-report.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/agdiag-report.png" alt-text="The AGDiag reports on the logs." lightbox="media/use-agdiag-diagnose-availability-group-health-events/agdiag-report.png":::
 
-- The summary report lists the availability group health events from the cluster log. Select the numerical link (highlighted in red box in the following image) to jump to a specific health event's detailed report.
+- The summary report lists the availability group health events from the cluster log. To jump to a specific health event's detailed report, select the numerical link (highlighted in red box in the following image).
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/availability-group-health-event-summary-report.png" alt-text="Screenshot of availability group health events." lightbox="media/use-agdiag-diagnose-availability-group-health-events/availability-group-health-event-summary-report.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/availability-group-health-event-summary-report.png" alt-text="Availability group health events." lightbox="media/use-agdiag-diagnose-availability-group-health-events/availability-group-health-event-summary-report.png":::
 
-- There's a detailed report for each health event detected, which includes log findings that correlate to the health event, diagnosis, and recommendations. Select the triangles (highlighted in red boxes in the following image) to expand more detailed information.
+- A detailed report exists for each health event that's detected. This report includes log findings that correlate to the health event, diagnosis, and recommendations. To see more detailed information, select the triangles (highlighted in red boxes in the following image).
 
-   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/alwayson-health-event.png" alt-text="Screenshot of AlwaysOn health events." lightbox="media/use-agdiag-diagnose-availability-group-health-events/alwayson-health-event.png":::
+   :::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/alwayson-health-event.png" alt-text="AlwaysOn health events." lightbox="media/use-agdiag-diagnose-availability-group-health-events/alwayson-health-event.png":::
 
-## Known issues with AGDiag
+## Known issues in AGDiag
 
-For the latest information on documented issues and possible solutions, see [Known Issues with AGDiag](https://github.com/microsoft/agdiag/wiki/Known-Issues-with-AGDiag).
+For the latest information about documented issues and possible solutions, see [Known Issues with AGDiag](https://github.com/microsoft/agdiag/wiki/Known-Issues-with-AGDiag).