mirror of
https://github.com/coredns/coredns.git
synced 2026-01-06 08:51:20 -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,139 +1,146 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-DNSTAP" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIdnstap\fR \- enable logging to dnstap\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
dnstap is a flexible, structured binary log format for DNS software: http://dnstap\.info\. With this plugin you make CoreDNS output dnstap logging\.
|
||||
.
|
||||
.P
|
||||
Note that there is an internal buffer, so expect at least 13 requests before the server sends its dnstap messages to the socket\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-DNSTAP" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH DNSTAP
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIdnstap\fP - enable logging to dnstap.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
dnstap is a flexible, structured binary log format for DNS software: http://dnstap.info
|
||||
\[la]http://dnstap.info\[ra]. With this
|
||||
plugin you make CoreDNS output dnstap logging.
|
||||
|
||||
.PP
|
||||
Note that there is an internal buffer, so expect at least 13 requests before the server sends its
|
||||
dnstap messages to the socket.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
dnstap SOCKET [full]
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBSOCKET\fR is the socket path supplied to the dnstap command line tool\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfull\fR to include the wire\-format DNS message\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Log information about client requests and responses to \fI/tmp/dnstap\.sock\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
dnstap /tmp/dnstap\.sock
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Log information including the wire\-format DNS message about client requests and responses to \fI/tmp/dnstap\.sock\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fBSOCKET\fP is the socket path supplied to the dnstap command line tool.
|
||||
.IP \(bu 4
|
||||
\fB\fCfull\fR to include the wire-format DNS message.
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Log information about client requests and responses to \fI/tmp/dnstap.sock\fP.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
dnstap /tmp/dnstap.sock
|
||||
|
||||
dnstap unix:///tmp/dnstap\.sock full
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Log to a remote endpoint\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Log information including the wire-format DNS message about client requests and responses to \fI/tmp/dnstap.sock\fP.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
dnstap unix:///tmp/dnstap.sock full
|
||||
|
||||
dnstap tcp://127\.0\.0\.1:6000 full
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "COMMAND LINE TOOL"
|
||||
Dnstap has a command line tool that can be used to inspect the logging\. The tool can be found at Github: \fIhttps://github\.com/dnstap/golang\-dnstap\fR\. It\'s written in Go\.
|
||||
.
|
||||
.P
|
||||
The following command listens on the given socket and decodes messages to stdout\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Log to a remote endpoint.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
dnstap tcp://127.0.0.1:6000 full
|
||||
|
||||
$ dnstap \-u /tmp/dnstap\.sock
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The following command listens on the given socket and saves message payloads to a binary dnstap\-format log file\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.SH COMMAND LINE TOOL
|
||||
.PP
|
||||
Dnstap has a command line tool that can be used to inspect the logging. The tool can be found
|
||||
at Github: https://github.com/dnstap/golang-dnstap
|
||||
\[la]https://github.com/dnstap/golang-dnstap\[ra]. It's written in Go.
|
||||
|
||||
.PP
|
||||
The following command listens on the given socket and decodes messages to stdout.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ dnstap \-u /tmp/dnstap.sock
|
||||
|
||||
$ dnstap \-u /tmp/dnstap\.sock \-w /tmp/test\.dnstap
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Listen for dnstap messages on port 6000\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
The following command listens on the given socket and saves message payloads to a binary dnstap-format log file.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ dnstap \-u /tmp/dnstap.sock \-w /tmp/test.dnstap
|
||||
|
||||
$ dnstap \-l 127\.0\.0\.1:6000
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "USING DNSTAP IN YOUR PLUGIN"
|
||||
.
|
||||
.nf
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Listen for dnstap messages on port 6000.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
$ dnstap \-l 127.0.0.1:6000
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH USING DNSTAP IN YOUR PLUGIN
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
import (
|
||||
"github\.com/coredns/coredns/plugin/dnstap"
|
||||
"github\.com/coredns/coredns/plugin/dnstap/msg"
|
||||
"github.com/coredns/coredns/plugin/dnstap"
|
||||
"github.com/coredns/coredns/plugin/dnstap/msg"
|
||||
)
|
||||
|
||||
func (h Dnstap) ServeDNS(ctx context\.Context, w dns\.ResponseWriter, r *dns\.Msg) (int, error) {
|
||||
func (h Dnstap) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error) {
|
||||
// log client query to Dnstap
|
||||
if t := dnstap\.TapperFromContext(ctx); t != nil {
|
||||
b := msg\.New()\.Time(time\.Now())\.Addr(w\.RemoteAddr())
|
||||
if t\.Pack() {
|
||||
b\.Msg(r)
|
||||
if t := dnstap.TapperFromContext(ctx); t != nil {
|
||||
b := msg.New().Time(time.Now()).Addr(w.RemoteAddr())
|
||||
if t.Pack() {
|
||||
b.Msg(r)
|
||||
}
|
||||
if m, err := b\.ToClientQuery(); err == nil {
|
||||
t\.TapMessage(m)
|
||||
if m, err := b.ToClientQuery(); err == nil {
|
||||
t.TapMessage(m)
|
||||
}
|
||||
}
|
||||
|
||||
// \.\.\.
|
||||
// ...
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
dnstap\.info \fIhttp://dnstap\.info\fR\.
|
||||
.RE
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
dnstap.info
|
||||
\[la]http://dnstap.info\[ra].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user