search

microsoft / vscode-js-profile-visualizer

A custom editor for viewing `.cpuprofile` files in VS Code
MIT License
137 stars 29 forks source link

Provide information on other profiling tools #22

Open cheechak opened 3 years ago

cheechak commented 3 years ago

At first it may appears to end users that the .cpuprofile format consumed by the extension may be the one documented here: https://gperftools.github.io/gperftools/cpuprofile-fileformat.html

That would mean that it can be used to visualise profiles of native (non-js) applications generated with gperftools.

However, digging reveals details in the closed issue #1 revealing that the actual format used is: https://chromedevtools.github.io/devtools-protocol/tot/Profiler/#type-Profile

It would be good to make this information more visible, by mentioning it in the extension description and / or repository's readme files.

It might also be useful to provide a link to documentation of the format that is used. It seems clear that there is going to be an appetite to use this extension for visualising profiles from other sources, and knowing the correct target format is the enabling piece of information for doing that.

A guide to any applicable conversion tools, or roadmap for supporting other input formats would probably be welcomed as well.

hkaur008 commented 3 years ago

Hey , Is this issue still available to take up ?

connor4312 commented 3 years ago

Sure, PR's welcome

hkaur008 commented 3 years ago

Can you describe/guide a little more about tasks I have to do under this pull request ? which file I have to work upon?

connor4312 commented 3 years ago

I think putting it in the readme in this repo would be good. Probably a new section saying this viewer actually works for any .cpuprofile file, linking to the devtools url that cheechak shared above. If you're feeling ambitious you could give a brief example and description of the structure of the profile.