Skip to content

Commit 1125b8d

Browse files
authored
Merge pull request #2368 from YongRhee-MSFT/docs-editor/troubleshoot-av-performance-is-1736364278
Update troubleshoot-av-performance-issues-with-wprui.md
2 parents 6504e5d + 996ccc3 commit 1125b8d

File tree

1 file changed

+67
-23
lines changed

1 file changed

+67
-23
lines changed

defender-endpoint/troubleshoot-av-performance-issues-with-wprui.md

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ ms.custom:
2121

2222
# Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI
2323

24+
> [!TIP]
25+
> First, review common reasons for performance issues such as high CPU usage in [Troubleshoot performance issues related to Microsoft Defender Antivirus real-time protection (RTP) or scans (scheduled or on-demand](/defender-endpoint/troubleshoot-performance-issues)).
26+
> Then, run the [Microsoft Defender Antivirus Performance Analyzer](/defender-endpoint/tune-performance-defender-antivirus) to analyze the cause of high CPU usage in Microsoft Defender Antivirus (Antimalware Service Executable, Microsoft Defender Antivirus service, or MsMpEng.exe).
27+
> If the Microsoft Defender Antivirus Performance Analyzer doesn't identify the root cause of high CPU utilization, run [Processor Monitor](/defender-endpoint/troubleshoot-av-performance-issues-with-procmon) to narrow down or determine the root cause of the high CPU utilization in Microsoft Defender Antivirus.
28+
> The final tool in your toolkit is to run the Windows Performance Recorder UI (WPRUI) or the Windows Performance Recorder (WPR command-line) as discussed in this article.
29+
2430
## Capture performance logs using Windows Performance Recorder
2531

2632
Windows Performance Recorder (WPR) is a powerful recording tool that creates Event Tracing for Windows recordings and allows you to include additional information in your submission to Microsoft support.
@@ -29,62 +35,88 @@ WPR is part of the Windows Assessment and Deployment Kit (Windows ADK) and can b
2935

3036
Alternatively, follow the steps in [Capture performance logs using the WPR UI](/editor/MicrosoftDocs/defender-docs-pr/defender-endpoint%2Ftroubleshoot-performance-issues.md/main/ae28f1cf-14bc-fb9c-5f0c-873a683e907c/?branch=main&branchFallbackFrom=main%2C), or use the command-line tool *wpr.exe* [Capture performance logs using the WPR CLI](/editor/MicrosoftDocs/defender-docs-pr/defender-endpoint%2Ftroubleshoot-performance-issues.md/main/ae28f1cf-14bc-fb9c-5f0c-873a683e907c/?branch=main&branchFallbackFrom=main%2C). Both are available in Windows 8 and later versions.
3137

38+
There are two ways to capture the Windows Performance Recorder (WPRUI) trace:
39+
40+
1. Using the MDE Client Analyzer
41+
42+
1. Manually
43+
44+
## Using the MDE Client Analyzer
45+
46+
1. Download the [MDE Client Analyzer](/defender-endpoint/download-client-analyzer).
47+
48+
1. Run the MDE Client Analyzer using [Live Response or locally](/defender-endpoint/run-analyzer-windows).
49+
50+
> [!TIP]
51+
> Before starting the trace, make sure the issue is reproducible. Additionally, close any applications that don't contribute to the reproduction of the issue.
52+
53+
54+
1. Run the MDE Client Analyzer with the `-a` and `-v` switches.
55+
56+
PowerShellCopy
57+
58+
```
59+
C:\Work\tools\MDEClientAnalyzer\MDEClientAnalyzer.cmd
60+
```
61+
62+
## Manually
63+
3264
### Capture performance logs using the WPR UI
3365

3466
> [!TIP]
35-
> If multiple devices are experiencing this issue, try using the one with the most RAM.
67+
> If multiple devices are experiencing this issue, use the one with the most RAM.
3668
3769
1. Download and install WPR.
3870

3971
1. Under *Windows Kits*, right-click **Windows Performance Recorder**.
4072

4173
![Screenshot showing the Start menu](media/wpr-01.png)
42-
74+
4375
1. Select **More**. Select **Run as administrator**.
4476

4577
1. Right-click **Yes** when the User Account Control dialog box appears.
4678

4779
![Screenshot showing the UAC page.](media/wpt-yes.png)
48-
80+
4981
1. Next, download the [Microsoft Defender for Endpoint analysis](https://github.com/YongRhee-MDE/Scripts/blob/master/MDAV.wprp) profile and save as `MDAV.wprp` to a folder such as `C:\temp`.
5082

5183
1. In the WPR dialog box, select **More options**.
5284

5385
![Screenshot showing the page where you can select more options](media/wpr-03.png)
54-
86+
5587
1. Select **Add Profiles...** and browse to the path of the `MDAV.wprp` file.
5688

5789
1. A new profile named Microsoft Defender for Endpoint analysis should appear under Custom measurements.
5890

5991
![Screenshot showing the in-file.](media/wpr-infile.png)
60-
92+
6193
> [!WARNING]
62-
> If your Windows Server has 64 GB of RAM or more, use the custom measurement `Microsoft Defender for Endpoint analysis for large servers` instead of `Microsoft Defender for Endpoint analysis`. Otherwise, your system consumes a high amount of non-paged pool memory or buffers, leading to system instability. Explore **Resource Analysis** to choose profiles to add.
94+
> If your Windows Server has 64 GB of RAM or more, use the custom measurement `Microsoft Defender for Endpoint analysis for large servers` instead of `Microsoft Defender for Endpoint analysis`. Otherwise, your system might consume a high amount of nonpaged pool memory or buffers, leading to system instability. To address this, explore **Resource Analysis** to choose profiles to add.
6395
> This custom profile provides the necessary context for in-depth performance analysis.
6496
6597
1. To use the custom measurement Microsoft Defender for Endpoint verbose analysis profile in the WPR UI:
6698

6799
1. Ensure no profiles are selected under the *First-level triage*, *Resource Analysis* and *Scenario Analysis* groups.
68100

69-
2. Select **Custom measurements**.
101+
1. Select **Custom measurements**.
70102

71-
3. Select **Microsoft Defender for Endpoint analysis**.
103+
1. Select **Microsoft Defender for Endpoint analysis**.
72104

73-
4. Select **Verbose** under *Detail* level.
105+
1. Select **Verbose** under *Detail* level.
74106

75-
5. Select **File** or **Memory** under Logging mode.
107+
1. Select **File** or **Memory** under Logging mode.
76108

77109
> [!IMPORTANT]
78-
> Select **File** to use the file logging mode if you can directly reproduce the performance issue. Most issues fall under this category. However, if you cannot directly reproduce the issue, select Memory to use the memory logging mode. This prevents the trace log from inflating excessively due to long run times.
110+
> Select **File** to use the file logging mode if you can directly reproduce the performance issue. Most issues fall under this category. However, if you can't directly reproduce the issue, select **Memory** to use the memory logging mode. This prevents the trace log from inflating excessively due to long run times.
79111
80-
1. Now you're ready to collect data. Close all unnecessary applications. Click **Hide options** to keep the space occupied by the WPR window small.
112+
1. Now you're ready to collect data. Close all unnecessary applications. Select **Hide options** to keep the space occupied by the WPR window small.
81113

82114
![Screenshot showing the Hide options.](media/wpr-08.png)
83-
115+
84116
1. Select **Start**.
85117

86118
![Screenshot showing the Record system information page.](media/wpr-09.png)
87-
119+
88120
1. Reproduce the issue.
89121

90122
> [!TIP]
@@ -93,25 +125,25 @@ Alternatively, follow the steps in [Capture performance logs using the WPR UI](/
93125
1. Select **Save**.
94126

95127
![Screenshot showing the Save option.](media/wpr-10.png)
96-
128+
97129
1. Fill in **Type in a detailed description of the problem:** with information about the problem and how you reproduced the issue.
98130

99131
![Screenshot showing the pane in which you fill.](media/wpr-12.png)
100-
132+
101133
1. Select **File Name:** to determine where your trace file is saved. By default, it's saved to `%user%\Documents\WPR Files\`.
102134

103-
1. Select **Save**.
135+
1. Select **Save**.
104136

105137
![Screenshot showing the WPR gathering general trace.](media/wpr-13.png)
106-
138+
107139
1. After the trace has been merged and saved, right-click **Open folder**.
108140

109141
![Screenshot that displays the notification that WPR trace has been saved.](media/wpr-14.png)
110-
111-
Include both the file and the folder in your submission to Microsoft Support.
142+
143+
1. Include both the file and the folder in your submission to Microsoft Support.
112144

113145
![Screenshot showing the details of the file and the folder.](media/wpr-15.png)
114-
146+
115147
### Capture performance logs using the WPR CLI
116148

117149
To collect a WPR trace using the command-line tool wpr.exe:
@@ -131,7 +163,7 @@ To collect a WPR trace using the command-line tool wpr.exe:
131163
```
132164

133165
> [!WARNING]
134-
> If your Windows Server has 64 GB of RAM or more, use profiles `WDForLargeServers.Light` and `WDForLargeServers.Verbose` instead of profiles `WD.Light` and `WD.Verbose`, respectively. Otherwise, your system consumes a high amount of non-paged pool memory or buffers, leading to system instability.
166+
> If your Windows Server has 64 GB of RAM or more, use profiles `WDForLargeServers.Light` and `WDForLargeServers.Verbose` instead of profiles `WD.Light` and `WD.Verbose`, respectively. Otherwise, your system consumes a high amount of nonpaged pool memory or buffers, leading to system instability.
135167
136168
1. Reproduce the issue.
137169

@@ -150,8 +182,20 @@ To collect a WPR trace using the command-line tool wpr.exe:
150182

151183
## See also
152184

185+
- [Run the client analyzer on Windows](/defender-endpoint/run-analyzer-windows)
186+
153187
- [Collect Microsoft Defender Antivirus diagnostic data](collect-diagnostic-data.md)
188+
189+
- [Troubleshoot Microsoft Defender Antivirus settings](/defender-endpoint/troubleshoot-settings)
190+
154191
- [Configure and validate exclusions for Microsoft Defender Antivirus scans](configure-exclusions-microsoft-defender-antivirus.md)
192+
193+
- [Troubleshoot performance issues related to Microsoft Defender Antivirus](/defender-endpoint/troubleshoot-performance-issues)
194+
155195
- [Performance analyzer for Microsoft Defender Antivirus](tune-performance-defender-antivirus.md)
156196

157-
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]
197+
- [Troubleshoot Microsoft Defender Antivirus performance issues with Process Monitor](/defender-endpoint/troubleshoot-av-performance-issues-with-procmon)
198+
199+
- [Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI](/defender-endpoint/troubleshoot-av-performance-issues-with-wprui)
200+
201+
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]

0 commit comments

Comments
 (0)