Skip to content

Commit 84cbc61

Browse files
committed
manual edits
1 parent ba93ae6 commit 84cbc61

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

support/sql/database-engine/availability-groups/use-agdiag-diagnose-availability-group-health-events.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Use AGDiag to diagnose availability group health events
33
description: This article describes how to use AGDiag to diagnose availability group health events.
44
ms.date: 05/15/2023
55
ms.custom: sap:Always On Availability Groups (AG)
6-
ms.reviewer: cmathews, v-sidong
6+
ms.reviewer: cmathews, v-sidong, v-shaywood
77
---
88
# Use AGDiag to diagnose availability group health events
99

@@ -14,40 +14,39 @@ AGDiag is an application that automates the manual analysis described in the art
1414

1515
## Generate logs for AGDiag to diagnose
1616

17-
You can use multiple methods to generate the logs that AGDiag uses as inputs. AGDiag relies on the following base logs to do analysis:
17+
You can use multiple methods to generate the logs that AGDiag takes as inputs. AGDiag relies on the following base logs to do analysis:
1818

1919
- Windows Cluster Diagnostic Logs
2020
- SQL Server Error Logs
2121
- Windows System Event Logs
2222
- System Health Extended Events (XEL) files
2323
- AlwaysOn Health Session XEL files
2424

25-
Besides the manual collection of these logs, you can use either of two log collection tools to capture them.
25+
Besides manually collecting these logs, you can use either of the following log collection tools to capture them:
2626

27-
Use one of these log collection tools:
27+
- LogScout
28+
- TSS
2829

2930
### Use SQL LogScout to capture logs for AGDiag analysis
3031

31-
To diagnose an availability group health event, use the SQL LogScout to collect logs on the SQL Server instance that was in the primary role at the time of the event.
32+
To diagnose an availability group health event, use the SQL LogScout to collect logs on the SQL Server instance that was in the primary role at the time of the event:
3233

3334
1. Download the latest [SQL LogScout](https://aka.ms/get-sqllogscout) as zip file.
34-
1. Save and extract the zip file in a folder on the machine where SQL Server hosts the primary replica. This system is where the failover started or the availability group was resolving.
35-
1. Open an elevated PowerShell command (Run as Administrator), change the directory to the SQL LogScout folder where the zip file was extracted
36-
1. Run the following command to capture the `Basic` scenario and follow the prompts
35+
1. Save and extract the zip file on the machine where SQL Server hosts the primary replica. This system is where the failover started or the availability group was resolving.
36+
1. Open an elevated PowerShell command (Run as Administrator), change the directory to the SQL LogScout folder where the zip file was extracted.
37+
1. Run the following command to capture the `Basic` scenario and follow the prompts.
3738

3839
```PowerShell
39-
.\SQL_LogScout.ps1 -Scenario "Basic" -ServerName "<your_sql_instance_name>"
40+
.\SQL_LogScout.ps1 -Scenario "Basic" -ServerName "<Your_Sql_Instance_Name>"
4041
```
4142

42-
:::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/launch-sql-logscout-powershell.png" alt-text="screenshot for starting SQL LogScout from an elevated PowerShell command window":::
43+
:::image type="content" source="media/use-agdiag-diagnose-availability-group-health-events/launch-sql-logscout-powershell.png" alt-text="Screenshot of starting SQL LogScout from an elevated PowerShell command window":::
4344

44-
1. Once the process of log capturing is complete, you can point AGDiag to the **\output** folder where SQL LogScout collected the logs.
45+
1. Once the log capture process is complete, you can point AGDiag to the `\output` folder created inside the SQL LogScout folder. This folder contains the logs collected by SQL LogScout.
4546

4647
### Use TSS to generate logs for AGDiag to diagnose
4748

48-
Alternatively, to capture the logs you can use the TSS on the SQL Server instance that was in the primary role at the time of the event.
49-
50-
To accomplish this goal, follow these steps:
49+
Alternatively, you can capture the logs using the TSS on the SQL Server instance that was in the primary role at the time of the event:
5150

5251
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).
5352

@@ -90,15 +89,15 @@ The AGDiag report should be launched in the default system browser. The followin
9089

9190
:::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":::
9291

93-
- AGDiag reports on the logs analyzed in the initialize section. To expand more detailed information, select the triangles (highlighted in red boxes in the following image).
92+
- AGDiag reports on the logs analyzed in the initialize section. To see more detailed information, select the triangles (highlighted in red boxes in the following image).
9493

9594
:::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":::
9695

9796
- 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.
9897

9998
:::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":::
10099

101-
- There's a detailed report for each health event detected, which includes log findings that correlate to the health event, diagnosis, and recommendations. To expand more detailed information, select the triangles, highlighted in red boxes in the following image.
100+
- There's a detailed report for each health event detected, which 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.
102101

103102
:::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":::
104103

0 commit comments

Comments
 (0)