Overview

Package pprof serves via its HTTP server runtime profiling data in the format
expected by the pprof visualization tool.

The package is typically only imported for the side effect of registering its
HTTP handlers. The handled paths all begin with /debug/pprof/.

To use pprof, link this package into your program:

If your application is not already running an http server, you need to start
one. Add “net/http” and “log” to your imports and the following code to your
main function:

  1. go func() {
  2.     log.Println(http.ListenAndServe("localhost:6060", nil))

Then use the pprof tool to look at the heap profile:

    Or to look at a 30-second CPU profile:

    1. go tool pprof http://localhost:6060/debug/pprof/profile

    Or to look at the goroutine blocking profile, after calling
    runtime.SetBlockProfileRate in your program:

    Or to collect a 5-second execution trace:

    1. go tool pprof http://localhost:6060/debug/pprof/mutex

    To view all available profiles, open in your
    browser.

    For a study of the facility in action, visit

    1. https://blog.golang.org/2011/06/profiling-go-programs.html

    Index

    pprof.go

    Cmdline responds with the running program’s command line, with arguments
    separated by NUL bytes. The package initialization registers it as
    /debug/pprof/cmdline.

    func 

    1. func Handler(name ) http.

    Handler returns an HTTP handler that serves the named profile.

    func Index

    1. func Index(w http., r *http.)

    Index responds with the pprof-formatted profile named by the request. For
    example, “/debug/pprof/heap” serves the “heap” profile. Index responds to a
    request for “/debug/pprof/“ with an HTML page listing the available profiles.

    1. func Profile(w http., r *http.)

    Profile responds with the pprof-formatted cpu profile. The package
    initialization registers it as /debug/pprof/profile.

    func Symbol

    Symbol looks up the program counters listed in the request, responding with a
    table mapping program counters to function names. The package initialization
    registers it as /debug/pprof/symbol.

    func Trace

      Trace responds with the execution trace in binary form. Tracing lasts for
      duration specified in seconds GET parameter, or for 1 second if not specified.
      The package initialization registers it as /debug/pprof/trace.