Skip to content

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

@nhooyr

Description

@nhooyr

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues describing a change to documentation.FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions