2016-04-28 10:26:58 +01:00
|
|
|
# pprof
|
|
|
|
|
|
2017-09-15 22:27:55 +01:00
|
|
|
*pprof* publishes runtime profiling data at endpoints under `/debug/pprof`.
|
2017-07-24 08:24:53 -07:00
|
|
|
|
|
|
|
|
You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
|
|
|
|
|
will listen on localhost:6053.
|
2016-04-28 10:26:58 +01:00
|
|
|
|
|
|
|
|
> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
|
|
|
|
|
> you use pprof on a live site, consider restricting access or enabling it only temporarily.
|
|
|
|
|
|
|
|
|
|
For more information, please see [Go's pprof
|
2017-04-21 14:17:50 -04:00
|
|
|
documentation](https://golang.org/pkg/net/http/pprof/) and read
|
2016-04-28 10:26:58 +01:00
|
|
|
[Profiling Go Programs](https://blog.golang.org/profiling-go-programs).
|
|
|
|
|
|
|
|
|
|
## Syntax
|
|
|
|
|
|
|
|
|
|
~~~
|
2017-04-24 10:27:26 -04:00
|
|
|
pprof [ADDRESS]
|
2016-04-28 10:26:58 +01:00
|
|
|
~~~
|
|
|
|
|
|
2017-04-24 10:27:26 -04:00
|
|
|
If not specified, ADDRESS defaults to localhost:6053.
|
|
|
|
|
|
2016-04-28 10:26:58 +01:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
Enable pprof endpoints:
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
pprof
|
|
|
|
|
~~~
|
2017-04-24 10:27:26 -04:00
|
|
|
|
|
|
|
|
Listen on an alternate address:
|
|
|
|
|
|
|
|
|
|
~~~
|
2017-09-15 09:56:05 +01:00
|
|
|
. {
|
|
|
|
|
pprof 10.9.8.7:6060
|
|
|
|
|
}
|
2017-04-24 10:27:26 -04:00
|
|
|
~~~
|
|
|
|
|
|
|
|
|
|
Listen on an all addresses on port 6060:
|
|
|
|
|
|
|
|
|
|
~~~
|
|
|
|
|
pprof :6060
|
|
|
|
|
~~~
|
