DOCSP-46868-improve-docs-observability-stuck-index-builds (#10969)

* Clarify sentence instructing users to use  instead of db.currentOp()

* fix render

* update the createIndex and db.currentOp page

* reviewer update

* reviewer updates

* reviewer updates

* rendering issue

* aggregation stages fix

* rendering code block

* reviewer update

* wording

* reviewer updates

* reviewer updates

* .

Author: amalhotra-mdb

source/core/indexes/create-index.txt

@@ -97,7 +97,7 @@ about an active operation that builds a descending index on the ``name`` field:
       :language: javascript
 
       db.getSiblingDB("admin").aggregate( [
-         { $currentOp : {} },
+         { $currentOp : { idleConnections: true } },
          { $match : {"command.createIndexes": { $exists: true } } }
       ] )
 
@@ -158,6 +158,10 @@ about an active operation that builds a descending index on the ``name`` field:
          }, ...
       ]
 
+MongoDB marks index builds in various stages, including waiting on commit quorum, as an
+idle connection by setting the ``active`` field to ``false``. The ``idleConnections: true``
+setting includes these idle connections in the ``$currentOp`` output.
+
 To view information on existing indexes using a driver, refer to your
 :driver:`driver's documentation </>`.
 

source/core/sharding-reshard-a-collection.txt

@@ -98,21 +98,21 @@ requirements:
   Once the resharding operation completes, you can remove the old shard
   key from the queries.
 
-- No index builds are in progress. Use ``db.currentOp()`` to
-  check for any running index builds:
+- No index builds are in progress. To check for running index builds, 
+  use ``$currentOp``:
 
   .. code-block:: javascript
-     :copyable: false
-
-     db.adminCommand(
-        {
-          currentOp: true,
-          $or: [
-            { op: "command", "command.createIndexes": { $exists: true }  },
-            { op: "none", "msg" : /^Index Build/ }
-          ]
+     
+     db.getSiblingDB("admin").aggregate( [
+        { $currentOp : { idleConnections: true } },
+        { $match: {
+              $or: [
+                  { "op": "command", "command.createIndexes": { $exists: true } },
+                  { "op": "none", "msg": /^Index Build/ }
+              ]
+           }
         }
-    )
+     ] )
 
   In the result document, if the ``inprog`` field value is an empty
   array, there are no index builds in progress:

source/includes/fact-currentOp-aggregation-stage.rst

@@ -1,3 +1,4 @@
-Use the :pipeline:`$currentOp` aggregation stage instead 
-of the :dbcommand:`currentOp` command and its 
+The :dbcommand:`currentOp` database command is deprecated 
+since version 6.2. Use the :pipeline:`$currentOp` aggregation 
+stage instead of the :dbcommand:`currentOp` command and its 
 :binary:`~bin.mongosh` helper method :method:`db.currentOp()`.

source/reference/command/currentOp.txt

@@ -217,15 +217,20 @@ The following example returns information on index creation operations:
 
 .. code-block:: javascript
 
-   db.adminCommand(
-       {
-         currentOp: true,
-         $or: [
-           { op: "command", "command.createIndexes": { $exists: true }  },
-           { op: "none", "msg" : /^Index Build/ }
-         ]
-       }
-   )
+   db.getSiblingDB("admin").aggregate( [
+      { $currentOp : { idleConnections: true } },
+      { $match: {
+            $or: [
+               { "op": "command", "command.createIndexes": { $exists: true } },
+               { "op": "none", "msg": /^Index Build/ }
+            ]
+        }
+      }
+   ] )
+
+MongoDB marks index builds waiting on commit quorum to complete the operation as an 
+idle connection by setting the ``active`` field to ``false``. The ``idleConnections: true``
+setting includes these idle connections in the ``$currentOp`` output. 
 
 Output Example
 --------------

source/reference/method/db.currentOp.txt

@@ -19,12 +19,14 @@ Definition
 
    .. |operation| replace:: :method:`db.currentOp()`
 
+   .. important:: 
+   
+      .. include:: /includes/fact-currentOp-aggregation-stage.rst
+
    Returns a :term:`document` that contains information on in-progress
    operations for the database instance. The :method:`db.currentOp()`
    method wraps the database command :dbcommand:`currentOp`. 
 
-   .. include:: /includes/fact-currentOp-aggregation-stage.rst
-
    .. note::
 
       .. include:: /includes/5.0-fact-currentop.rst
@@ -108,6 +110,7 @@ filter. The filter document can contain:
    * - ``"$all"``
      - Boolean. If set to ``true``, returns information on all operations,
        including operations on idle connections and system operations.
+       For more information, see :ref:`<current-op-agg>`.
 
        If the document includes ``"$all": true`` along with
        :ref:`db.currentOp-output-fields` conditions, only the
@@ -224,16 +227,16 @@ on any number of fields:
 
 .. code-block:: javascript
 
-   db.adminCommand(
-       {
-         currentOp: true,
-         $or: [
-           { op: "command", "command.createIndexes": { $exists: true }  },
-           { op: "command", "command.$truncated": /^\{ createIndexes/  },
-           { op: "none", "msg" : /^Index Build/ }
-         ]
-       }
-   )
+   db.getSiblingDB("admin").aggregate( [
+      { $currentOp : { idleConnections: true } },
+      { $match: {
+            $or: [
+               { "op": "command", "command.createIndexes": { $exists: true } },
+               { "op": "none", "msg": /^Index Build/ }
+            ]
+         }
+      }
+   ] )
 
 Output Example
 --------------