coredns/man/coredns-log.7

.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOG" 7 "November 2020" "CoreDNS" "CoreDNS Plugins"

.SH "NAME"
.PP
\fIlog\fP - enables query logging to standard output.

.SH "DESCRIPTION"
.PP
By just using \fIlog\fP you dump all queries (and parts for the reply) on standard output. Options exist
to tweak the output a little. Note that for busy servers logging will incur a performance hit.

.PP
Enabling or disabling the \fIlog\fP plugin only affects the query logging, any other logging from
CoreDNS will show up regardless.

.SH "SYNTAX"
.PP
.RS

.nf
log

.fi
.RE

.PP
With no arguments, a query log entry is written to \fIstdout\fP in the common log format for all requests.
Or if you want/need slightly more control:

.PP
.RS

.nf
log [NAMES...] [FORMAT]

.fi
.RE

.IP \(bu 4
\fB\fCNAMES\fR is the name list to match in order to be logged
.IP \(bu 4
\fB\fCFORMAT\fR is the log format to use (default is Common Log Format), \fB\fC{common}\fR is used as a shortcut
for the Common Log Format. You can also use \fB\fC{combined}\fR for a format that adds the query opcode
\fB\fC{>opcode}\fR to the Common Log Format.


.PP
You can further specify the classes of responses that get logged:

.PP
.RS

.nf
log [NAMES...] [FORMAT] {
    class CLASSES...
}

.fi
.RE

.IP \(bu 4
\fB\fCCLASSES\fR is a space-separated list of classes of responses that should be logged


.PP
The classes of responses have the following meaning:

.IP \(bu 4
\fB\fCsuccess\fR: successful response
.IP \(bu 4
\fB\fCdenial\fR: either NXDOMAIN or nodata responses (Name exists, type does not). A nodata response
sets the return code to NOERROR.
.IP \(bu 4
\fB\fCerror\fR: SERVFAIL, NOTIMP, REFUSED, etc. Anything that indicates the remote server is not willing to
resolve the request.
.IP \(bu 4
\fB\fCall\fR: the default - nothing is specified. Using of this class means that all messages will be
logged whatever we mix together with "all".


.PP
If no class is specified, it defaults to \fB\fCall\fR.

.SH "LOG FORMAT"
.PP
You can specify a custom log format with any placeholder values. Log supports both request and
response placeholders.

.PP
The following place holders are supported:

.IP \(bu 4
\fB\fC{type}\fR: qtype of the request
.IP \(bu 4
\fB\fC{name}\fR: qname of the request
.IP \(bu 4
\fB\fC{class}\fR: qclass of the request
.IP \(bu 4
\fB\fC{proto}\fR: protocol used (tcp or udp)
.IP \(bu 4
\fB\fC{remote}\fR: client's IP address, for IPv6 addresses these are enclosed in brackets: \fB\fC[::1]\fR
.IP \(bu 4
\fB\fC{local}\fR: server's IP address, for IPv6 addresses these are enclosed in brackets: \fB\fC[::1]\fR
.IP \(bu 4
\fB\fC{size}\fR: request size in bytes
.IP \(bu 4
\fB\fC{port}\fR: client's port
.IP \(bu 4
\fB\fC{duration}\fR: response duration
.IP \(bu 4
\fB\fC{rcode}\fR: response RCODE
.IP \(bu 4
\fB\fC{rsize}\fR: raw (uncompressed), response size (a client may receive a smaller response)
.IP \(bu 4
\fB\fC{>rflags}\fR: response flags, each set flag will be displayed, e.g. "aa, tc". This includes the qr
bit as well
.IP \(bu 4
\fB\fC{>bufsize}\fR: the EDNS0 buffer size advertised in the query
.IP \(bu 4
\fB\fC{>do}\fR: is the EDNS0 DO (DNSSEC OK) bit set in the query
.IP \(bu 4
\fB\fC{>id}\fR: query ID
.IP \(bu 4
\fB\fC{>opcode}\fR: query OPCODE
.IP \(bu 4
\fB\fC{common}\fR: the default Common Log Format.
.IP \(bu 4
\fB\fC{combined}\fR: the Common Log Format with the query opcode.
.IP \(bu 4
\fB\fC{/LABEL}\fR: any metadata label is accepted as a place holder if it is enclosed between \fB\fC{/\fR and
\fB\fC}\fR, the place holder will be replaced by the corresponding metadata value or the default value
\fB\fC-\fR if label is not defined. See the \fImetadata\fP plugin for more information.


.PP
The default Common Log Format is:

.PP
.RS

.nf
`{remote}:{port} \- {>id} "{type} {class} {name} {proto} {size} {>do} {>bufsize}" {rcode} {>rflags} {rsize} {duration}`

.fi
.RE

.PP
Each of these logs will be outputted with \fB\fClog.Infof\fR, so a typical example looks like this:

.PP
.RS

.nf
[INFO] [::1]:50759 \- 29008 "A IN example.org. udp 41 false 4096" NOERROR qr,rd,ra,ad 68 0.037990251s
~~~~

## Examples

Log all requests to stdout

~~~ corefile
\&. {
    log
    whoami
}

.fi
.RE

.PP
Custom log format, for all zones (\fB\fC.\fR)

.PP
.RS

.nf
\&. {
    log . "{proto} Request: {name} {type} {>id}"
}

.fi
.RE

.PP
Only log denials (NXDOMAIN and nodata) for example.org (and below)

.PP
.RS

.nf
\&. {
    log example.org {
        class denial
    }
}

.fi
.RE

.PP
Log all queries which were not resolved successfully in the Combined Log Format.

.PP
.RS

.nf
\&. {
    log . {combined} {
        class denial error
    }
}

.fi
.RE

.PP
Log all queries on which we did not get errors

.PP
.RS

.nf
\&. {
    log . {
        class denial success
    }
}

.fi
.RE

.PP
Also the multiple statements can be OR-ed, for example, we can rewrite the above case as following:

.PP
.RS

.nf
\&. {
    log . {
        class denial
        class success
    }
}

.fi
.RE