From: Lukáš Ondráček <lukas.ondracek@nic.cz>
Date: Wed, 15 Jan 2025 16:26:12 +0000 (+0100)
Subject: doc: add price-factor to views
X-Git-Tag: v6.0.10~2^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=647163fbcc2403ba3365ef44780c135bde786827;p=thirdparty%2Fknot-resolver.git

doc: add price-factor to views
---

diff --git a/doc/user/config-defer.rst b/doc/user/config-defer.rst
index 0b948a166..4d26ee403 100644
--- a/doc/user/config-defer.rst
+++ b/doc/user/config-defer.rst
@@ -17,6 +17,8 @@ if there are enough requests of both types.
 
 Detailed configuration is printed by ``defer`` group on ``info`` level on startup (unless disabled).
 
+The limits can be adjusted for different packet origins using :option:`price-factor <price-factor: <float>` in :ref:`views <config-views>`.
+
 .. note::
 
    The data of all deferred queries may occupy 64 MiB of memory per :ref:`worker <config-multiple-workers>`.
diff --git a/doc/user/config-rate-limiting.rst b/doc/user/config-rate-limiting.rst
index 35342bf9e..41984e40a 100644
--- a/doc/user/config-rate-limiting.rst
+++ b/doc/user/config-rate-limiting.rst
@@ -19,6 +19,7 @@ for more in depth introduction to this section,
 but beware that the *soft limit* was dropped in favor of the *slip* mechanism
 that's common in other DNS servers.
 
+The limits can be adjusted for different packet origins using :option:`price-factor <price-factor: <float>` in :ref:`views <config-views>`.
 
 .. option:: rate-limiting/rate-limit: <int>
 
diff --git a/doc/user/config-views.rst b/doc/user/config-views.rst
index ed73de02f..f8de1fe2a 100644
--- a/doc/user/config-views.rst
+++ b/doc/user/config-views.rst
@@ -97,3 +97,20 @@ Actions
 
          Enable/disable DNS64.
 
+      .. option:: price-factor: <float>
+
+          :default: 1.0
+
+          Multiplies prices of operations in :ref:`rate limiting <config-rate-limiting>` and :ref:`defer <config-defer>`;
+          i.e. the number of queries is multiplied by the value for rate limiting and the measured time for defer.
+          In other words, we can say that
+          both :option:`instant-limit <rate-limiting/instant-limit: <int>` and :option:`rate-limit <rate-limiting/rate-limit: <int>`
+          are divided by the value and similarly all limits are divided for defer.
+
+          Use ``0.0`` to never use rate limiting and always assign the highest priority level in defer.
+
+          .. warning::
+
+            The effect on defer may be currently limited,
+            because some of the measured operations on incoming data occur before processing views
+            and the default :option:`price-factor <price-factor: <float>` value is thus used for them.