Skip to content

diagnostics: improve collect-wsl-logs for analysis (summary.json, README, profile info, WSL/guest state) #40776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benhillis wants to merge 6 commits into
base: master
Choose a base branch
from
+22 −0
Open

diagnostics: improve collect-wsl-logs for analysis (summary.json, README, profile info, WSL/guest state) #40776

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9284794
diagnostics: record capture profile in collected logs
Jun 11, 2026
775c641
diagnostics: collect WSL version, guest state, and drop empty dumps
Jun 11, 2026
910487c
diagnostics: add summary.json and README.md to log archive
Jun 11, 2026
80218e5
diagnostics: address PR feedback (utf8 wsl-info, wsl.exe timeouts, sl…
Jun 11, 2026
003f66e
diagnostics: drop wsl-info.txt and guest diagnostics collection
Jun 11, 2026
1eeb695
collect-wsl-logs: drop bundled summary.json and README per review
Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions diagnostics/collect-wsl-logs.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Param (

Set-StrictMode -Version Latest

# Make wsl.exe emit UTF-8 (instead of UTF-16) and have the console decode it as
# such, so output captured from wsl.exe below is saved to log files readably.
$env:WSL_UTF8 = "1"
try { [Console]::OutputEncoding = [System.Text.Encoding]::UTF8 } catch {}

function Test-WslApplication {
param (
$Name
Expand Down Expand Up @@ -124,6 +129,20 @@ else
}
}

# Record how these logs were collected so that whoever analyzes the archive
# knows which profile was used (a networking-only capture, for example, will not
# contain the WSL core trace providers).
$logProfileDisplay = if ($LogProfile -eq $null) { "default" } else { $LogProfile }
$wprpProfileDisplay = if ($wprpProfile -ne $null) { $wprpProfile } else { "(default profile in $wprpFile)" }
@"
LogProfile : $logProfileDisplay
WPRP profile : $wprpProfileDisplay
WPRP file : $wprpFile
Dump : $Dump
RestartWslReproMode : $RestartWslReproMode
Collected : $(Get-Date -Format "yyyy-MM-dd HH:mm:ss K")
"@ | Out-File -FilePath "$folder/collection-info.txt" -Encoding utf8

# Networking-specific setup
if ($LogProfile -eq "networking")
{
Expand Down Expand Up @@ -369,6 +388,9 @@ if ($Dump)
if (-not $Result)
{
Write-Host "Failed to write dump for: $($dumpFile)"
# Remove the empty file so the archive isn't littered with 0-byte
# dumps that look like real (but truncated) captures.
Remove-Item $dumpFile -ErrorAction Ignore
}
}
}
Expand Down