From 56154e166307cc32ac1a360bc2d11469dad02f4a Mon Sep 17 00:00:00 2001 From: Jeff Allen Date: Wed, 18 Aug 2021 11:57:08 -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 6cceb331a2f..6062b520013 100644 --- a/source/reference/command/moveChunk.txt +++ b/source/reference/command/moveChunk.txt @@ -220,5 +220,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.4.7 (and 4.2.15, 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 330c17542b5..a4b32788f52 100644 --- a/source/reference/parameters.txt +++ b/source/reference/parameters.txt @@ -2659,6 +2659,40 @@ Sharding Parameters - :parameter:`readHedgingMode` - :ref:`mongos-hedged-reads` +.. parameter:: maxCatchUpPercentageBeforeBlockingWrites + + .. versionadded:: 4.4.7 (*Also available starting in 4.2.15, 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:: readHedgingMode .. versionadded:: 4.4 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 ===================================