Skip to content

Commit f4f5108

Browse files
authored
DOCSP-33147 improve serverStatus descriptions for metrics (#4805) (#4927)
* 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 a0e0a6a commit f4f5108

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
@@ -4693,27 +4693,27 @@ shardingStatistics
46934693

46944694
.. serverstatus:: shardingStatistics.countDonorMoveChunkStarted
46954695

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

47024702
*Only present when run on a shard.*
47034703

47044704
.. serverstatus:: shardingStatistics.countDonorMoveChunkCommitted
47054705

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

47094709
.. include:: /includes/chunk-migrations.rst
47104710

47114711
.. include:: /includes/chunk-migrations-version-list.rst
47124712

47134713
.. serverstatus:: shardingStatistics.countDonorMoveChunkAborted
47144714

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

47184718
.. include:: /includes/chunk-migrations.rst
47194719

@@ -4733,32 +4733,30 @@ shardingStatistics
47334733

47344734
.. serverstatus:: shardingStatistics.totalDonorChunkCloneTimeMillis
47354735

4736-
The cumulative time, in milliseconds, taken by the :ref:`clone phase
4737-
of the range migrations <range-migration-procedure>` from this
4738-
shard, of which this node is a member. Specifically, for each
4739-
migration from this shard, the tracked time starts with the
4740-
:dbcommand:`moveRange` and :dbcommand:`moveChunk` commands and ends
4741-
before the destination shard enters a ``catchup`` phase to apply
4742-
changes that occurred during the :ref:`range migrations
4743-
<range-migration-procedure>`.
4736+
The cumulative time, in milliseconds, that the :ref:`clone phase of
4737+
the range migration procedure <range-migration-procedure>` takes on
4738+
the primary node of the shard. Specifically, for each migration on
4739+
this shard, the tracked time starts with the :dbcommand:`moveRange`
4740+
and :dbcommand:`moveChunk` commands and ends before the destination
4741+
shard enters a ``catchup`` phase to apply changes that occurred
4742+
during the :ref:`range migration procedure <range-migration-procedure>`.
47444743

47454744
*Only present when run on a shard.*
47464745

47474746
.. serverstatus:: shardingStatistics.totalCriticalSectionCommitTimeMillis
47484747

4749-
The cumulative time, in milliseconds, taken by the :ref:`update
4750-
metadata phase of the range migrations <range-migration-procedure>`
4751-
from this shard, of which this node is a member. During the update
4752-
metadata phase, all operations on the collection are blocked.
4748+
The cumulative time, in milliseconds, that the :ref:`update metadata
4749+
phase of the range migrations procedure <range-migration-procedure>`
4750+
takes on the primary node of the shard. During the update metadata
4751+
phase, MongoDB blocks all operations on the collection.
47534752

47544753
*Only present when run on a shard.*
47554754

47564755
.. serverstatus:: shardingStatistics.totalCriticalSectionTimeMillis
47574756

4758-
The cumulative time, in milliseconds, taken by the :ref:`catch-up
4759-
phase and the update metadata phase of the range migrations
4760-
<range-migration-procedure>` from this shard, of which this node is
4761-
a member.
4757+
The cumulative time, in milliseconds, that the :ref:`catch-up
4758+
phase and the update metadata phase of the range migration procedure
4759+
<range-migration-procedure>` takes on the primary node of the shard.
47624760

47634761
To calculate the duration of the catch-up phase, subtract
47644762
:serverstatus:`~shardingStatistics.totalCriticalSectionCommitTimeMillis` from
@@ -4772,20 +4770,18 @@ shardingStatistics
47724770

47734771
.. serverstatus:: shardingStatistics.countDocsClonedOnRecipient
47744772

4775-
Cumulative, always-increasing count of documents that have been
4776-
cloned on this member where it acted as the primary of the recipient
4777-
shard.
4773+
The cumulative, always-increasing count of documents that MongoDB
4774+
clones on the primary node of the recipient shard.
47784775

47794776
*Only present when run on a shard.*
47804777

47814778
.. versionadded:: 4.2
47824779

47834780
.. serverstatus:: shardingStatistics.countBytesClonedOnRecipient
47844781

4785-
Cumulative number of bytes cloned on the current member node during a
4786-
:ref:`range migration procedure <range-migration-procedure>`, where
4787-
the current member node acted as the primary node for the recipient
4788-
shard.
4782+
The cumulative number of bytes that MongoDB clones on the primary
4783+
node of the recipient shard during the :ref:`range migration procedure
4784+
<range-migration-procedure>`.
47894785

47904786
.. include:: /includes/chunk-migrations-data-copy.rst
47914787

@@ -4795,10 +4791,9 @@ shardingStatistics
47954791

47964792
.. serverstatus:: shardingStatistics.countDocsClonedOnCatchUpOnRecipient
47974793

4798-
Cumulative number of documents cloned on the current member node
4799-
during the catch-up phase of a :ref:`range migration procedure
4800-
<range-migration-procedure>`, where the current member node acted as
4801-
the primary node for the recipient shard.
4794+
The cumulative number of documents that MongoDB clones on the primary
4795+
node of the recipient shard during the catch-up phase of the
4796+
:ref:`range migration procedure <range-migration-procedure>`.
48024797

48034798
.. include:: /includes/chunk-migrations-data-copy.rst
48044799

@@ -4808,10 +4803,9 @@ shardingStatistics
48084803

48094804
.. serverstatus:: shardingStatistics.countBytesClonedOnCatchUpOnRecipient
48104805

4811-
Cumulative number of bytes cloned on the current member node during
4812-
the catch-up phase of a :ref:`range migration procedure
4813-
<range-migration-procedure>`, where the current member node acted as
4814-
the primary node for the recipient shard.
4806+
The cumulative number of bytes that MongoDB clones on the primary
4807+
node of the recipient shard during the catch-up phase of the
4808+
:ref:`range migration procedure <range-migration-procedure>`.
48154809

48164810
.. include:: /includes/chunk-migrations-data-copy.rst
48174811

@@ -4821,9 +4815,8 @@ shardingStatistics
48214815

48224816
.. serverstatus:: shardingStatistics.countDocsClonedOnDonor
48234817

4824-
Cumulative, always-increasing count of documents that haves been
4825-
cloned on this member where it acted as the primary of the donor
4826-
shard.
4818+
The cumulative, always-increasing count of documents that MongoDB
4819+
clones on the primary node of the donor shard.
48274820

48284821
*Only present when run on a shard.*
48294822

@@ -4841,9 +4834,9 @@ shardingStatistics
48414834

48424835
.. serverstatus:: shardingStatistics.countDocsDeletedByRangeDeleter
48434836

4844-
Cumulative, always-increasing count of documents that have been
4845-
deleted on this member during chunk migration where the member acted
4846-
as the primary of the donor shard.
4837+
The cumulative, always-increasing count of documents that MongoDB
4838+
deletes on the primary node of the donor shard during chunk
4839+
migration.
48474840

48484841
*Only present when run on a shard.*
48494842

@@ -4853,9 +4846,9 @@ shardingStatistics
48534846

48544847
.. serverstatus:: shardingStatistics.countDonorMoveChunkLockTimeout
48554848

4856-
Cumulative, always-increasing count of chunk migrations that were
4857-
aborted due to lock acquisition timeouts, where the member acted as
4858-
the primary of the donor shard.
4849+
The cumulative, always-increasing count of chunk migrations that MongoDB
4850+
aborts on the primary node of the donor shard due to lock acquisition
4851+
timeouts.
48594852

48604853
*Only present when run on a shard.*
48614854

@@ -4932,7 +4925,7 @@ shardingStatistics
49324925

49334926
The current total of the queued chunk range deletion tasks that are
49344927
ready to run or are running as part of the :ref:`range migration
4935-
process <range-migration-procedure>`.
4928+
procedure <range-migration-procedure>`.
49364929

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

0 commit comments

Comments
 (0)