Skip to content

Commit f6d75c9

Browse files
authored
DOCSP-33147 improve serverStatus descriptions for metrics (#4805)
* DOCSP-33147 improve serverStatus descriptions for metrics * DOCSP-33147 improve serverStatus descriptions for metrics * DOCSP-33147 improve serverStatus descriptions for metrics * DOCSP-33147 improve serverStatus descriptions for metrics * DOCSP-33147 active voice * DOCSP-33147 active voice * DOCSP-33147 consistency * DOCSP-33147 consistency * DOCSP-33147 copy edits * DOCSP-33147 copy edits * DOCSP-33147 typo
1 parent 045d7fc commit f6d75c9

File tree

1 file changed

+42
-49
lines changed

1 file changed

+42
-49
lines changed

source/reference/command/serverStatus.txt

Lines changed: 42 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4767,27 +4767,27 @@ shardingStatistics
47674767

47684768
.. serverstatus:: shardingStatistics.countDonorMoveChunkStarted
47694769

4770-
The total number of times that the :dbcommand:`moveChunk` command
4771-
or :dbcommand:`moveRange` have started on the shard, of which this
4772-
node is a member, as part of a :ref:`range migration process
4773-
<range-migration-procedure>`. This increasing number does not
4770+
The total number of times that MongoDB starts the
4771+
:dbcommand:`moveChunk` command or :dbcommand:`moveRange` command on
4772+
the primary node of the shard as part of the :ref:`range migration
4773+
procedure <range-migration-procedure>`. This increasing number does not
47744774
consider whether the chunk migrations succeed or not.
47754775

47764776
*Only present when run on a shard.*
47774777

47784778
.. serverstatus:: shardingStatistics.countDonorMoveChunkCommitted
47794779

4780-
Total number of chunk migrations committed on the shard, of which
4781-
the current node is a member.
4780+
The total number of chunk migrations that MongoDB commits on the
4781+
primary node of the shard.
47824782

47834783
.. include:: /includes/chunk-migrations.rst
47844784

47854785
.. include:: /includes/chunk-migrations-version-list.rst
47864786

47874787
.. serverstatus:: shardingStatistics.countDonorMoveChunkAborted
47884788

4789-
Total number of chunk migrations aborted on the shard, of which the
4790-
current node is a member.
4789+
The total number of chunk migrations that MongoDB aborts on the
4790+
primary node of the shard.
47914791

47924792
.. include:: /includes/chunk-migrations.rst
47934793

@@ -4807,32 +4807,30 @@ shardingStatistics
48074807

48084808
.. serverstatus:: shardingStatistics.totalDonorChunkCloneTimeMillis
48094809

4810-
The cumulative time, in milliseconds, taken by the :ref:`clone phase
4811-
of the range migrations <range-migration-procedure>` from this
4812-
shard, of which this node is a member. Specifically, for each
4813-
migration from this shard, the tracked time starts with the
4814-
:dbcommand:`moveRange` and :dbcommand:`moveChunk` commands and ends
4815-
before the destination shard enters a ``catchup`` phase to apply
4816-
changes that occurred during the :ref:`range migrations
4817-
<range-migration-procedure>`.
4810+
The cumulative time, in milliseconds, that the :ref:`clone phase of
4811+
the range migration procedure <range-migration-procedure>` takes on
4812+
the primary node of the shard. Specifically, for each migration on
4813+
this shard, the tracked time starts with the :dbcommand:`moveRange`
4814+
and :dbcommand:`moveChunk` commands and ends before the destination
4815+
shard enters a ``catchup`` phase to apply changes that occurred
4816+
during the :ref:`range migration procedure <range-migration-procedure>`.
48184817

48194818
*Only present when run on a shard.*
48204819

48214820
.. serverstatus:: shardingStatistics.totalCriticalSectionCommitTimeMillis
48224821

4823-
The cumulative time, in milliseconds, taken by the :ref:`update
4824-
metadata phase of the range migrations <range-migration-procedure>`
4825-
from this shard, of which this node is a member. During the update
4826-
metadata phase, all operations on the collection are blocked.
4822+
The cumulative time, in milliseconds, that the :ref:`update metadata
4823+
phase of the range migrations procedure <range-migration-procedure>`
4824+
takes on the primary node of the shard. During the update metadata
4825+
phase, MongoDB blocks all operations on the collection.
48274826

48284827
*Only present when run on a shard.*
48294828

48304829
.. serverstatus:: shardingStatistics.totalCriticalSectionTimeMillis
48314830

4832-
The cumulative time, in milliseconds, taken by the :ref:`catch-up
4833-
phase and the update metadata phase of the range migrations
4834-
<range-migration-procedure>` from this shard, of which this node is
4835-
a member.
4831+
The cumulative time, in milliseconds, that the :ref:`catch-up
4832+
phase and the update metadata phase of the range migration procedure
4833+
<range-migration-procedure>` takes on the primary node of the shard.
48364834

48374835
To calculate the duration of the catch-up phase, subtract
48384836
:serverstatus:`~shardingStatistics.totalCriticalSectionCommitTimeMillis` from
@@ -4846,20 +4844,18 @@ shardingStatistics
48464844

48474845
.. serverstatus:: shardingStatistics.countDocsClonedOnRecipient
48484846

4849-
Cumulative, always-increasing count of documents that have been
4850-
cloned on this member where it acted as the primary of the recipient
4851-
shard.
4847+
The cumulative, always-increasing count of documents that MongoDB
4848+
clones on the primary node of the recipient shard.
48524849

48534850
*Only present when run on a shard.*
48544851

48554852
.. versionadded:: 4.2
48564853

48574854
.. serverstatus:: shardingStatistics.countBytesClonedOnRecipient
48584855

4859-
Cumulative number of bytes cloned on the current member node during a
4860-
:ref:`range migration procedure <range-migration-procedure>`, where
4861-
the current member node acted as the primary node for the recipient
4862-
shard.
4856+
The cumulative number of bytes that MongoDB clones on the primary
4857+
node of the recipient shard during the :ref:`range migration procedure
4858+
<range-migration-procedure>`.
48634859

48644860
.. include:: /includes/chunk-migrations-data-copy.rst
48654861

@@ -4869,10 +4865,9 @@ shardingStatistics
48694865

48704866
.. serverstatus:: shardingStatistics.countDocsClonedOnCatchUpOnRecipient
48714867

4872-
Cumulative number of documents cloned on the current member node
4873-
during the catch-up phase of a :ref:`range migration procedure
4874-
<range-migration-procedure>`, where the current member node acted as
4875-
the primary node for the recipient shard.
4868+
The cumulative number of documents that MongoDB clones on the primary
4869+
node of the recipient shard during the catch-up phase of the
4870+
:ref:`range migration procedure <range-migration-procedure>`.
48764871

48774872
.. include:: /includes/chunk-migrations-data-copy.rst
48784873

@@ -4882,10 +4877,9 @@ shardingStatistics
48824877

48834878
.. serverstatus:: shardingStatistics.countBytesClonedOnCatchUpOnRecipient
48844879

4885-
Cumulative number of bytes cloned on the current member node during
4886-
the catch-up phase of a :ref:`range migration procedure
4887-
<range-migration-procedure>`, where the current member node acted as
4888-
the primary node for the recipient shard.
4880+
The cumulative number of bytes that MongoDB clones on the primary
4881+
node of the recipient shard during the catch-up phase of the
4882+
:ref:`range migration procedure <range-migration-procedure>`.
48894883

48904884
.. include:: /includes/chunk-migrations-data-copy.rst
48914885

@@ -4895,9 +4889,8 @@ shardingStatistics
48954889

48964890
.. serverstatus:: shardingStatistics.countDocsClonedOnDonor
48974891

4898-
Cumulative, always-increasing count of documents that haves been
4899-
cloned on this member where it acted as the primary of the donor
4900-
shard.
4892+
The cumulative, always-increasing count of documents that MongoDB
4893+
clones on the primary node of the donor shard.
49014894

49024895
*Only present when run on a shard.*
49034896

@@ -4915,9 +4908,9 @@ shardingStatistics
49154908

49164909
.. serverstatus:: shardingStatistics.countDocsDeletedByRangeDeleter
49174910

4918-
Cumulative, always-increasing count of documents that have been
4919-
deleted on this member during chunk migration where the member acted
4920-
as the primary of the donor shard.
4911+
The cumulative, always-increasing count of documents that MongoDB
4912+
deletes on the primary node of the donor shard during chunk
4913+
migration.
49214914

49224915
*Only present when run on a shard.*
49234916

@@ -4927,9 +4920,9 @@ shardingStatistics
49274920

49284921
.. serverstatus:: shardingStatistics.countDonorMoveChunkLockTimeout
49294922

4930-
Cumulative, always-increasing count of chunk migrations that were
4931-
aborted due to lock acquisition timeouts, where the member acted as
4932-
the primary of the donor shard.
4923+
The cumulative, always-increasing count of chunk migrations that MongoDB
4924+
aborts on the primary node of the donor shard due to lock acquisition
4925+
timeouts.
49334926

49344927
*Only present when run on a shard.*
49354928

@@ -5006,7 +4999,7 @@ shardingStatistics
50064999

50075000
The current total of the queued chunk range deletion tasks that are
50085001
ready to run or are running as part of the :ref:`range migration
5009-
process <range-migration-procedure>`.
5002+
procedure <range-migration-procedure>`.
50105003

50115004
Inspect the documents in the :data:`config.rangeDeletions` collection
50125005
for information about the chunk ranges pending deletion from a shard

0 commit comments

Comments
 (0)