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

cmd/pprof: provide help page #43569

Open
rogpeppe opened this issue Jan 7, 2021 · 2 comments
Open

cmd/pprof: provide help page #43569

rogpeppe opened this issue Jan 7, 2021 · 2 comments

Comments

@rogpeppe
Copy link
Contributor

@rogpeppe rogpeppe commented Jan 7, 2021

The pprof tool helpfully provides a -http flag that opens a web page with an interactive view, but there's no easy way of telling what elements of the UI mean or do. For example, it would be useful to have a key to the diagrams to say what the numbers mean and what's the difference between a dotted and a solid line, etc.

As it is, the user is left to google for potentially relevant articles blog posts that might or might not be out of date now.

At the very least, a link to an online documentation page would be good, although that might suffer from potential version skew if the URL isn't versioned.

@toothrot toothrot added this to the Backlog milestone Jan 8, 2021
@toothrot
Copy link
Contributor

@toothrot toothrot commented Jan 8, 2021

/cc @hyangah

@hyangah
Copy link
Contributor

@hyangah hyangah commented Jan 8, 2021

All the involved code comes from the upstream. Can you please file an issue in https://github.com/google/pprof?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants