From: Vladimír Čunát Date: Mon, 14 Mar 2022 14:27:54 +0000 (+0100) Subject: predict docs: be more explicit about recommended use X-Git-Tag: v5.5.0~1^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fb7d5e6cde1d2181d926c100a25cd313449c2aff;p=thirdparty%2Fknot-resolver.git predict docs: be more explicit about recommended use We're still run into people who thought that the example config is a suitable default. Example where it caused practical issues: https://lists.nic.cz/hyperkitty/list/knot-resolver-users@lists.nic.cz/thread/WQDJJ3LLEIZ5U3VVSCITW6DZPICW4L7U/ --- diff --git a/modules/predict/README.rst b/modules/predict/README.rst index 634c8d45c..966c4ca4e 100644 --- a/modules/predict/README.rst +++ b/modules/predict/README.rst @@ -22,7 +22,7 @@ Prediction ---------- The predict module can also learn usage patterns and repetitive queries, -though this mechanism is basically a prototype. +though this mechanism is a prototype and **not recommended** for use in production or with high traffic. For example, if it makes a query every day at 18:00, the resolver expects that it is needed by that time and prefetches it ahead of time. @@ -41,13 +41,12 @@ Example configuration modules = { predict = { + -- this mode is NOT RECOMMENDED for use in production window = 15, -- 15 minutes sampling window period = 6*(60/15) -- track last 6 hours } } -Defaults are as above: 15 minutes window, 6 hours period. - Exported metrics ----------------