DOCSP-24282 metrics updated (#1900)

* DOCSP-24282 metrics updated

* DOCSP-24282 metrics updated

* DOCSP-24282 metrics updated

* DOCSP-24282 metrics updated

* Review feedback

* Staging Fixes

* Review feedback

* Review feedback

* Review feedback

* Review feedback

* Review feedback

* Review feedback

* Staging fixes

* Staging fixes

* Test layout

* Test layout

* Test layout

* Staging fixes

* Staging fixes

* review feedback

* Review feedback

* Review Feedback

* Review Feedback

* Review feedback

* Review feedback

Author: Dave Cuthbert

source/includes/metrics/ex-global-index.rst

@@ -0,0 +1,35 @@
+
+.. _db.currentOp-global-index-ex:
+
+Global Index Example
+~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: javascript
+
+   {
+       type: "op",
+       desc: "GlobalIndex{Donor, Recipient, Coordinator}Service <globalIndexUUID}",
+       op: "command",
+       ns: "<database>.<collection>",
+       originatingCommand: {
+           createIndexes: "<database>.<collection>",
+           key: <indexkeypattern>,
+           unique: <boolean>,
+           <Additional createIndexes options>
+       },
+      {donor, coordinator, recipient}State : "<service state>",
+      approxDocumentsToScan: NumberLong(<count>),
+      approxBytesToScan: NumberLong(<count>),
+      bytesWrittenFromScan: NumberLong(<count>),
+      countWritesToStashCollections: NumberLong(<count>),
+      countWritesDuringCriticalSection : NumberLong(<count>),
+      countReadsDuringCriticalSection: NumberLong(<count>),
+      keysWrittenFromScan: NumberLong(<count>),
+      remainingOperationTimeEstimatedSecs: NumberLong(<count>),
+      allShardsLowestRemainingOperationTimeEstimatedSecs: NumberLong(<estimate>),
+      allShardsHighestRemainingOperationTimeEstimatedSecs: NumberLong(<estimate>),
+      totalCopyTimeElapsedSecs: NumberLong(<count>),
+      totalCriticalSectionTimeElapsedSecs : NumberLong(<count>),
+      totalOperationTimeElapsedSecs: NumberLong(<count>),
+   }
+

source/includes/metrics/ex-resharding.rst

@@ -0,0 +1,43 @@
+
+.. _db.currentOp-resharding-ex:
+
+Resharding Output Example
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: javascript
+
+   {    
+       type: "op",
+       desc: "Resharding{Donor, Recipient, Coordinator}Service <reshardingUUID>",
+       op: "command",
+       ns: "<database>.<collection>",
+       originatingCommand: {
+           reshardCollection: "<database>.<collection>",
+           key: <shardkey>,
+           unique: <boolean>,
+           collation: {locale: "simple"},
+           // Other options to the reshardCollection command are omitted
+           // to decrease the likelihood the output is truncated.
+      },
+      {donor, coordinator, recipient}State : "<service state>",
+      approxDocumentsToCopy: NumberLong(<count>),
+      approxBytesToCopy: NumberLong(<count>),
+      bytesCopied: NumberLong(<count>),
+      countWritesToStashCollections: NumberLong(<count>),
+      countWritesDuringCriticalSection : NumberLong(<count>),
+      countReadsDuringCriticalSection: NumberLong(<count>),
+      deletesApplied: NumberLong(<count>),
+      documentsCopied: NumberLong(<count>),
+      insertsApplied: NumberLong(<count>),
+      oplogEntriesFetched: NumberLong(<count>),
+      oplogEntriesApplied: NumberLong(<count>),
+      remainingOperationTimeEstimatedSecs: NumberLong(<count>),
+      allShardsLowestRemainingOperationTimeEstimatedSecs: NumberLong(<estimate>),
+      allShardsHighestRemainingOperationTimeEstimatedSecs: NumberLong(<estimate>),
+      totalApplyTimeElapsedSecs: NumberLong(<count>),
+      totalCopyTimeElapsedSecs: NumberLong(<count>),
+      totalCriticalSectionTimeElapsedSecs : NumberLong(<count>),
+      totalOperationTimeElapsedSecs: NumberLong(<count>),
+      updatesApplied: NumberLong(<count>),
+   }
+

source/includes/metrics/txt-section-intro.rst

@@ -0,0 +1,3 @@
+These output samples illustrate ``currentOp`` output for particular
+operations. The fields that make up the actual output vary depending on
+the server's role. 

source/reference/command/currentOp.txt

@@ -206,13 +206,20 @@ The following example returns information on index creation operations:
        }
    )
 
-
-
 Output Example
 --------------
 
 .. include:: /includes/currentOp-output-example.rst
 
+.. _currentOp-specific-output-examples:
+
+Specific Output Examples
+------------------------
+
+.. include:: /includes/metrics/txt-section-intro.rst
+.. include:: /includes/metrics/ex-resharding.rst
+.. include:: /includes/metrics/ex-global-index.rst
+
 .. _currentOp-output-fields:
 
 Output Fields
@@ -1106,7 +1113,7 @@ Output Fields
 
       .. versionadded:: 4.2
 
-.. data:: currentOp.totalOperationTimeElapsed
+.. data:: currentOp.totalOperationTimeElapsedSecs
 
    The total time elapsed, in seconds, for the current :ref:`resharding
    operation <sharding-resharding>`. The time is set to 0 when a new
@@ -1116,7 +1123,19 @@ Output Fields
 
    .. versionadded:: 5.0
 
-.. data:: currentOp.remainingOperationTimeEstimated
+   Starting in MongoDB 6.1, this metric is also available on the
+   coordinator during resharding.
+
+.. data:: currentOp.updatesApplied
+
+   The number of updates applied.
+
+   Only present on a recipient shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.remainingOperationTimeEstimatedSecs
 
    The estimated time remaining in seconds for the current
    :ref:`resharding operation <sharding-resharding>`. The time is set to
@@ -1127,6 +1146,29 @@ Output Fields
 
    .. versionadded:: 5.0
 
+   Starting in MongoDB 6.1, this metric is also available on the
+   coordinator during resharding.
+
+.. data:: currentOp.allShardsLowestRemainingOperationTimeEstimatedSecs
+
+   Calculated across all shards, the lowest estimate of the number of
+   seconds remaining. 
+
+   Only present on a coordinator when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.allShardsHighestRemainingOperationTimeEstimatedSecs
+
+   Calculated across all shards, the highest estimate of the number of
+   seconds remaining. 
+
+   Only present on a coordinator when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
 .. data:: currentOp.approxDocumentsToCopy
 
    The approximate number of documents to be copied from the donor
@@ -1185,7 +1227,57 @@ Output Fields
 
    .. versionadded:: 5.0
 
-.. data:: currentOp.totalCopyTimeElapsed
+.. data:: currentOp.countWritesToStashCollections
+
+   The number of writes to the recipient :term:`stash collections
+   <stash collection>`.
+
+   Only present on a recipient shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.countWritesDuringCriticalSection
+
+   The number of writes attempted during the donor's critical
+   section.
+
+   Only present on a donor shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.countReadsDuringCriticalSection
+
+   The number of reads attempted during the donor's critical
+   section.
+
+   Only present on a donor shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.deletesApplied
+
+   The number of deletes applied to the temporary resharding collection.
+   Each oplog entry that involves a delete increments the counter by 1.
+
+   Only present on a recipient shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.insertsApplied
+
+   The number of inserts applied to the temporary resharding collection.
+   Each oplog entry that involves an insert increments the counter by 1.
+
+   Only present on a recipient shard when a resharding operation is
+   taking place.
+
+   .. versionadded:: 6.1
+
+.. data:: currentOp.totalCopyTimeElapsedSecs
 
    The total elapsed time, in seconds, for ongoing data copy tasks from
    donor shards to recipient shards for the current :ref:`resharding
@@ -1197,6 +1289,9 @@ Output Fields
 
    .. versionadded:: 5.0
 
+   Starting in MongoDB 6.1, this metric is also available on the
+   coordinator during resharding.
+
 .. data:: currentOp.oplogEntriesFetched
 
    The number of entries fetched from the :term:`oplog` for the current
@@ -1219,7 +1314,7 @@ Output Fields
 
    .. versionadded:: 5.0
 
-.. data:: currentOp.totalApplyTimeElapsed
+.. data:: currentOp.totalApplyTimeElapsedSecs
 
    The total elapsed time, in seconds, for the apply step of the
    current :ref:`resharding operation <sharding-resharding>`. In the
@@ -1232,6 +1327,9 @@ Output Fields
 
    .. versionadded:: 5.0
 
+   Starting in MongoDB 6.1, this metric is also available on the
+   coordinator during resharding.
+
 .. data:: currentOp.countWritesDuringCriticalSection
 
    The number of writes perfomed in the critical section for the current
@@ -1245,7 +1343,7 @@ Output Fields
 
    .. versionadded:: 5.0
 
-.. data:: currentOp.totalCriticalSectionTimeElapsed
+.. data:: currentOp.totalCriticalSectionTimeElapsedSecs
 
    The total elapsed time, in seconds, for the critical section of the
    current :ref:`resharding operation <sharding-resharding>`. The
@@ -1258,6 +1356,9 @@ Output Fields
 
    .. versionadded:: 5.0
 
+   Starting in MongoDB 6.1, this metric is also available on the
+   coordinator during resharding.
+
 .. data:: currentOp.donorState
 
    The current state of a donor shard for the :ref:`resharding operation
@@ -1429,30 +1530,9 @@ Output Fields
 
 .. data:: currentOp.opStatus
 
-   The current state of a :ref:`resharding operation
-   <sharding-resharding>`.
-
-   Only present if a resharding operation is taking place. Once the
-   operation has completed, the operation is removed from ``currentOp``
-   output.
-
-   .. list-table::
-      :widths: 20 80
-      :header-rows: 1
-
-      * - State
-        - Description
-
-      * - ``actively running``
-        - The resharding operation is actively running.
-
-      * - ``success``
-        - The resharding operation has succeeded.
+   This metric is removed in version 6.1. For a list of new metrics that
+   replace and expand the reporting ``currentOp.opStatus`` provided,
+   see the :ref:`release notes <6.1-rel-notes-currentOp>`.
 
-      * - ``failure``
-        - The resharding operation has failed.
+   .. versionchanged:: 6.1
 
-      * - ``canceled``
-        - The resharding operation was canceled.
-
-   .. versionadded:: 5.0