From: Remi Gacogne Date: Thu, 20 Oct 2022 12:27:39 +0000 (+0200) Subject: dnsdist: Fix lazy health-check related documentation issues X-Git-Tag: dnsdist-1.8.0-rc1~271^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d390a979a4f3c50832893c61fe3938ae6c667b35;p=thirdparty%2Fpdns.git dnsdist: Fix lazy health-check related documentation issues --- diff --git a/pdns/dnsdistdist/docs/guides/downstreams.rst b/pdns/dnsdistdist/docs/guides/downstreams.rst index ac720d1d6a..2a986c81a1 100644 --- a/pdns/dnsdistdist/docs/guides/downstreams.rst +++ b/pdns/dnsdistdist/docs/guides/downstreams.rst @@ -63,7 +63,7 @@ Lazy health-checking In some setups, especially on low-end devices, it might not make sense to actively send queries to the backend at a regular interval. Using the feedback from the results of regular queries can instead be used to infer if a backend might not be working properly. -Since 1.8.0, dnsdist implements a ``lazy`` mode that can be set via the ``healthCheckMode`` option on :func:`newServer`. In that mode dnsdist will only send active health-check queries after seeing a configurable amount of regular queries failing. It will then place the backend in a ``PotentialFailure`` state, from the initial ``Healthy`` one, and send health-check queries every ``checkInterval`` seconds. If ``maxCheckFailures`` of these fails, the backend is then moved to a ``Failed`` state and marked as ``down``, and active health-check queries are sent every ``lazyHealthCheckFailedInterval`` seconds. After ``rise`` successful, consecutive queries, the backend will be moved back to the ``Healthy`` state and marked as ``up`` again, and health-check queries will stop. +Since 1.8.0, dnsdist implements a ``lazy`` mode that can be set via the ``healthCheckMode`` option on :func:`newServer`. In this mode, dnsdist will only send active health-check queries after seeing a configurable amount of regular queries failing. It will then place the backend in a ``PotentialFailure`` state, from the initial ``Healthy`` one, and send health-check queries every ``checkInterval`` seconds. If ``maxCheckFailures`` of these fail, the backend is then moved to a ``Failed`` state and marked as ``down``, and active health-check queries are sent every ``lazyHealthCheckFailedInterval`` seconds. After ``rise`` successful, consecutive queries, the backend will be moved back to the ``Healthy`` state and marked as ``up`` again, and health-check queries will stop. .. figure:: ../imgs/DNSDistLazyHealthChecks.png :align: center diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst index 8771efe24f..4cf1e7a1c6 100644 --- a/pdns/dnsdistdist/docs/reference/config.rst +++ b/pdns/dnsdistdist/docs/reference/config.rst @@ -737,10 +737,10 @@ A server object returned by :func:`getServer` can be manipulated with these func .. method:: Server:setDown() - Set the server in an ``DOWN`` state. - The server will not receive queries and the health checks are disabled + Set the server in a ``DOWN`` state. + The server will not receive queries and the health checks are disabled. - .. method:: Server:setLazy([status]) + .. method:: Server:setLazyAuto([status]) .. versionadded:: 1.8.0