Skip to content

Commit

Permalink
Update ETW documentation to merge profiles (#5103)
Browse files Browse the repository at this point in the history
* Update ETW documentation to merge profiles

Add about merging the profiles in case if app has an explicit profile.
  • Loading branch information
dhveerap authored Feb 17, 2025
1 parent 8ea7783 commit e4af480
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions diagnostics/etw.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Gathering an ETW Trace
[Event Tracing for Windows (ETW)](https://learn.microsoft.com/en-us/windows-hardware/test/wpt/event-tracing-for-windows)traces include detailed events on system state and the activities WV2 was doing before and when an issue occurs.

This repo has a WV2 recording profile - [WebView2_CPU.wprp](WebView2_CPU.wprp) that includes the events that we find most useful.
This repo has a WV2 recording profile - [WebView2_CPU.wprp](WebView2_CPU.wprp) that includes the events that we find most useful.

ETW traces can get fairly large, so try to keep the amount of extra time spent when recording as small as possible. If you need a longer trace, ask the WV2 developer that you're working with if `WebView2.wprp` will suffice (it gathers less data).

1. Close Edge and any other apps using WV2 to make the trace more clear. Common apps using WV2 may include `widgets.exe`, `msteams.exe`, and Microsoft Office products.
1. Download [WebView2_CPU.wprp](WebView2_CPU.wprp) from this repo.
2. In an elevated command prompt run `wpr -start WebView2_CPU.wprp -filemode` (wpr.exe is included in Windows)
3. Reproduce the issue.
4. In an elevated command prompt run `wpr -stop trace.etl "trace"`.
2. Download [WebView2_CPU.wprp](WebView2_CPU.wprp) from this repo.
3. If your app has a specific profile, merge it with [WebView2_CPU.wprp](WebView2_CPU.wprp) to ensure all events are captured in a single ETL file.
4. In an elevated command prompt run `wpr -start WebView2_CPU.wprp -filemode` (wpr.exe is included in Windows).
5. Reproduce the issue.
6. In an elevated command prompt run `wpr -stop trace.etl "trace"`.

ETW traces can contain sensitive information, if you're concerned with sharing one publicly in a GitHub issue, you can ask the WV2 developer you're working with for an email address to send to them privately.

0 comments on commit e4af480

Please # to comment.