[GitHub] nickva closed pull request #345: Trying to improve the replication scheduler configuration parameters (fixes apache/couchdb#344)

[GitBox <gi...@apache.org>]

nickva closed pull request #345: Trying to improve the replication scheduler configuration parameters (fixes apache/couchdb#344)
URL: https://github.com/apache/couchdb-documentation/pull/345
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/src/config/replicator.rst b/src/config/replicator.rst
index bf57223..80fc44e 100644
--- a/src/config/replicator.rst
+++ b/src/config/replicator.rst
@@ -27,11 +27,18 @@ Replicator Database Configuration
 
         .. versionadded:: 2.1
 
-        Number of actively running replications. Making this too high could
-        cause performance issues. Making it too low could mean replications
-        jobs might not have enough time to make progress before getting
-        unscheduled again. This parameter can be adjusted at runtime and will
-        take effect during next rescheduling cycle::
+        Number of actively running replications.
+        This value represents the threshold to trigger the automatic replication
+        scheduler.
+        The system will check every ``interval`` milliseconds how many replication
+        jobs are running, and if there are more than ``max_jobs`` active jobs,
+        the scheduler will pause-and-restart up to ``max_churn`` jobs in the
+        scheduler queue.
+        Making this value too high could cause performance issues, while making
+        it too low could mean replications jobs might not have enough time to make
+        progress before getting unscheduled again.
+        This parameter can be adjusted at runtime and will take effect during next
+        rescheduling cycle::
 
              [replicator]
              max_jobs = 500
@@ -40,8 +47,9 @@ Replicator Database Configuration
 
         .. versionadded:: 2.1
 
-        Scheduling interval in milliseconds. During each reschedule cycle
-        scheduler might start or stop up to "max_churn" number of jobs::
+        Scheduling interval in milliseconds.
+        During each reschedule cycle the scheduler might start or stop up to ``max_churn``
+        number of jobs::
 
              [replicator]
              interval = 60000
@@ -50,10 +58,10 @@ Replicator Database Configuration
 
         .. versionadded:: 2.1
 
-        Maximum number of replications to start and stop during rescheduling.
-        This parameter along with ``interval`` defines the rate of job
-        replacement. During startup, however a much larger number of jobs could
-        be started (up to ``max_jobs``) in a short period of time::
+        Maximum number of replication jobs to start and stop during rescheduling.
+        This parameter, along with ``interval``, defines the rate of job replacement.
+        During startup, however, a much larger number of jobs could be started
+        (up to ``max_jobs``) in a short period of time::
 
              [replicator]
              max_churn = 20


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services