From a9abbe95153d35cf48efd58de18a9ead3e6fa137 Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Thu, 26 Aug 2021 12:09:39 -0400 Subject: [PATCH] (DOCS-14449): maxCatchUpPercentageBeforeBlockingWrites server parameter --- source/reference/command/moveChunk.txt | 9 +++++ source/reference/parameters.txt | 34 +++++++++++++++++++ .../migrate-chunks-in-sharded-cluster.txt | 2 ++ 3 files changed, 45 insertions(+) diff --git a/source/reference/command/moveChunk.txt b/source/reference/command/moveChunk.txt index 3a94202b323..43fb0ed15c1 100644 --- a/source/reference/command/moveChunk.txt +++ b/source/reference/command/moveChunk.txt @@ -188,5 +188,14 @@ while :dbcommand:`moveChunk` is running, you may see this error. You may retry the :dbcommand:`moveChunk` operation without side effects. +``maxCatchUpPercentageBeforeBlockingWrites`` Server Parameter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Starting in MongoDB 4.2.15 (and 4.0.26), you can set the +:parameter:`maxCatchUpPercentageBeforeBlockingWrites` to specify the +maximum allowed percentage of data not yet migrated +during a :dbcommand:`moveChunk` operation when compared to the +total size (in MBs) of the chunk being transferred. + .. admin-only diff --git a/source/reference/parameters.txt b/source/reference/parameters.txt index 3a682eec0ba..30bb9c67271 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -2073,6 +2073,40 @@ Sharding Parameters - :serverstatus:`shardedIndexConsistency` metrics returned by the :dbcommand:`serverStatus` command. +.. parameter:: maxCatchUpPercentageBeforeBlockingWrites + + .. versionadded:: 4.2.15 (*Also available starting in 4.0.26*) + + *Type*: integer + + *Default*: 10 + + |mongod-only| + + For :dbcommand:`moveChunk` operations, specifies the maximum + percentage of untrasferred data allowed by the migration protocol + (expressed in percentage of the total chunk size) to + transition from the ``catchup`` phase to the ``commit`` phase. + + Setting a higher catchup percentage can decrease the amount of time + it takes for the migration to complete at the cost of increased + latency during concurrent :method:`upsert ` + and :method:`delete ` operations. + + For example, to set the maximum percentage to 20, you can issue the + followingduring startup: + + .. code-block:: bash + + mongod --setParameter maxCatchUpPercentageBeforeBlockingWrites=20 + + You cannot change + :parameter:`maxCatchUpPercentageBeforeBlockingWrites` during runtime. + + .. seealso:: + + `Live Migration Protocol `__ + .. parameter:: shardedIndexConsistencyCheckIntervalMS .. versionadded:: 4.2.6 diff --git a/source/tutorial/migrate-chunks-in-sharded-cluster.txt b/source/tutorial/migrate-chunks-in-sharded-cluster.txt index 8f8d79d5d1a..5aad46268bf 100644 --- a/source/tutorial/migrate-chunks-in-sharded-cluster.txt +++ b/source/tutorial/migrate-chunks-in-sharded-cluster.txt @@ -1,3 +1,5 @@ +.. _migrate-chunks-sharded-cluster: + =================================== Migrate Chunks in a Sharded Cluster ===================================