ETW Central

Over the last few years I’ve written over forty blog posts that discuss ETW/xperf profiling. I’ve done this because it’s one of the best profilers I’ve ever used, and it’s been woefully undersold and under documented by Microsoft. My goal has been to let people know about this tool, make it easier for developers and users to record ETW traces, and to make it as easy as possible for developers to analyze ETW traces.

Some of those posts have aged poorly, and the rest are hidden amongst the 210+ posts (really? wow) I’ve written. The purpose of this page is to be a central hub that links to the ETW/xperf posts that are still relevant. Also, I’ve updated many of the older posts to reflect changes in the ETW toolset (technically known as the Windows Performance Toolkit). For convenience this page is accessible as https://tinyurl.com/etwcentral.

The most important post describes how to record ETW traces. This is important because ETW traces can be recorded on one machine, and analyzed on another. This means that your customers or relatives can record ETW traces and then you can analyze them. Remote diagnosis of issues is a wonderful superpower. The article describing how to record an xperf/ETW trace can be found here – share it with those who have performance problems:

Xperf Basics: Recording a Trace (the ultimate easy way)

Once you’ve got a trace you need to analyze it (or share it with someone who can). The most comprehensive resource I’ve created for learning how to analyze ETW traces is the series of three videos I created in 2014. More information and links to the videos can be found here:

ETW Training Videos Available Now

For more details, or if you don’t want to watch videos, there are many tutorial blog posts available, listed here in rough order of importance:

Doing precise analysis of an ETW trace requires knowing exactly what the many columns in the tables mean. Some of those table columns are documented in these blog posts, updated in 2016 for the latest version of WPA:

ETW investigation write-ups:

Some of my favorite blog posts are those that tell a tale of noticing some software that I use being slow, recording a trace, and figuring out the problem. In most cases this let me come up with a workaround, and in many cases the (ridiculously!) detailed bug reports or the attention the posts drew led to the problems being fixed.

Many of the articles linked to below have not yet been updated. It’s an ongoing process but I think it’s worth publishing this now without waiting for all of the updates to finish.

I’ve categorized the investigations by what product was investigated. And, as a reminder, with the exception of the fractal software investigation all of these are looking at problems in software that I don’t work on.

Visual Studio and VC++ code-gen:

Windows Performance Toolkit (profiling the profiler!):

Windows:

Windows Live Photo Gallery:

Western Digital driver (initially thought to be Windows):

Miscellaneous:

Other people’s ETW investigation write-ups:

Obsolete posts

Some of the blog posts are now completely obsolete and are listed here only for historical interest:

Unknown's avatar

About brucedawson

I'm a retired programmer, ex-Google/Valve/Microsoft/etc., who was focused on optimization and reliability. Nothing's more fun than making code run 10x as fast. Unless it's eliminating large numbers of bugs. I also unicycle. And play (ice) hockey. And sled hockey. And juggle. And worry about whether this blog should have been called randomutf-8. 2010s in review tells more: https://twitter.com/BruceDawson0xB/status/1212101533015298048
This entry was posted in , permalink.

41 Responses to ETW Central

  1. Pingback: Summarizing Xperf CPU Usage with Flame Graphs | Random ASCII

  2. Pingback: UIforETW – Windows Performance Made Easier | Random ASCII

  3. Pingback: Xperf Analysis Basics | Random ASCII

  4. Pingback: Exporting Arbitrary Data from xperf ETL files | Random ASCII

  5. Pingback: The New WPA Xperf Trace Viewer–New Bugs and Old | Random ASCII

  6. Pingback: WPA–Xperf Trace Analysis Reimagined | Random ASCII

  7. Pingback: Process Tree from an Xperf Trace | Random ASCII

  8. Pingback: Xperf Wait Analysis–Finding Idle Time | Random ASCII

  9. Pingback: Xperf and Visual Studio: The Case of the Breakpoint Hangs | Random ASCII

  10. Pingback: Thread Naming in Windows: Time for Something Better | Random ASCII

  11. Severin Pappadeux's avatar Severin Pappadeux says:

    Did you use logman? Is it better/worse than xperf? Reply

    • brucedawson's avatar Severin Pappadeux says:

      Not that it can do something different, but on my W10 installation it came with the system, C:\Windows\System32\logman.exe. Basically, if you install something on user system, looks like it is much better to run logman as an events watchman for your app

        • brucedawson's avatar Max says:

          Hello,

          Thanks for all your training material for WPA/WPR. I’m trying to learn more about Windows and Services in particular. I’m wondering how you would go about using WPA to find out what triggered a particular service to start? I know how to isolate a service into it’s own svchost.exe and I can zoom into where the service starts and I see that services.exe is the process that starts it, but I don’t know how to go about finding out who/what called upon the services.exe to actually start it up.

          Thanks again for all your material!

        • Murat.a's avatar Murat.a says:

          Hi Bruce,
          Please, Is it suitable to launch multiple apps on Windows then record them with WPR, also after a while, launch other apps and so on (every single time e.g. every 8min), then analyze them with WPA. will I get low-performance issues like low JIT compilation, memory consumption, etc? which apps are suitable for that?. Thank you.

          • brucedawson's avatar Murat.a says:

            I’m trying to identify Memory leak, looking for an increasing trend over a long period of time, Which means the application committing memory (referred to a private bytes) and releasing only small portions, and over a period of time it continue to accumulate Memory.
            I’m asking to detect this pattern of Memory consumption Practically.

            Thanks

            • brucedawson's avatar Murat.a says:

              Is it suitable to do it just in WPR/WPA toolkit? or I have to deal with your mentioned tools in Github? because I don’t have much experience to deal with what you explain in Github, maybe just through the tutorial!
              Also, please, is there a way to detect that Memory leak while launching multiple apps, not specific ones? Thanks!

              • brucedawson's avatar Hamlet says:

                Hello Bruce,
                How can I design and Implement an ETW-based Windows system Performance testing tool and give it a name, that system can implement a process collecting, analyzing, and visualizing various events that occur in the Windows system kernel by means of event tracking, and is used to detect the performance that occurs during system operations, and to make it quickly locate the bottleneck and improve the efficiency of the system operations.? I hope if there is a tutorial for this work. Thanks.

                • brucedawson's avatar Hamlet says:

                  Thank you for the reply,
                  sorry, I mean to design that ETW diagnostic tool in .NET

                  • brucedawson's avatar Peter says:

                    hi Bruce

                    when i set the tracing to file the tool stops tracing after 5 minute. i need the whole story from the start, the circular buffer tracing is not enough. i get the message: “Tracing to disk ran excessively long. Auto-saving and stopping.”

                    The size of the file is between 300-500MB. How can I configure the max file size, or the time period of the trace?

                    thanks,
                    np

                    • hi Bruce
                      I want to know how match related CSwitch and ReadyThread events?
                      the ReadyThread events also konwn as DispatcherReadyThreadTraceData,
                      it has no new thread id,only AwakenedThreadId,
                      how to get thr NewThredId?
                      Thank you so much!

                      • brucedawson's avatar coding says:

                        Thank you very much for your reply and suggestion,I will keep trying your suggestion.
                        Now the problem is focused on getting this piece of ETW event, keyWords:0x800: dispatcher: Dispatcher operation. in Microsoft open source code PerfView,This event source is called DispatcherReadyThreadTraceData,the code show as below:

                        public sealed class DispatcherReadyThreadTraceData : TraceEvent
                        {
                        public int AwakenedThreadID { get; }
                        public int AwakenedProcessID { get; }
                        public AdjustReasonEnum AdjustReason { get; }
                        public int AdjustIncrement { get; }
                        public ReadyThreadFlags Flags { get; }
                        public override int ProcessID { get; }
                        public override string[] PayloadNames { get; }
                        protected internal override Delegate Target { get; set; }
                        public event Action Action;
                        public override object PayloadValue(int index);
                        public override StringBuilder ToXml(StringBuilder sb);
                        protected internal override void Dispatch();
                        protected internal override void SetState(object newState);
                        public enum AdjustReasonEnum
                        {
                        None = 0,
                        Unwait = 1,
                        Boost = 2
                        }
                        [Flags]
                        public enum ReadyThreadFlags : byte
                        {
                        ReadiedFromDPC = 1,
                        KernelSwappedOut = 2,
                        ProcessSwappedOut = 4
                        }
                        }

                        I can’t get the current thread id (New ThreadId), and only can get the AwakenedThreadID, no good solution.

Leave a comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.