TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions

plugin/pprof: spice up the readme (#2731)

Browse source 
Rework this a little to be more inline with the other READMEs

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben 2019-03-29 12:47:59 +00:00 • committed by GitHub
parent c144da2524
commit fcb49fe016
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
plugin/pprof/README.md
View file

@ -16,21 +16,28 @@ This plugin can only be used once per Server Block.
## Syntax
~~~ txt
pprof [ADDRESS]
~~~
Optionally pprof takes an address; the default is `localhost:6053`.
An extra option can be set with this extended syntax:
~~~ txt
pprof [ADDRESS] {
block [RATE]
}
~~~
- If not specified, **ADDRESS** defaults to localhost:6053.
- `block` option allow to enable the `block` profiling. see [Diagnostics, chapter profiling](https://golang.org/doc/diagnostics.html).
if you need to use `block` profile, set a positive value to **RATE**. See [runtime.SetBlockProfileRate](https://golang.org/pkg/runtime/#SetBlockProfileRate).
if not specified, **RATE** default's to 1. if `block` option is not specified the `block` profiling is disabled.
* `block` option enables block profiling, **RATE** defaults to 1. **RATE** must be a positive value.
See [Diagnostics, chapter profiling](https://golang.org/doc/diagnostics.html) and
[runtime.SetBlockProfileRate](https://golang.org/pkg/runtime/#SetBlockProfileRate) for what block
profiling entails.
## Examples
Enable pprof endpoints:
Enable a pprof endpoint:
~~~
. {
@ -48,7 +55,7 @@ Listen on an alternate address:
}
~~~
Listen on an all addresses on port 6060: and enable block profiling
Listen on an all addresses on port 6060, and enable block profiling
~~~ txt
. {
@ -62,3 +69,6 @@ Listen on an all addresses on port 6060: and enable block profiling
See [Go's pprof documentation](https://golang.org/pkg/net/http/pprof/) and [Profiling Go
Programs](https://blog.golang.org/profiling-go-programs).
See [runtime.SetBlockProfileRate](https://golang.org/pkg/runtime/#SetBlockProfileRate) for
background on block profiling.