Skip to content

Commit 3ca49ae

Browse files
authored
Merge pull request #2319 from YongRhee-MSFT/docs-editor/troubleshoot-av-performance-is-1736179983
Create article troubleshoot-av-performance-issues-with-wprui
2 parents 7777a35 + 36ecd5c commit 3ca49ae

File tree

2 files changed

+161
-0
lines changed

2 files changed

+161
-0
lines changed

defender-endpoint/TOC.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -934,6 +934,10 @@
934934
antivirus windows defender antivirus
935935
- name: Troubleshoot performance issues related to real-time protection
936936
href: troubleshoot-performance-issues.md
937+
- name: Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI
938+
href: troubleshoot-av-performance-issues-with-wprui.md
939+
displayName: Troubleshoot antivirus performance issues with WPRUI windows
940+
performance recorder UI WPR windows performance recorder
937941
- name: Troubleshoot Microsoft Defender Antivirus performance issues with Process
938942
Monitor
939943
href: troubleshoot-av-performance-issues-with-procmon.md
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
title: Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI
3+
description: Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI
4+
author: emmwalshh
5+
ms.author: ewalsh
6+
ms.reviewer: yongrhee
7+
ms.service: defender-endpoint
8+
ms.topic: troubleshooting-general
9+
ms.date: 01/08/2025
10+
ms.subservice: ngp
11+
manager: deniseb
12+
ms.localizationpriority: medium
13+
f1.keywords: NOCSH
14+
audience: ITPro
15+
ai-usage: human-only
16+
ms.collection:
17+
- m365-security
18+
ms.custom:
19+
- partner-contribution
20+
---
21+
22+
# Troubleshoot Microsoft Defender Antivirus performance issues with WPRUI
23+
24+
## Capture performance logs using Windows Performance Recorder
25+
26+
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.
27+
28+
WPR is part of the Windows Assessment and Deployment Kit (Windows ADK) and can be downloaded from [Download and install the Windows ADK](/windows-hardware/get-started/adk-install). You can also download it as part of the Windows 10 Software Development Kit at [Windows 10 SDK](https://developer.microsoft.com/windows/downloads/windows-10-sdk/).
29+
30+
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.
31+
32+
### Capture performance logs using the WPR UI
33+
34+
> [!TIP]
35+
> If multiple devices are experiencing this issue, try using the one with the most RAM.
36+
37+
1. Download and install WPR.
38+
39+
1. Under *Windows Kits*, right-click **Windows Performance Recorder**.
40+
41+
![Screenshot showing the Start menu](media/wpr-01.png)
42+
43+
1. Select **More**. Select **Run as administrator**.
44+
45+
1. Right-click **Yes** when the User Account Control dialog box appears.
46+
47+
![Screenshot showing the UAC page.](media/wpt-yes.png)
48+
49+
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`.
50+
51+
1. In the WPR dialog box, select **More options**.
52+
53+
![Screenshot showing the page where you can select more options](media/wpr-03.png)
54+
55+
1. Select **Add Profiles...** and browse to the path of the `MDAV.wprp` file.
56+
57+
1. A new profile named Microsoft Defender for Endpoint analysis should appear under Custom measurements.
58+
59+
![Screenshot showing the in-file.](media/wpr-infile.png)
60+
61+
> [!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.
63+
> This custom profile provides the necessary context for in-depth performance analysis.
64+
65+
1. To use the custom measurement Microsoft Defender for Endpoint verbose analysis profile in the WPR UI:
66+
67+
1. Ensure no profiles are selected under the *First-level triage*, *Resource Analysis* and *Scenario Analysis* groups.
68+
69+
2. Select **Custom measurements**.
70+
71+
3. Select **Microsoft Defender for Endpoint analysis**.
72+
73+
4. Select **Verbose** under *Detail* level.
74+
75+
5. Select **File** or **Memory** under Logging mode.
76+
77+
> [!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.
79+
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.
81+
82+
![Screenshot showing the Hide options.](media/wpr-08.png)
83+
84+
1. Select **Start**.
85+
86+
![Screenshot showing the Record system information page.](media/wpr-09.png)
87+
88+
1. Reproduce the issue.
89+
90+
> [!TIP]
91+
> Limit the data collection to a maximum of five minutes. Ideally, aim for two to three minutes, as a significant amount of data is being collected.
92+
93+
1. Select **Save**.
94+
95+
![Screenshot showing the Save option.](media/wpr-10.png)
96+
97+
1. Fill in **Type in a detailed description of the problem:** with information about the problem and how you reproduced the issue.
98+
99+
![Screenshot showing the pane in which you fill.](media/wpr-12.png)
100+
101+
1. Select **File Name:** to determine where your trace file is saved. By default, it's saved to `%user%\Documents\WPR Files\`.
102+
103+
1. Select **Save**.
104+
105+
![Screenshot showing the WPR gathering general trace.](media/wpr-13.png)
106+
107+
1. After the trace has been merged and saved, right-click **Open folder**.
108+
109+
![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.
112+
113+
![Screenshot showing the details of the file and the folder.](media/wpr-15.png)
114+
115+
### Capture performance logs using the WPR CLI
116+
117+
To collect a WPR trace using the command-line tool wpr.exe:
118+
119+
1. Download **[Microsoft Defender for Endpoint analysis](https://github.com/YongRhee-MDE/Scripts/blob/master/MDAV.wprp)** performance trace profile as `MDAV.wprp` in a local directory such as `C:\traces`.
120+
121+
1. Right-click the **Start Menu** icon and select **Windows PowerShell (Admin)** or **Command Prompt (Admin)** to open an Admin command prompt window.
122+
123+
1. Select **Yes** in the User Account Control dialog box.
124+
125+
1. At the **Command Prompt (Admin)**, run the following command to start a Microsoft Defender for Endpoint performance trace:
126+
127+
```console
128+
129+
wpr.exe -start C:\traces\MDAV.wprp!WD.Verbose -filemode
130+
131+
```
132+
133+
> [!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.
135+
136+
1. Reproduce the issue.
137+
138+
> [!TIP]
139+
> Limit the data collection to a maximum of five minutes. Ideally, aim for two to three minutes, as a significant amount of data is being collected.
140+
141+
1. At the **Command Prompt (Admin)**, run the following command to start a Microsoft Defender for Endpoint performance trace:
142+
143+
```console
144+
wpr.exe -stop merged.etl "Timestamp when the issue was reproduced, in HH:MM:SS format" "Description of the issue" "Any error that popped up"
145+
```
146+
147+
1. Wait until the trace is merged.
148+
149+
1. Include both the file and the folder in your submission to Microsoft Support.
150+
151+
## See also
152+
153+
- [Collect Microsoft Defender Antivirus diagnostic data](collect-diagnostic-data.md)
154+
- [Configure and validate exclusions for Microsoft Defender Antivirus scans](configure-exclusions-microsoft-defender-antivirus.md)
155+
- [Performance analyzer for Microsoft Defender Antivirus](tune-performance-defender-antivirus.md)
156+
157+
[!INCLUDE [Microsoft Defender for Endpoint Tech Community](../includes/defender-mde-techcommunity.md)]

0 commit comments

Comments
 (0)