doc update (#1140)

* doc update

Go through all README and fix mistakes, extend example and let more
corefile snippets be test for validity.

* Cant use spefic addr in test
This commit is contained in:
Miek Gieben
2017-10-10 09:39:35 +02:00
committed by GitHub
parent 7c6ba3fcbd
commit 427aed6f5b
17 changed files with 112 additions and 88 deletions

View File

@@ -11,23 +11,22 @@ log
* With no arguments, a query log entry is written to *stdout* in the common log format for all requests
~~~ txt
log FILE
log [stdout]
~~~
* **FILE** is the log file to create (or append to). The *only* valid name for **FILE** is *stdout*.
Or if you want/need slightly more control:
~~~ txt
log [NAME] FILE [FORMAT]
log [NAME] stdout [FORMAT]
~~~
* `NAME` is the name to match in order to be logged
* `FILE` is the log file (again only *stdout* is allowed here).
* `FORMAT` is the log format to use (default is Common Log Format)
You can further specify the class of responses that get logged:
~~~ txt
log [NAME] FILE [FORMAT] {
log [NAME] stdout [FORMAT] {
class [success|denial|error|all]
}
~~~
@@ -43,11 +42,6 @@ classes have the following meaning:
If no class is specified, it defaults to *all*.
## Log File
The "log file" can only be *stdout*. CoreDNS expects another service to pick up this output and deal
with it, i.e. journald when using systemd or Docker's logging capabilities.
## Log Format
You can specify a custom log format with any placeholder values. Log supports both request and
@@ -83,20 +77,27 @@ The default Common Log Format is:
Log all requests to stdout
~~~
log stdout
~~~ corefile
. {
log
whoami
}
~~~
Custom log format, for all zones (`.`)
~~~
log . stdout "{proto} Request: {name} {type} {>id}"
~~~ corefile
. {
log . stdout "{proto} Request: {name} {type} {>id}"
}
~~~
Only log denials for example.org (and below to a file)
~~~
log example.org stdout {
class denial
~~~ corefile
. {
log example.org stdout {
class denial
}
}
~~~