aboutsummaryrefslogtreecommitdiff
path: root/plugin/erratic/README.md
blob: 5e2b06bc72f367d84084e37931509ebbdf927064 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# 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).