ETWAnalyzer main license is MIT.
ETWAnalyzer uses Open Source and 3rd Party Software listed in ReadMe.oss.
ETWAnalyzer extracts from ETL files summary information into compressed (.json7z) files. The ETL files are produced by the builtin profiling infrastructure of Windows Event Tracing for Windows (ETW). Profiling data can be collected with e.g. wpr, wprUI, xperf, PerfView, ... . Wpr is part of Windows 10 which enables you to record data on any Windows machine without additional software installation in the field. These recorded ETL files are usually large (multi GB) and load slow into analysis tools such as Windows Performance Analyzer (WPA) or PerfView. The design goal of ETWAnalyzer is to extract from huge ETL files the smallest data set that is necessary to identify performance bottlenenecks or regression issues in one or a collection of thousands of ETL files.
After extraction ETWAnalyzer has many query commands to make the data much more accessible. It can query one or many files where the output is either printed to console, or written to a CSV file for further analysis.
The Json files can also be accessed via a C# interface IETWExtract which enables you to write custom analyzers.
Compressed Json files are much faster to query than the input ETL files without slow symbol server lookups. It is based on years of field experience with ETW file analysis to keep the extracted Json file size as small as possible while maximizing the insights you can get of the extracted files. An ETW .json7z file is typically a few hundred KB while the input .etl file including PDBs is hundreds of MB.
You want to contribute, miss specific data, or want to add your specific dump command? Check out Contributing to get started.
See Documentation Folder in Repo
- CPU
- CPU Extended
- Disk
- Dns
- Exception
- File
- LBR
- Mark
- Memory
- ObjectRef
- PMC
- Power
- Process
- Stats
- TCP
- TestRun
- ThreadPool
- Version
They all support -filedir/-fd and an extensive command line help what you can dump from the extracted data.
The easiest way to get ETW data is to install ETWController which comes with predefined WPR profiles. ETWController supports
- Zipping ETW and NGEN pdbs with 7z.
- Taking Screenshots which are put besides profiling data which can be viewed in Browser.
- Capturing Keyboard/Mouse events.
- Distributed Profiling (Client/Server scenarios).
The 7z archives created by ETWController can be directly consumed with ETWAnalyzer. To e.g. unpack all compressed 7z files in a folder generated by ETWController and keep the files uncompressed so you can analyze further with WPA:
ETWAnalyzer -extract all -fd c:\Cases\Failure\*.7z -keepTemp -symserver MS
The following command extracts everything, using Microsoft symbols from a single ETL file.
The option -AllCPU will include also methods with < 10 ms CPU or Wait time which are normally not relevant for performance regression issues to keep the file size as small as possible.
You can also extract small Json files without symbol server access and resolve methods later from the Json files. See Build Profiling At Scale At Github for more details.
There is extracted example data located at Test Data which you can query at your own. Can you find the performance bug?
The curl command downloads the test data from Github. Then you can start working with the data. Since v3.0.0.6 ETWAnalyzer also supports an interactive console mode.
curl https://raw.githubusercontent.com/Siemens-Healthineers/ETWAnalyzer/main/ETWAnalyzer_uTest/TestData/CallupAdhocWarmReadingCT_3117msFO9DE01T0162PC.20200717-124447.json > c:\Temp\ETWAnalyzerTest.json
ETWAnalyzer -console
.load c:\Temp\ETWAnalyzerTest.json
.dump CPU -topN 1 -methods *
...
.dump CPU -topN 1 -methods * -sortby stackdepth -MinMaxCPUMs 1000
CPU ms Method
5/29/2024 4:27:46 PM ETWAnalyzerTest
VSIXAutoUpdate.exe(12996)
36,540 ms _RtlUserThreadStart
36,540 ms __RtlUserThreadStart
36,540 ms _CorExeMain_Exported
...
36,540 ms RtlExitUserProcess
36,540 ms LdrShutdownProcess
36,540 ms LdrpCallInitRoutine
36,540 ms LdrxCallInitRoutine
...
36,540 ms dllmain_dispatch
36,540 ms dllmain_crt_dispatch
36,540 ms ___scrt_acquire_startup_lock
.dump CPU -topN 1 -methods * -sortby stackdepth -MinMaxCPUMs 1000 -includedll -threadcount
5/29/2024 4:27:46 PM ETWAnalyzerTest
VSIXAutoUpdate.exe(12996)
...
36,540 ms #1 clr.dll!EEPolicy::ExitProcessViaShim
36,540 ms #1 mscoreei.dll!CLRRuntimeHostInternalImpl::ShutdownAllRuntimesThenExit
36,540 ms #1 mscoreei.dll!RuntimeDesc::ShutdownAllActiveRuntimes
36,540 ms #1 kernel32.dll!ExitProcessImplementation
36,540 ms #1 ntdll.dll!RtlExitUserProcess
36,540 ms #1 ntdll.dll!LdrShutdownProcess
36,540 ms #1 ntdll.dll!LdrpCallInitRoutine
36,540 ms #1 ntdll.dll!LdrxCallInitRoutine
...
36,540 ms #1 CustomMarshalers.dll!dllmain_dispatch
36,540 ms #1 CustomMarshalers.dll!dllmain_crt_dispatch
36,540 ms #1 CustomMarshalers.dll!___scrt_acquire_startup_lock
.dump CPU -topN 1 -methods * -sortby stackdepth -MinMaxCPUMs 1000 -FirstLastDuration s s
CPU ms Last-First First(s) Last(s) Method
5/29/2024 4:27:46 PM ETWAnalyzerTest
VSIXAutoUpdate.exe(12996)
...
36,540 ms 37.417 s 0.599 38.016 _CorDllMain
36,540 ms 37.417 s 0.599 38.016 _DllMainCRTStartup
36,540 ms 37.417 s 0.599 38.016 dllmain_dispatch
36,540 ms 37.417 s 0.599 38.016 dllmain_crt_dispatch
36,540 ms 37.417 s 0.599 38.016 ___scrt_acquire_startup_lock
.dump Stats -Properties SessionDurations
5/29/2024 4:27:46 PM ETWAnalyzerTest
SessionDurationS : 38
This shows a Microsoft Bug at work after pretty much every Visual Studio update where shutting down the .NET Runtime gets stuck.
After extraction from a > 600 MB input file a small ca. 600 KB .json7z file is created which contains multiple json files which consume ca 4 MB.
ETWAnalyzer will query all files in the current directory if you do not use -filedir/-fd xxx.
The first query would be to check on which machine with how much memory, CPU and Windows version it was running.
set f=-fd C:\Temp\Extract\ZScaler_Download_Slow_100KB_Over100MBit_MouseLags.json7z
EtwAnalyzer %f% -dump Stats
If you have a directory of files you can limit the output to specific properties with e.g. -Properties MemorySizeMB,OSName,NumberOfProcessors,CPUSpeedMHz,CPUVendor,CPUName to get a quick overview of the machine specs of a bunch of extracted ETL files.
Now we want to get an overview what the CPU consumption was of the top 9 CPU consumers of that file
EtwAnalyzer %f% -dump CPU -topN 9
The mouse was hanging while I was downloading data. At the same time the CPU was fully utilized on my quad core notebook. The by far highest CPU consumer was the Windows Kernel which sits in the System process. Lets pick that one and print the top 30 methods.
EtwAnalyzer %f% -dump CPU -processName System -TopNMethods 30
To understand the data you need to know that ETWAnalyzer keeps for every method in a process the method inclusive times for CPU summed accross all threads. The Wait and Ready time is summed accross all threads but overlapping regions are only counted once. This means that the maximum Wait/Ready time can get the recording time when at least one thread was always waiting or in the ready queue. CPU timing is extracted from CPU sampling data. Wait/Ready times are determined from Context Switch data which is mainly generated when the method was moved off a CPU due to a blocking OS call. That is the reason why Main or other entry point methods for a thread have the highest CPU consumption but are not the performance bottleneck. The actual issue is in one of the methods which consume CPU which is not directly visible in the extracted data. To get an overview for a new issue one turns over to WPA to see time dependencies which can only visually be analyzed.
Once the issue is understood you can create WPA stacktags of past issues to see if the same issue in the other file also appears without the need to drill deep into the call stacks. In this case it is obvious that we have again a Firewall problem where each network packet gets an expensive check in WfpAlepReauthorizeOutboundConnection which traverses long (many firewall rules?) lists.
Bad things keep coming back. After having identified a pattern in WPA we can check other ETW files either manually or we query the data with ETWAnalyzer and save a lot of time. Since WPA and ETWAnalyzer support stacktags we can dump the top 10 stacktags for the System process. After adding "-stacktags *" to the command line we get all stacktags. If you add "-stacktags * -methods *" all methods and stacktags are printed together in one list.
Note: There is only one filter named -topNMethods which filters for the overall top CPU consumers for methods and stacktags.
Etwanalyzer %f% -dump CPU -pn System -StackTags * -TopNMethods 10
From the stacktag CPU consumption we find as top match "Windows\Windows Firewall" which proves that we have hit the same issue again.
This is a known Windows 10 Bug which was fixed in the July 2023 KB5028166 Update which can happen in large AD Domains
Windows Filtering Platform forces reauthorization of every packet of an existing session when there is a profile change
(like change from public profile to domain profile). The authenticate / classification is an expensive operation and
reauthorization of every packet has a high performance impact on the system.
From the WPA stacktrace we know that these calls are executed as DPCs (Deferred Procedure Calls) which are normally issued for longer running tasks from an interrupt handler. The DPCs for all network packets consume up to all 4 cores on my machine which compete with the mouse interrupt handling resulting in a slow, sluggish system. It is time to call Microsoft Support to ask where this is coming from. To check which dll version we are running one would turn over to WPA and open the Images graph to find which dlls in which version are loaded. There you can find the exact patch level of the OS or your application dlls which are loaded by a process.
ETWAnalyzer amends version information to CPU data if you add to -dump CPU -ShowModuleInfo or -smi. That will show besides the method names module version data. If you are not using a console with a high console buffer width the output becomes unreadable due to word wrapping. To better support non wraping consoles you can add -Clip to all commands of ETWAnalyzer to prevent wraparound of output. Besides the version we would need the dll which is by default not printed. But you can add -IncludeDll or -id to get besides method names also the dll name. To get rid of the Ready time we can add -NoReady.
Etwanalyzer %f% -dump CPU -pn System -methods * -MinMaxCPUMs 50s-51s -smi -id -clip -NoReady
That small intro showed some of the key features of ETWAnalyzer. With this tool it is easy to detect patterns in thousands of ETL files which was an impossible task with other publicly available tools. If you have performance trending tests it makes a lot of sense to run them with ETW profiling enabled so you can later find systematic deviations with a simple query. Issues which were before that tool too much work to track down are now a simple query. If your test is e.g. 3/30 times 20% slower you can query all tests for common patterns to see if e.g. a running Windows Installer did have an effect to your test execution time or if that did occur in other fast tests as well.