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

net/http/pprof: document all available default profiles #27737

Open
nhooyr opened this issue Sep 18, 2018 · 3 comments
Open

net/http/pprof: document all available default profiles #27737

nhooyr opened this issue Sep 18, 2018 · 3 comments

Comments

@nhooyr
Copy link
Contributor

@nhooyr nhooyr commented Sep 18, 2018

The docs at the moment only mention a few of the available profiles.

See https://golang.org/pkg/net/http/pprof/

But there are plenty more:

var profileDescriptions = map[string]string{
  	"allocs":       "A sampling of all past memory allocations",
  	"block":        "Stack traces that led to blocking on synchronization primitives",
  	"cmdline":      "The command line invocation of the current program",
  	"goroutine":    "Stack traces of all current goroutines",
  	"heap":         "A sampling of memory allocations of live objects. You can specify the gc GET parameter to run GC before taking the heap sample.",
  	"mutex":        "Stack traces of holders of contended mutexes",
  	"profile":      "CPU profile. You can specify the duration in the seconds GET parameter. After you get the profile file, use the go tool pprof command to investigate the profile.",
  	"threadcreate": "Stack traces that led to the creation of new OS threads",
  	"trace":        "A trace of execution of the current program. You can specify the duration in the seconds GET parameter. After you get the trace file, use the go tool trace command to investigate the trace.",
  }

Should also document the behaviour of the "debug" query parameter controlling the response content type.

@agnivade
Copy link
Contributor

@agnivade agnivade commented Sep 18, 2018

The profileDescriptions that you refer to is the output that is returned in /debug/pprof - which is a combined output of all profiles.

But net/http/pprof documentation should show only profiles from that package. The other profiles are from runtime/pprof. And it is documented there - https://golang.org/pkg/runtime/pprof/#Profile.

I don't think we should duplicate documentation across packages.

Loading

@nhooyr
Copy link
Contributor Author

@nhooyr nhooyr commented Sep 18, 2018

I don't think we should duplicate documentation across packages.

At the very least we should link to it.

Loading

@agnivade
Copy link
Contributor

@agnivade agnivade commented Sep 19, 2018

Loading

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
3 participants