How to collect Windows ETL traces

Question

How to collect ETL traces on Windows to investigate performance issues in Rider?

Additional note:

This diagnostic helps to investigate why specific operations IDE through the OS are slow. It helps to narrow down what processes (potentially antivirus software) touch files, slowing down the operations, or what exact operations are slow. When Rider performance snapshot doesn't give any clues what is slowing down the IDE, these ETL traces can help.

Answer

Here's how one can collect ETL traces:

1. Close any running Rider instances
2. Download Windows ADK corresponding to the Windows version running on the target system
3. Install Windows Performance Toolkit
4. Temporarily disable paging executive by running reg add "HKLM\System\CurrentControlSet\Control\Session Manager\Memory Management" -v DisablePagingExecutive -d 0x1 -t REG_DWORD -f and rebooting the system
5. Temporarily disable "Real-time protection" in Windows Defender (or a similar feature in the alternative antivirus solution running on the target system)
6. Launch Rider
7. Launch elevated PowerShell and navigate to a directory that will store performance traces
8. Run & 'C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\wpr.exe' -start GeneralProfile to start recording performance traces
9. Reproduce the issue in Rider
10. Run & 'C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\wpr.exe' -stop etl_dump_name.etl to write performance data to disk
11. Open the directory containing performance data and find etl_dump_name.etl
12. (Optional) Zip etl_dump_name.etlfor a shorter upload time
13. Send the snapshot via the Upload Service and mention the Upload ID in relevant support case / YouTrack ticket

As soon as the snapshot (etl_dump_name.etl) is collected, roll back the temporary changes made to the system:

1. Enable "Real-time protection" in Windows Defender
2. Enable paging executive by running reg add "HKLM\System\CurrentControlSet\Control\Session Manager\Memory Management" -v DisablePagingExecutive -d 0x0 -t REG_DWORD -f and rebooting the system