coredns/plugin/pprof/README.md
Miek Gieben c2e4f2f1ab
docs: move Also See to See Also (#4245)
sed -i 's/Also See/See Also/' plugin/**/README.md

Some plugins did already use 'See Also', so it's all consistent now.

Fixes: #4196

Signed-off-by: Miek Gieben <miek@miek.nl>
2020-10-28 10:56:35 -07:00

1.6 KiB

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.

This plugin can only be used once per Server Block.

Syntax

pprof [ADDRESS]

Optionally pprof takes an address; the default is localhost:6053.

An extra option can be set with this extended syntax:

pprof [ADDRESS] {
   block [RATE]
}

Examples

Enable a pprof endpoint:

. {
    pprof
}

And use the pprof tool to get statistics: go tool pprof http://localhost:6053.

Listen on an alternate address:

. {
    pprof 10.9.8.7:6060
}

Listen on an all addresses on port 6060, and enable block profiling

. {
    pprof :6060 {
       block
    }
}

See Also

See Go's pprof documentation and Profiling Go Programs.

See runtime.SetBlockProfileRate for background on block profiling.