Skip to content

Commit ac2f40c

Browse files
committed
add image and update acrolinx
1 parent cf6bf7f commit ac2f40c

2 files changed

Lines changed: 18 additions & 8 deletions

File tree

Loading

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

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ 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. Besides the manual collection of Windows Cluster Diagnostic Logs, SQL Server Error Logs, Windows System Event Logs, System Health Extended Events (XEL) and AlwaysOn Health Session XEL Files, you can use either of two log collection tools to capture those.
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:
18+
19+
- Windows Cluster Diagnostic Logs
20+
- SQL Server Error Logs
21+
- Windows System Event Logs
22+
- System Health Extended Events (XEL) files
23+
- AlwaysOn Health Session XEL files
24+
25+
Besides the manual collection of these logs, you can use either of two log collection tools to capture them.
1826

1927
Use one of these log collection tools:
2028

@@ -23,21 +31,23 @@ Use one of these log collection tools:
2331
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.
2432

2533
1. Download the latest [SQL LogScout](http://aka.ms/get-sqllogscout) as zip file.
26-
1. Save and extract the zip file in a folder on the machine where SQL Server hosts the primary replica when the failover started or the availability group was resolving.
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.
2735
1. Open an elevated PowerShell command (Run as Administrator), change the directory to the SQL LogScout folder where the zip file was extracted
2836
1. Run the following command to capture the `Basic` scenario and follow the prompts
2937

3038
```PowerShell
3139
.\SQL_LogScout.ps1 -Scenario "Basic" -ServerName "<your_sql_instance_name>"
3240
```
3341

34-
1. Once the process of log capturing is complete, you can poing AGDiag to the **\output** folder where SQL LogScout collected the logs.
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+
44+
1. Once the process of log capturing is complete, you can point AGDiag to the **\output** folder where SQL LogScout collected the logs.
3545

3646
### Use TSS to generate logs for AGDiag to diagnose
3747

3848
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.
3949

40-
Follow these steps to accomplish this goal:
50+
To accomplish this goal, follow these steps:
4151

4252
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).
4353

@@ -47,7 +57,7 @@ Follow these steps to accomplish this goal:
4757

4858
:::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":::
4959

50-
1. Once the TSS SQLBase cab file has been created, extract the cab file into a folder.
60+
1. Once the TSS creates the SQLBase cab file, extract the cab file into a folder.
5161

5262
:::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":::
5363

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

8191
:::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":::
8292

83-
- 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.
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).
8494

8595
:::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":::
8696

87-
- 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.
97+
- 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.
8898

8999
:::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":::
90100

91-
- 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.
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.
92102

93103
:::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":::
94104

0 commit comments

Comments
 (0)