Skip to content

Commit 25f6b86

Browse files
authored
DOCSP-33147 improve serverStatus descriptions for metrics (#4805) (#4929)
* 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 * DOCSP-33147-v5.0-backport typo
1 parent 74ccb3d commit 25f6b86

File tree

1 file changed

+42
-46
lines changed

1 file changed

+42
-46
lines changed

source/reference/command/serverStatus.txt

Lines changed: 42 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4185,27 +4185,27 @@ shardingStatistics
41854185

41864186
.. serverstatus:: shardingStatistics.countDonorMoveChunkStarted
41874187

4188-
The total number of times that the :dbcommand:`moveChunk` command
4189-
has started on the shard, of which this node is a member, as part of
4190-
a :ref:`chunk migration process <chunk-migration-procedure>`. This
4191-
increasing number does not consider whether the chunk migrations
4192-
succeed or not.
4188+
The total number of times that MongoDB starts the
4189+
:dbcommand:`moveChunk` command on the primary node of the shard as
4190+
part of the :ref:`chunk migration process
4191+
<chunk-migration-procedure>`. This increasing number does not
4192+
consider whether the chunk migrations succeed or not.
41934193

41944194
*Only present when run on a shard.*
41954195

41964196
.. serverstatus:: shardingStatistics.countDonorMoveChunkCommitted
41974197

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

42014201
.. include:: /includes/chunk-migrations.rst
42024202

42034203
.. include:: /includes/chunk-migrations-version-list.rst
42044204

42054205
.. serverstatus:: shardingStatistics.countDonorMoveChunkAborted
42064206

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

42104210
.. include:: /includes/chunk-migrations.rst
42114211

@@ -4225,31 +4225,30 @@ shardingStatistics
42254225

42264226
.. serverstatus:: shardingStatistics.totalDonorChunkCloneTimeMillis
42274227

4228-
The cumulative time, in milliseconds, taken by the :ref:`clone phase
4229-
of the chunk migrations <chunk-migration-procedure>` from this
4230-
shard, of which this node is a member. Specifically, for each
4231-
migration from this shard, the tracked time starts with the
4232-
:dbcommand:`moveChunk` command and ends before the destination shard
4233-
enters a catch-up phase to apply changes that occurred during the
4234-
:ref:`chunk migrations <chunk-migration-procedure>`.
4228+
The cumulative time, in milliseconds, that the :ref:`clone phase of
4229+
the chunk migrations <chunk-migration-procedure>` takes on the
4230+
primary node of the shard. Specifically, for each migration on this
4231+
shard, the tracked time starts with the :dbcommand:`moveChunk`
4232+
command and ends before the destination shard enters a ``catchup``
4233+
phase to apply changes that occurred during the :ref:`chunk
4234+
migrations <chunk-migration-procedure>`.
42354235

42364236
*Only present when run on a shard.*
42374237

42384238
.. serverstatus:: shardingStatistics.totalCriticalSectionCommitTimeMillis
42394239

4240-
The cumulative time, in milliseconds, taken by the :ref:`update
4240+
The cumulative time, in milliseconds, that the :ref:`update
42414241
metadata phase of the chunk migrations <chunk-migration-procedure>`
4242-
from this shard, of which this node is a member. During the update
4243-
metadata phase, all operations on the collection are blocked.
4242+
takes on the primary node of the shard. During the update metadata
4243+
phase, MongoDB blocks all operations on the collection.
42444244

42454245
*Only present when run on a shard.*
42464246

42474247
.. serverstatus:: shardingStatistics.totalCriticalSectionTimeMillis
42484248

4249-
The cumulative time, in milliseconds, taken by the :ref:`catch-up
4249+
The cumulative time, in milliseconds, that the :ref:`catch-up
42504250
phase and the update metadata phase of the chunk migrations
4251-
<chunk-migration-procedure>` from this shard, of which this node is
4252-
a member.
4251+
<chunk-migration-procedure>` takes on the primary node of the shard.
42534252

42544253
To calculate the duration of the catch-up phase, subtract
42554254
:serverstatus:`~shardingStatistics.totalCriticalSectionCommitTimeMillis` from
@@ -4263,20 +4262,18 @@ shardingStatistics
42634262

42644263
.. serverstatus:: shardingStatistics.countDocsClonedOnRecipient
42654264

4266-
Cumulative, always-increasing count of documents that have been
4267-
cloned on this member where it acted as the primary of the recipient
4268-
shard.
4265+
The cumulative, always-increasing count of documents that MongoDB
4266+
clones on the primary node of the recipient shard.
42694267

42704268
*Only present when run on a shard.*
42714269

42724270
.. versionadded:: 4.2
42734271

42744272
.. serverstatus:: shardingStatistics.countBytesClonedOnRecipient
42754273

4276-
Cumulative number of bytes cloned on the current member node during a
4277-
:ref:`chunk migration procedure <chunk-migration-procedure>`, where
4278-
the current member node acted as the primary node for the recipient
4279-
shard.
4274+
The cumulative number of bytes that MongoDB clones on the primary
4275+
node of the recipient shard during the :ref:`chunk migration
4276+
procedure <chunk-migration-procedure>`.
42804277

42814278
.. include:: /includes/chunk-migrations-data-copy.rst
42824279

@@ -4286,10 +4283,10 @@ shardingStatistics
42864283

42874284
.. serverstatus:: shardingStatistics.countDocsClonedOnCatchUpOnRecipient
42884285

4289-
Cumulative number of documents cloned on the current member node
4290-
during the catch-up phase of a :ref:`chunk migration procedure
4291-
<chunk-migration-procedure>`, where the current member node acted as
4292-
the primary node for the recipient shard.
4286+
The cumulative number of documents that MongoDB clones on the primary
4287+
node of the recipient shard during the catch-up phase of the
4288+
:ref:`chunk migration procedure
4289+
<chunk-migration-procedure>`.
42934290

42944291
.. include:: /includes/chunk-migrations-data-copy.rst
42954292

@@ -4299,10 +4296,10 @@ shardingStatistics
42994296

43004297
.. serverstatus:: shardingStatistics.countBytesClonedOnCatchUpOnRecipient
43014298

4302-
Cumulative number of bytes cloned on the current member node during
4303-
the catch-up phase of a :ref:`chunk migration procedure
4304-
<chunk-migration-procedure>`, where the current member node acted as
4305-
the primary node for the recipient shard.
4299+
The cumulative number of bytes that MongoDB clones on the primary
4300+
node of the recipient shard during the catch-up phase of the
4301+
:ref:`chunk migration procedure
4302+
<chunk-migration-procedure>`.
43064303

43074304
.. include:: /includes/chunk-migrations-data-copy.rst
43084305

@@ -4312,9 +4309,8 @@ shardingStatistics
43124309

43134310
.. serverstatus:: shardingStatistics.countDocsClonedOnDonor
43144311

4315-
Cumulative, always-increasing count of documents that haves been
4316-
cloned on this member where it acted as the primary of the donor
4317-
shard.
4312+
The cumulative, always-increasing count of documents that MongoDB
4313+
clones on the primary node of the donor shard.
43184314

43194315
*Only present when run on a shard.*
43204316

@@ -4332,9 +4328,9 @@ shardingStatistics
43324328

43334329
.. serverstatus:: shardingStatistics.countDocsDeletedByRangeDeleter
43344330

4335-
Cumulative, always-increasing count of documents that have been
4336-
deleted on this member during chunk migration where the member acted
4337-
as the primary of the donor shard.
4331+
The cumulative, always-increasing count of documents that MongoDB
4332+
deletes on the primary node of the donor shard during chunk
4333+
migration.
43384334

43394335
*Only present when run on a shard.*
43404336

@@ -4344,9 +4340,9 @@ shardingStatistics
43444340

43454341
.. serverstatus:: shardingStatistics.countDonorMoveChunkLockTimeout
43464342

4347-
Cumulative, always-increasing count of chunk migrations that were
4348-
aborted due to lock acquisition timeouts, where the member acted as
4349-
the primary of the donor shard.
4343+
The cumulative, always-increasing count of chunk migrations that MongoDB
4344+
aborts on the primary node of the donor shard due to lock acquisition
4345+
timeouts.
43504346

43514347
*Only present when run on a shard.*
43524348

0 commit comments

Comments
 (0)