coredns/plugin/erratic/README.md
Miek Gieben c2e4f2f1ab
docs: move Also See to See Also (#4245)
sed -i 's/Also See/See Also/' plugin/**/README.md

Some plugins did already use 'See Also', so it's all consistent now.

Fixes: #4196

Signed-off-by: Miek Gieben <miek@miek.nl>
2020-10-28 10:56:35 -07:00

89 lines
1.7 KiB
Markdown

# erratic
## Name
*erratic* - a plugin useful for testing client behavior.
## Description
*erratic* returns a static response to all queries, but the responses can be delayed,
dropped or truncated. The *erratic* plugin will respond to every A or AAAA query. For
any other type it will return a SERVFAIL response (except AXFR). The reply for A will return
192.0.2.53 ([RFC 5737](https://tools.ietf.org/html/rfc5737)), for AAAA it returns 2001:DB8::53 ([RFC
3849](https://tools.ietf.org/html/rfc3849)). For an AXFR request it will respond with a small
zone transfer.
## Syntax
~~~ txt
erratic {
drop [AMOUNT]
truncate [AMOUNT]
delay [AMOUNT [DURATION]]
}
~~~
* `drop`: drop 1 per **AMOUNT** of queries, the default is 2.
* `truncate`: truncate 1 per **AMOUNT** of queries, the default is 2.
* `delay`: delay 1 per **AMOUNT** of queries for **DURATION**, the default for **AMOUNT** is 2 and
the default for **DURATION** is 100ms.
In case of a zone transfer and truncate the final SOA record *isn't* added to the response.
## Ready
This plugin reports readiness to the ready plugin.
## Examples
~~~ corefile
example.org {
erratic {
drop 3
}
}
~~~
Or even shorter if the defaults suit you. Note this only drops queries, it does not delay them.
~~~ corefile
example.org {
erratic
}
~~~
Delay 1 in 3 queries for 50ms
~~~ corefile
example.org {
erratic {
delay 3 50ms
}
}
~~~
Delay 1 in 3 and truncate 1 in 5.
~~~ corefile
example.org {
erratic {
delay 3 5ms
truncate 5
}
}
~~~
Drop every second query.
~~~ corefile
example.org {
erratic {
drop 2
truncate 2
}
}
~~~
## See Also
[RFC 3849](https://tools.ietf.org/html/rfc3849) and [RFC 5737](https://tools.ietf.org/html/rfc5737).