Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(DOCS-14449): maxCatchUpPercentageBeforeBlockingWrites server parameter #5750

Merged
merged 1 commit into from
Aug 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions source/reference/command/moveChunk.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
34 changes: 34 additions & 0 deletions source/reference/parameters.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <db.collection.updateOne>`
and :method:`delete <db.collection.deleteOne>` 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 <https://github.com/mongodb/mongo/blob/master/src/mongo/db/s/README.md#the-live-migration-protocol>`__

.. parameter:: readHedgingMode

.. versionadded:: 4.4
Expand Down
2 changes: 2 additions & 0 deletions source/tutorial/migrate-chunks-in-sharded-cluster.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _migrate-chunks-sharded-cluster:

===================================
Migrate Chunks in a Sharded Cluster
===================================
Expand Down