diagnostics: combine wprp files in a single one with profiles (#14048)

* diagnostics: combine wprp files in a single one with profiles

---------

Co-authored-by: Ben Hillis <benhill@ntdev.microsoft.com>

Author: benhillis

.github/copilot-instructions.md

@@ -173,6 +173,13 @@ python3 distributions/validate.py distributions/DistributionInfo.json
 wpr -start diagnostics\wsl.wprp -filemode
 # [reproduce issue]  
 wpr -stop logs.ETL
+
+# Available profiles:
+# - WSL (default) - General WSL tracing
+# - WSL-Storage - Enhanced storage tracing
+# - WSL-Networking - Comprehensive networking tracing
+# - WSL-HvSocket - HvSocket-specific tracing
+# Example: wpr -start diagnostics\wsl.wprp!WSL -filemode
 ```
 
 ### Log Analysis Tools

CONTRIBUTING.md

@@ -79,6 +79,12 @@ Set-ExecutionPolicy Bypass -Scope Process -Force
 ```
 The script will output the path of the log file once done.
 
+For specific scenarios, you can use different log profiles:
+- `.\collect-wsl-logs.ps1 -LogProfile storage` - Enhanced storage tracing
+- `.\collect-wsl-logs.ps1 -LogProfile networking` - Networking-focused tracing
+- `.\collect-wsl-logs.ps1 -LogProfile hvsocket` - HvSocket-specific tracing
+- `.\collect-networking-logs.ps1` - Alternative script for networking tracing
+
 ### 10) Reporting a Windows crash (BSOD)
 
 To collect a kernel crash dump, first run the following command in an elevated command prompt:

diagnostics/collect-networking-logs.ps1

@@ -124,22 +124,23 @@ function Collect-WindowsNetworkState {
 $folder = "WslNetworkingLogs-" + (Get-Date -Format "yyyy-MM-dd_HH-mm-ss")
 mkdir -p $folder
 
-$logProfile = "$folder/wsl_networking.wprp"
+$wprpFile = "$folder/wsl.wprp"
+$wprpProfile = "WSL-Networking"
 $networkingBashScript = "$folder/networking.sh"
 
 # Detect the super user first.
 # Actually it's not definite that the super user is named "root". Instead, a user with uid=0 is what we are looking for. See #11693.
 $superUser = & wsl.exe -- id -nu 0  # user name of the super user.
 
 # Copy/Download supporting files
-if (Test-Path "$PSScriptRoot/wsl_networking.wprp")
+if (Test-Path "$PSScriptRoot/wsl.wprp")
 {
-    Copy-Item "$PSScriptRoot/wsl_networking.wprp" $logProfile
+    Copy-Item "$PSScriptRoot/wsl.wprp" $wprpFile
 }
 else
 {
-    Write-Host -ForegroundColor Yellow "wsl_networking.wprp not found in the current directory. Downloading it from GitHub."
-    Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl_networking.wprp" -OutFile $logProfile
+    Write-Host -ForegroundColor Yellow "wsl.wprp not found in the current directory. Downloading it from GitHub."
+    Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl.wprp" -OutFile $wprpFile
 }
 
 if (Test-Path "$PSScriptRoot/networking.sh")
@@ -183,13 +184,13 @@ if ($RestartWslReproMode)
 # Start logging.
 $wprOutputLog = "$folder/wpr.txt"
 
-wpr.exe -start $logProfile -filemode 2>&1 >> $wprOutputLog
+wpr.exe -start "$wprpFile!$wprpProfile" -filemode 2>&1 >> $wprOutputLog
 if ($LastExitCode -Ne 0)
 {
     Write-Host -ForegroundColor Yellow "Log collection failed to start (exit code: $LastExitCode), trying to reset it."
     wpr.exe -cancel 2>&1 >> $wprOutputLog
 
-    wpr.exe -start $logProfile -filemode 2>&1 >> $wprOutputLog
+    wpr.exe -start "$wprpFile!$wprpProfile" -filemode 2>&1 >> $wprOutputLog
     if ($LastExitCode -Ne 0)
     {
         Write-Host -ForegroundColor Red "Couldn't start log collection (exitCode: $LastExitCode)"
@@ -309,7 +310,7 @@ if (Test-Path $setupApiPath)
     Copy-Item $setupApiPath $folder
 }
 
-Remove-Item $logProfile
+Remove-Item $wprpFile
 Remove-Item $networkingBashScript
 
 $logArchive = "$(Resolve-Path $folder).zip"

diagnostics/collect-wsl-logs.ps1

@@ -11,32 +11,44 @@ Set-StrictMode -Version Latest
 $folder = "WslLogs-" + (Get-Date -Format "yyyy-MM-dd_HH-mm-ss")
 mkdir -p $folder | Out-Null
 
-if ($LogProfile -eq $null -Or ![System.IO.File]::Exists($LogProfile))
+# Check if LogProfile is a custom file path or a profile name
+if ($LogProfile -ne $null -And [System.IO.File]::Exists($LogProfile))
 {
-    if ($LogProfile -eq $null)
+    # User provided a custom .wprp file path - use it directly
+    $wprpFile = $LogProfile
+    $wprpProfile = $null  # Use default profile in the file
+}
+else
+{
+    # Map log profile names to WPRP profile names
+    $wprpProfile = "WSL"
+    if ($LogProfile -eq "storage")
     {
-        $url = "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl.wprp"
+        $wprpProfile = "WSL-Storage"
     }
-    elseif ($LogProfile -eq "storage")
+    elseif ($LogProfile -eq "networking")
     {
-         $url = "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl_storage.wprp"
+        $wprpProfile = "WSL-Networking"
     }
     elseif ($LogProfile -eq "hvsocket")
     {
-         $url = "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl_hvsocket.wprp"
+        $wprpProfile = "WSL-HvSocket"
     }
-    else
+    elseif ($LogProfile -ne $null)
     {
-        Write-Error "Unknown log profile: $LogProfile"
+        Write-Error "Unknown log profile: $LogProfile. Valid options are: storage, networking, hvsocket, or a path to a custom .wprp file"
         exit 1
     }
 
-    $LogProfile = "$folder/wsl.wprp"
-    try {
-        Invoke-WebRequest -UseBasicParsing $url -OutFile $LogProfile
+    # Use the consolidated wsl.wprp file, attempt to use local copy first.
+    $wprpFile = "$folder/wsl.wprp"
+    if (Test-Path "$PSScriptRoot/wsl.wprp")
+    {
+        Copy-Item "$PSScriptRoot/wsl.wprp" $wprpFile
     }
-    catch {
-        throw
+    else
+    {
+        Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/WSL/master/diagnostics/wsl.wprp" -OutFile $wprpFile
     }
 }
 
@@ -71,13 +83,23 @@ if (Test-Path $uninstallLogs)
 
 $wprOutputLog = "$folder/wpr.txt"
 
-wpr.exe -start $LogProfile -filemode 2>&1 >> $wprOutputLog
+# Build wpr command - if wprpProfile is set, use profile syntax, otherwise use file only
+if ($wprpProfile -ne $null)
+{
+    $wprCommand = "$wprpFile!$wprpProfile"
+}
+else
+{
+    $wprCommand = $wprpFile
+}
+
+wpr.exe -start $wprCommand -filemode 2>&1 >> $wprOutputLog
 if ($LastExitCode -Ne 0)
 {
     Write-Host -ForegroundColor Yellow "Log collection failed to start (exit code: $LastExitCode), trying to reset it."
     wpr.exe -cancel 2>&1 >> $wprOutputLog
 
-    wpr.exe -start $LogProfile -filemode 2>&1 >> $wprOutputLog
+    wpr.exe -start $wprCommand -filemode 2>&1 >> $wprOutputLog
     if ($LastExitCode -Ne 0)
     {
         Write-Host -ForegroundColor Red "Couldn't start log collection (exitCode: $LastExitCode)"