mirror of
https://github.com/coredns/coredns.git
synced 2025-12-05 09:55:10 -05:00
docs: Regenerate all manpages using mmark (#2762)
Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
GitHub
@@ -1,103 +1,116 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-PPROF" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIpprof\fR \- publishes runtime profiling data at endpoints under \fB/debug/pprof\fR\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
You can visit \fB/debug/pprof\fR on your site for an index of the available endpoints\. By default it will listen on localhost:6053\.
|
||||
.
|
||||
.P
|
||||
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\.
|
||||
.
|
||||
.P
|
||||
This plugin can only be used once per Server Block\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-PPROF" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH PPROF
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIpprof\fP - publishes runtime profiling data at endpoints under \fB\fC/debug/pprof\fR.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
You can visit \fB\fC/debug/pprof\fR on your site for an index of the available endpoints. By default it
|
||||
will listen on localhost:6053.
|
||||
|
||||
.PP
|
||||
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.
|
||||
|
||||
.PP
|
||||
This plugin can only be used once per Server Block.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
pprof [ADDRESS]
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.P
|
||||
Optionally pprof takes an address; the default is \fBlocalhost:6053\fR\.
|
||||
.
|
||||
.P
|
||||
An extra option can be set with this extended syntax:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Optionally pprof takes an address; the default is \fB\fClocalhost:6053\fR.
|
||||
|
||||
.PP
|
||||
An extra option can be set with this extended syntax:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
pprof [ADDRESS] {
|
||||
block [RATE]
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBblock\fR option enables block profiling, \fBRATE\fR defaults to 1\. \fBRATE\fR must be a positive value\. See Diagnostics, chapter profiling \fIhttps://golang\.org/doc/diagnostics\.html\fR and runtime\.SetBlockProfileRate \fIhttps://golang\.org/pkg/runtime/#SetBlockProfileRate\fR for what block profiling entails\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Enable a pprof endpoint:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCblock\fR option enables block profiling, \fBRATE\fP defaults to 1. \fBRATE\fP must be a positive value.
|
||||
See Diagnostics, chapter profiling
|
||||
\[la]https://golang.org/doc/diagnostics.html\[ra] and
|
||||
runtime.SetBlockProfileRate
|
||||
\[la]https://golang.org/pkg/runtime/#SetBlockProfileRate\[ra] for what block
|
||||
profiling entails.
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Enable a pprof endpoint:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
pprof
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
And use the pprof tool to get statistics: \fBgo tool pprof http://localhost:6053\fR\.
|
||||
.
|
||||
.P
|
||||
.RE
|
||||
|
||||
.PP
|
||||
And use the pprof tool to get statistics: \fB\fCgo tool pprof http://localhost:6053\fR.
|
||||
|
||||
.PP
|
||||
Listen on an alternate address:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
pprof 10\.9\.8\.7:6060
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
pprof 10.9.8.7:6060
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Listen on an all addresses on port 6060, and enable block profiling
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Listen on an all addresses on port 6060, and enable block profiling
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
pprof :6060 {
|
||||
block
|
||||
}
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "ALSO SEE"
|
||||
See Go\'s pprof documentation \fIhttps://golang\.org/pkg/net/http/pprof/\fR and Profiling Go Programs \fIhttps://blog\.golang\.org/profiling\-go\-programs\fR\.
|
||||
.
|
||||
.P
|
||||
See runtime\.SetBlockProfileRate \fIhttps://golang\.org/pkg/runtime/#SetBlockProfileRate\fR for background on block profiling\.
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.PP
|
||||
See Go's pprof documentation
|
||||
\[la]https://golang.org/pkg/net/http/pprof/\[ra] and Profiling Go
|
||||
Programs
|
||||
\[la]https://blog.golang.org/profiling-go-programs\[ra].
|
||||
|
||||
.PP
|
||||
See runtime.SetBlockProfileRate
|
||||
\[la]https://golang.org/pkg/runtime/#SetBlockProfileRate\[ra] for
|
||||
background on block profiling.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user