Skip to content

Commit 02e85da

Browse files
Update ETL capture instructions.
gpuview log.cmd has errors on non-english PCs. Use start_etl_collection/stop_etl_collection scripts instead. See issue #246.
1 parent a5ad227 commit 02e85da

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Provide a user-mode minidump of the crash:
2323

2424
Provide an ETL trace:
2525

26-
1. Install the [Windows Performance Toolkit](https://www.google.com/search?q=windows+performance+toolkit+download&btnI).
27-
2. Start a capture by running "%ProgramFiles(x86)%\Windows Kits\10\Windows Performance Toolkit\gpuview\log.cmd" as administrator.
26+
1. Install the [Windows Performance Toolkit](https://www.google.com/search?q=windows+performance+toolkit+download&btnI) and ensure xperf.exe is in your path.
27+
2. Start a capture by running `Tools\start_etl_collection.cmd` in the PresentMon repository as administrator.
2828
3. Run the test scenario.
29-
4. Stop the capture by running log.cmd again. The capture will be output to Merged.etl in the working directory. Try to capture for as short as possible to limit the size of the file, while still capturing the problem.
30-
5. Test that the .etl capture exhibits the issue you are reporting, by running the PresentMon console application with "-etl_file Merged.etl" (to read from the capture instead of the system).
31-
6. Provide the resulting Merged.etl file. ETL files compress well, so consider compressing to simplify sharing e.g.: `7z a MergeCompressed.7z Merged.etl`).
29+
4. Stop the capture by running `Tools\stop_etl_collection.cmd` as administrator. The capture will be output to trace.etl in the working directory. Try to capture for as short as possible to limit the size of the file, while still capturing the problem.
30+
5. Test that the .etl capture exhibits the issue you are reporting, by running the PresentMon console application with "-etl_file trace.etl" (to read from the capture instead of the system).
31+
6. Provide the resulting trace.etl file along with your report.
3232

3333
## Contributing Source Code
3434

Tools/start_etl_collection.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:: SPDX-License-Identifier: MIT
33
@echo off
44
setlocal
5-
set xperf="%ProgramFiles(x86)%\Windows Kits\10\Windows Performance Toolkit\xperf.exe"
5+
set xperf=xperf.exe
66

77
if "%~1" equ "" goto check_args
88
if "%~1" neq "" set xperf=%1

Tools/stop_etl_collection.cmd

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:: SPDX-License-Identifier: MIT
33
@echo off
44
setlocal
5-
set xperf="%ProgramFiles(x86)%\Windows Kits\10\Windows Performance Toolkit\xperf.exe"
5+
set xperf=xperf.exe
66

77
if "%~1" equ "" goto check_args
88
if "%~1" neq "" set xperf=%1
@@ -18,6 +18,12 @@ if "%~2" neq "" goto usage
1818
exit /b 1
1919
:args_ok
2020

21+
net session >nul 2>&1
22+
if errorlevel 1 (
23+
echo error: must run as administrator
24+
exit /b 1
25+
)
26+
2127
set error=0
2228

2329
%xperf% -capturestate SchedulingLog 802ec45a-1e99-4b83-9920-87c98277ba9d:0x04000000:5

0 commit comments

Comments
 (0)