Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide information on other profiling tools #22

Open
cheechak opened this issue Oct 9, 2020 · 4 comments
Open

Provide information on other profiling tools #22

cheechak opened this issue Oct 9, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@cheechak
Copy link

cheechak commented Oct 9, 2020

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.

@connor4312 connor4312 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 9, 2020
@hkaur008
Copy link
Contributor

Hey , Is this issue still available to take up ?

@connor4312
Copy link
Member

Sure, PR's welcome

@hkaur008
Copy link
Contributor

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
Copy link
Member

connor4312 commented May 26, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants