]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
predict docs: be more explicit about recommended use
authorVladimír Čunát <vladimir.cunat@nic.cz>
Mon, 14 Mar 2022 14:27:54 +0000 (15:27 +0100)
committerVladimír Čunát <vladimir.cunat@nic.cz>
Mon, 14 Mar 2022 14:36:56 +0000 (15:36 +0100)
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/

modules/predict/README.rst

index 634c8d45ccfaa0b0ec24cb80c089998337d799e7..966c4ca4e1d73fd8aa2a04f44dc09b04a1781d6d 100644 (file)
@@ -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
 ----------------