summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormikhailantoshkin <mike.antoshkin@gmail.com>2022-12-12 18:22:14 +0500
committerNick Vatamaniuc <nickva@users.noreply.github.com>2022-12-12 11:33:38 -0500
commite02613e018f2850a73cf1cbd849e0d5deba467cb (patch)
tree2e6366dc6839651fe900a91330dce9f3f3c71edc
parent5910faadc6fed622645bfe9d9354c3e8eba90fca (diff)
downloadcouchdb-e02613e018f2850a73cf1cbd849e0d5deba467cb.tar.gz
Add note on how to configure replicaton backoff (#4299)
Documentation was mentioning the exponential backoff on `Crashing` and `Error` states but did not mention how to configure it. This commit adds note on relation of `max_history` and maximum backoff with link to appropriate configuration section.
-rw-r--r--src/docs/src/replication/replicator.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/docs/src/replication/replicator.rst b/src/docs/src/replication/replicator.rst
index 8f02587c1..b06382968 100644
--- a/src/docs/src/replication/replicator.rst
+++ b/src/docs/src/replication/replicator.rst
@@ -417,7 +417,6 @@ retried and don't consume memory or CPU resources.
database, a permissions error, etc. Repeated consecutive crashes
result in an exponential backoff. This state is considered temporary
(non-terminal) and replication jobs will be periodically retried.
- Maximum backoff interval is around a day or so.
* ``Completed``: This is a terminal, successful state for
non-continuous replications. Once in this state the replication is
@@ -425,6 +424,11 @@ retried and don't consume memory or CPU resources.
memory resources. Continuous replication jobs will never reach this
state.
+.. note:: Maximum backoff interval for states ``Error`` and ``Crashing``
+ is calculated based on the ``replicator.max_history`` option.
+ See :ref:`Replicator configuration section <config/replicator>`
+ for additional information.
+
.. _Normal vs Continuous Replications:
Normal vs Continuous Replications