Maintain stable root names for heap snapshots

microsoft / perfview

PerfView is a CPU and memory performance-analysis tool

http://channel9.msdn.com/Series/PerfView-Tutorial

MIT License

4.06k stars 696 forks source link

Maintain stable root names for heap snapshots #1975

Closed brianrob closed 6 months ago

brianrob commented 6 months ago

The goal of this change is to ensure that we don't unexpectedly change root names.

Detect if the set of roots changes via a test.
Add code comments to document these changes via release notes.

leculver commented 6 months ago

This looks right to me, though the reported issue of names changing feels different from what's being fixed here. They were taking a dependency on some things like "Strong handle" vs "StrongHandle" vs etc, but the code as it exists here wouldn't produce different values.

In short, this change looks like a good addition, definitely check it in...but I feel like we are missing something.

brianrob commented 6 months ago

You're right - I did a bit more digging and it looks like the path that creates a gdcump file by listening to ETW specifies a different set of strings. Let me work to unify this path and then update this PR.

brianrob commented 6 months ago

I just added another commit that unifies names for the two paths that create heap snapshots. This is a breaking change, but should work for tools that are already trying to consume both cases.