Files
coredns/plugin/pprof/README.md
Miek Gieben 58221f55db Manual pages (#1346)
* Add manual pages

Generate manual pages from the README and extend README with Name and
Description sections.

The generation requires 'ronn' which may not be available. Just check in
all generated manual pages.
2018-01-04 12:53:07 +00:00

57 lines
1.1 KiB
Markdown

# pprof
## Name
*pprof* - publishes runtime profiling data at endpoints under `/debug/pprof`.
## Description
You can visit `/debug/pprof` on your site for an index of the available endpoints. By default it
will listen on localhost:6053.
> This is a debugging tool. Certain requests (such as collecting execution traces) can be slow. If
> you use pprof on a live server, consider restricting access or enabling it only temporarily.
For more information, please see [Go's pprof
documentation](https://golang.org/pkg/net/http/pprof/) and read
[Profiling Go Programs](https://blog.golang.org/profiling-go-programs).
## Syntax
~~~
pprof [ADDRESS]
~~~
If not specified, ADDRESS defaults to localhost:6053.
## Examples
Enable pprof endpoints:
~~~
. {
pprof
}
~~~
Listen on an alternate address:
~~~ txt
. {
pprof 10.9.8.7:6060
}
~~~
Listen on an all addresses on port 6060:
~~~ txt
. {
pprof :6060
}
~~~
# Also See
See [Go's pprof documentation](https://golang.org/pkg/net/http/pprof/) and [Profiling Go
Programs](https://blog.golang.org/profiling-go-programs).