PowerShell/tools/performance
2024-01-08 09:40:55 -08:00
..
GC.Regions.xml Change docs.microsoft.com to learn.microsoft.com (#19994) 2023-07-17 15:54:17 -07:00
Invoke-PerfviewPS.ps1 Clean up the use of 'SetProfileRoot' and 'StartProfile' in ConsoleHost (#9931) 2019-06-19 11:34:47 +05:00
JIT.Regions.xml Correct spelling in Comments and tests (#17480) 2022-06-06 09:55:33 -07:00
PowerShell.Regions.xml Change docs.microsoft.com to learn.microsoft.com (#19994) 2023-07-17 15:54:17 -07:00
PowerShell.stacktags Change docs.microsoft.com to learn.microsoft.com (#19994) 2023-07-17 15:54:17 -07:00
PowerShell.wpaProfile Add tools for PowerShell perf analysis (#7595) 2018-08-30 16:33:14 -07:00
PowerShell.wprp Add tools for PowerShell perf analysis (#7595) 2018-08-30 16:33:14 -07:00
README.md Fix failures in GitHub action markdown-link-check (#20996) 2024-01-08 09:40:55 -08:00

PowerShell Performance Analysis

This directory contains useful scripts and related files for analyzing PowerShell performance.

If you use the Windows Performance Toolkit, you can use the following to collect data and analyze a trace.

$PowerShellGitRepo = "D:\PowerShell"
wpr -start $PowerShellGitRepo\tools\performance\PowerShell.wprp -filemode
pwsh.exe -NoProfile -Command "echo 1"
wpr -stop PowerShellTrace.etl
wpa -i wpa://.\PowerShellTrace.etl?profile=$PowerShellGitRepo\tools\performance\PowerShell.wpaProfile

When wpa opens, under System Activity, you'll find a section "Regions of Interest". With the above wpaProfile, you should see a bunch of PowerShell related regions as well as GC and JIT activity.

If you use PerfView, you can collect a trace by running

Invoke-PerfviewPS.ps1 -scenario { echo 1 }
perfview .\perfviewdata.etl

The etl files collected with perfview or wpr should contain roughly the same events.

Also note that you can collect the trace with one tool and analyze with the other.

Symbols

PDB files are not published for PowerShell Core, so the current recommendation is to build PowerShell yourself passing -CrossGen to Start-Build.

If profiling Windows PowerShell, symbols are generated from GAC. wprui.exe and perfview.exe will both generate the PDB files needed.

Files

File Description
GC.Regions.xml WPA regions of interest for GC
JIT.Regions.xml WPA regions of interest for JIT
PowerShell.Regions.xml WPA regions of interest for PowerShell
PowerShell.stacktags PowerShell stack tags
PowerShell.wpaProfile WPA profile to load regions of interest and stack tags
PowerShell.wprp WPR profile to enable CLR and PowerShell ETW events
Invoke-PerfviewPS.ps1 Script to run perfview and with PowerShell ETW events enabled