bcc749db04
* Doc updates Make the name section fit on one line. Signed-off-by: Miek Gieben <miek@miek.nl> * Regen docs Signed-off-by: Miek Gieben <miek@miek.nl>
93 lines
2 KiB
Markdown
93 lines
2 KiB
Markdown
# dnstap
|
|
|
|
## Name
|
|
|
|
*dnstap* - enable logging to dnstap.
|
|
|
|
## Description
|
|
|
|
dnstap is a flexible, structured binary log format for DNS software: http://dnstap.info. With this
|
|
plugin you make CoreDNS output dnstap logging.
|
|
|
|
Note that there is an internal buffer, so expect at least 13 requests before the server sends its
|
|
dnstap messages to the socket.
|
|
|
|
## Syntax
|
|
|
|
~~~ txt
|
|
dnstap SOCKET [full]
|
|
~~~
|
|
|
|
* **SOCKET** is the socket path supplied to the dnstap command line tool.
|
|
* `full` to include the wire-format DNS message.
|
|
|
|
## Examples
|
|
|
|
Log information about client requests and responses to */tmp/dnstap.sock*.
|
|
|
|
~~~ txt
|
|
dnstap /tmp/dnstap.sock
|
|
~~~
|
|
|
|
Log information including the wire-format DNS message about client requests and responses to */tmp/dnstap.sock*.
|
|
|
|
~~~ txt
|
|
dnstap unix:///tmp/dnstap.sock full
|
|
~~~
|
|
|
|
Log to a remote endpoint.
|
|
|
|
~~~ txt
|
|
dnstap tcp://127.0.0.1:6000 full
|
|
~~~
|
|
|
|
## Command Line Tool
|
|
|
|
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>. It's written in Go.
|
|
|
|
The following command listens on the given socket and decodes messages to stdout.
|
|
|
|
~~~ sh
|
|
$ dnstap -u /tmp/dnstap.sock
|
|
~~~
|
|
|
|
The following command listens on the given socket and saves message payloads to a binary dnstap-format log file.
|
|
|
|
~~~ sh
|
|
$ dnstap -u /tmp/dnstap.sock -w /tmp/test.dnstap
|
|
~~~
|
|
|
|
Listen for dnstap messages on port 6000.
|
|
|
|
~~~ sh
|
|
$ dnstap -l 127.0.0.1:6000
|
|
~~~
|
|
|
|
## Using Dnstap in your plugin
|
|
|
|
~~~ Go
|
|
import (
|
|
"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) {
|
|
// 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 m, err := b.ToClientQuery(); err == nil {
|
|
t.TapMessage(m)
|
|
}
|
|
}
|
|
|
|
// ...
|
|
}
|
|
~~~
|
|
|
|
## See Also
|
|
|
|
[dnstap.info](http://dnstap.info).
|