From 89d80bf87eb0c2bcefd8d58621c48da9e0841cfc Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sun, 16 Aug 2020 14:58:42 +0200 Subject: [PATCH] Add documentation for the new data-dependent additonal_info field Signed-off-by: DL6ER --- docs/database/ftl.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/database/ftl.md b/docs/database/ftl.md index fb3aef9..d5e615a 100644 --- a/docs/database/ftl.md +++ b/docs/database/ftl.md @@ -49,6 +49,23 @@ Label | Type | Allowed to by empty | Content `domain` | text | No | Requested domain `client` | text | No | Requesting client (IP address) `forward` | text | Yes | Forward destination used for this query (only set if `status == 2`) +`additional_info` | blob | Yes | Data-dependent content, see below + +#### Data-dependent `additional_info` field + +The content and type of the `additional_info` row depends on the status of the given query. + +##### Query blocked due to a CNAME inspection (status 9, 10, 11) {#additional_info_cname data-toc-label='Blocked CNAME'} + +If a query was blocked due to a CNAME inspection (status 9, 10, 11), this field contains the domain which was the reason for blocking the entire CNAME chain (text). + +##### Query blocked due to a REGEX filter (status 4) {#additional_info_regex data-toc-label='Regular expression'} + +If a query was blocked due to a regex rule (status 4), this field contains the ID of the blacklist regex responsible for blocking this domain (integer). + +##### Other + +For any other query status, this field is empty. You should, however, not rely on this field being empty as we may add content of any type for other status types in future releases. ### Counters table