Skip to content

Commit 23c8899

Browse files
authored
DOCSP-33147 improve serverStatus descriptions for metrics (#4805) (#4928)
* 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 39d4b71 commit 23c8899

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
@@ -4407,27 +4407,27 @@ shardingStatistics
44074407

44084408
.. serverstatus:: shardingStatistics.countDonorMoveChunkStarted
44094409

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

44164416
*Only present when run on a shard.*
44174417

44184418
.. serverstatus:: shardingStatistics.countDonorMoveChunkCommitted
44194419

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

44234423
.. include:: /includes/chunk-migrations.rst
44244424

44254425
.. include:: /includes/chunk-migrations-version-list.rst
44264426

44274427
.. serverstatus:: shardingStatistics.countDonorMoveChunkAborted
44284428

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

44324432
.. include:: /includes/chunk-migrations.rst
44334433

@@ -4447,32 +4447,30 @@ shardingStatistics
44474447

44484448
.. serverstatus:: shardingStatistics.totalDonorChunkCloneTimeMillis
44494449

4450-
The cumulative time, in milliseconds, taken by the :ref:`clone phase
4451-
of the range migrations <range-migration-procedure>` from this
4452-
shard, of which this node is a member. Specifically, for each
4453-
migration from this shard, the tracked time starts with the
4454-
:dbcommand:`moveRange` and :dbcommand:`moveChunk` commands and ends
4455-
before the destination shard enters a ``catchup`` phase to apply
4456-
changes that occurred during the :ref:`range migrations
4457-
<range-migration-procedure>`.
4450+
The cumulative time, in milliseconds, that the :ref:`clone phase of
4451+
the range migration procedure <range-migration-procedure>` takes on
4452+
the primary node of the shard. Specifically, for each migration on
4453+
this shard, the tracked time starts with the :dbcommand:`moveRange`
4454+
and :dbcommand:`moveChunk` commands and ends before the destination
4455+
shard enters a ``catchup`` phase to apply changes that occurred
4456+
during the :ref:`range migration procedure <range-migration-procedure>`.
44584457

44594458
*Only present when run on a shard.*
44604459

44614460
.. serverstatus:: shardingStatistics.totalCriticalSectionCommitTimeMillis
44624461

4463-
The cumulative time, in milliseconds, taken by the :ref:`update
4464-
metadata phase of the range migrations <range-migration-procedure>`
4465-
from this shard, of which this node is a member. During the update
4466-
metadata phase, all operations on the collection are blocked.
4462+
The cumulative time, in milliseconds, that the :ref:`update metadata
4463+
phase of the range migrations procedure <range-migration-procedure>`
4464+
takes on the primary node of the shard. During the update metadata
4465+
phase, MongoDB blocks all operations on the collection.
44674466

44684467
*Only present when run on a shard.*
44694468

44704469
.. serverstatus:: shardingStatistics.totalCriticalSectionTimeMillis
44714470

4472-
The cumulative time, in milliseconds, taken by the :ref:`catch-up
4473-
phase and the update metadata phase of the range migrations
4474-
<range-migration-procedure>` from this shard, of which this node is
4475-
a member.
4471+
The cumulative time, in milliseconds, that the :ref:`catch-up
4472+
phase and the update metadata phase of the range migration procedure
4473+
<range-migration-procedure>` takes on the primary node of the shard.
44764474

44774475
To calculate the duration of the catch-up phase, subtract
44784476
:serverstatus:`~shardingStatistics.totalCriticalSectionCommitTimeMillis` from
@@ -4486,20 +4484,18 @@ shardingStatistics
44864484

44874485
.. serverstatus:: shardingStatistics.countDocsClonedOnRecipient
44884486

4489-
Cumulative, always-increasing count of documents that have been
4490-
cloned on this member where it acted as the primary of the recipient
4491-
shard.
4487+
The cumulative, always-increasing count of documents that MongoDB
4488+
clones on the primary node of the recipient shard.
44924489

44934490
*Only present when run on a shard.*
44944491

44954492
.. versionadded:: 4.2
44964493

44974494
.. serverstatus:: shardingStatistics.countBytesClonedOnRecipient
44984495

4499-
Cumulative number of bytes cloned on the current member node during a
4500-
:ref:`range migration procedure <range-migration-procedure>`, where
4501-
the current member node acted as the primary node for the recipient
4502-
shard.
4496+
The cumulative number of bytes that MongoDB clones on the primary
4497+
node of the recipient shard during the :ref:`range migration procedure
4498+
<range-migration-procedure>`.
45034499

45044500
.. include:: /includes/chunk-migrations-data-copy.rst
45054501

@@ -4509,10 +4505,9 @@ shardingStatistics
45094505

45104506
.. serverstatus:: shardingStatistics.countDocsClonedOnCatchUpOnRecipient
45114507

4512-
Cumulative number of documents cloned on the current member node
4513-
during the catch-up phase of a :ref:`range migration procedure
4514-
<range-migration-procedure>`, where the current member node acted as
4515-
the primary node for the recipient shard.
4508+
The cumulative number of documents that MongoDB clones on the primary
4509+
node of the recipient shard during the catch-up phase of the
4510+
:ref:`range migration procedure <range-migration-procedure>`.
45164511

45174512
.. include:: /includes/chunk-migrations-data-copy.rst
45184513

@@ -4522,10 +4517,9 @@ shardingStatistics
45224517

45234518
.. serverstatus:: shardingStatistics.countBytesClonedOnCatchUpOnRecipient
45244519

4525-
Cumulative number of bytes cloned on the current member node during
4526-
the catch-up phase of a :ref:`range migration procedure
4527-
<range-migration-procedure>`, where the current member node acted as
4528-
the primary node for the recipient shard.
4520+
The cumulative number of bytes that MongoDB clones on the primary
4521+
node of the recipient shard during the catch-up phase of the
4522+
:ref:`range migration procedure <range-migration-procedure>`.
45294523

45304524
.. include:: /includes/chunk-migrations-data-copy.rst
45314525

@@ -4535,9 +4529,8 @@ shardingStatistics
45354529

45364530
.. serverstatus:: shardingStatistics.countDocsClonedOnDonor
45374531

4538-
Cumulative, always-increasing count of documents that haves been
4539-
cloned on this member where it acted as the primary of the donor
4540-
shard.
4532+
The cumulative, always-increasing count of documents that MongoDB
4533+
clones on the primary node of the donor shard.
45414534

45424535
*Only present when run on a shard.*
45434536

@@ -4555,9 +4548,9 @@ shardingStatistics
45554548

45564549
.. serverstatus:: shardingStatistics.countDocsDeletedByRangeDeleter
45574550

4558-
Cumulative, always-increasing count of documents that have been
4559-
deleted on this member during chunk migration where the member acted
4560-
as the primary of the donor shard.
4551+
The cumulative, always-increasing count of documents that MongoDB
4552+
deletes on the primary node of the donor shard during chunk
4553+
migration.
45614554

45624555
*Only present when run on a shard.*
45634556

@@ -4567,9 +4560,9 @@ shardingStatistics
45674560

45684561
.. serverstatus:: shardingStatistics.countDonorMoveChunkLockTimeout
45694562

4570-
Cumulative, always-increasing count of chunk migrations that were
4571-
aborted due to lock acquisition timeouts, where the member acted as
4572-
the primary of the donor shard.
4563+
The cumulative, always-increasing count of chunk migrations that MongoDB
4564+
aborts on the primary node of the donor shard due to lock acquisition
4565+
timeouts.
45734566

45744567
*Only present when run on a shard.*
45754568

@@ -4646,7 +4639,7 @@ shardingStatistics
46464639

46474640
The current total of the queued chunk range deletion tasks that are
46484641
ready to run or are running as part of the :ref:`range migration
4649-
process <range-migration-procedure>`.
4642+
procedure <range-migration-procedure>`.
46504643

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

0 commit comments

Comments
 (0)