Skip to content

Commit 2b4748c

Browse files
author
Chetan Pandey
committed
a table with columns: log, purpose and usecase
1 parent 96f0ab7 commit 2b4748c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

diagnostics/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
This folder contains directions for gathering various detailed diagnostics/logs when reporting WV2-related issues. There's generally no need to proactively get any of these diagnostics before opening an issue, but if one seems obvious feel free to get it before opening an issue. Otherwise, a WV2 developer might link you to one of these pages to help them investigate an issue.
44

5-
| Logs | Description |
6-
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
7-
| [Crash Dumps](crash.md) | Crash dumps are used to better understand why a WV2 process is crashing and firing a [ProcessFailed](https://learn.microsoft.com/dotnet/api/microsoft.web.webview2.core.corewebview2.processfailed) event. |
8-
| [Memory Dumps from Task Manager](task_manager_dump.md) | Sometimes a user might need to manually gather a memory dump, normally for unresponsive processes. |
9-
| [ETW Trace](etw.md) | Event Tracing for Windows (ETW) traces include detailed events on system state and the activities WV2 was doing before and when an issue occurs. |
10-
| [Installer Logs](install.md)| Installer logs include information about any errors that WV2's installer/updater hit when trying to install or update the WV2 runtime. |
11-
| [GPU Info](gpu.md) | GPU logs include details on the user's GPU and any potential graphics or rendering issues. |
12-
| [Network Logs](network.md) | Network logs include the network requests, responses, and details on any errors when loading files. |
13-
| [Code Integrity](code_integrity.md) | How to root cause STATUS_INVALID_IMAGE_HASH errors. |
14-
| [Test in Canary](test_canary.md) | How to test new WebView2 runtime changes by using Edge Canary. |
15-
| [Procmon](procmon.md) | Can be helpful for cases where we get file not found error or access denied. |
16-
| [Time Travel Debugging](ttd.md) | Instructions for using Time Travel Debugging. |
17-
5+
| Tool / Log | Purpose | Use Case |
6+
|---------------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------------|
7+
| [Crash Dumps](crash.md) | Capture crash data for WebView2 processes. | Used when a child process crashes (via ProcessFailed event) or browser process fails. |
8+
| [Memory Dumps (Task Manager)](task_manager_dump.md)| Manual memory capture for unresponsive processes. | Helpful when WebView2 hangs or becomes non-responsive. |
9+
| [ETW Trace](etw.md) | Event Tracing for Windows logs detailed system and WebView2 activity. | Used to analyze system state and WebView2 behavior before/during issues. |
10+
| [Installer Logs](install.md) | Logs errors encountered during WebView2 runtime installation or updates.| Diagnose installation failures or update issues. |
11+
| [GPU Info](gpu.md) | Provides details about the GPU and rendering pipeline. | Useful for troubleshooting graphics-related problems. |
12+
| [Network Logs](network.md) | Records network requests, responses, and errors. | Diagnose issues with loading resources or connectivity failures. |
13+
| [Code Integrity](code_integrity.md) | Identifies root causes of `STATUS_INVALID_IMAGE_HASH` errors. | Used when encountering image hash validation failures. |
14+
| [Test in Canary](test_canary.md) | Allows testing of WebView2 runtime changes using Edge Canary builds. | Preview and validate fixes or features before stable release. |
15+
| [Procmon (Process Monitor)](procmon.md) | Logs file and registry access events. | Useful for diagnosing file not found or access denied errors. |
16+
| [Time Travel Debugging (TTD)](ttd.md) | Captures detailed call stacks and execution sequences. | Ideal for deep debugging when other logs are insufficient. |
17+

0 commit comments

Comments
 (0)