DOCSP-34783 Atlas Support for Diagnostics Commands (#5750) (#9463)

jwilson-mdb · pierwill · web-flow · commit 9edd3b1aad5c · 2024-09-24T11:36:14.000-07:00
* DOCSP-34783 Atlas Support for Diagnostics Commands (#5750) * Removes QE reference --------- Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
diff --git a/source/reference/command/buildInfo.txt b/source/reference/command/buildInfo.txt
@@ -18,6 +18,17 @@ Definition
    The :dbcommand:`buildInfo` command returns a build summary for the current
    :binary:`~bin.mongod`. 
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/collStats.txt b/source/reference/command/collStats.txt
@@ -34,6 +34,17 @@ Definition
 
    .. include:: /includes/fact-dbcommand.rst
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/connPoolStats.txt b/source/reference/command/connPoolStats.txt
@@ -26,6 +26,17 @@ Definition
 
    .. include:: /includes/note-conn-pool-stats.rst
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/connectionStatus.txt b/source/reference/command/connectionStatus.txt
@@ -18,6 +18,17 @@ Definition
    Returns information about the current connection, specifically the
    state of authenticated users and their available permissions.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/dataSize.txt b/source/reference/command/dataSize.txt
@@ -18,6 +18,18 @@ Definition
    The :dbcommand:`dataSize` command returns the size in bytes for
    the specified data.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+   
 Syntax
 ------
 
diff --git a/source/reference/command/dbHash.txt b/source/reference/command/dbHash.txt
@@ -25,6 +25,17 @@ Definition
    The :dbcommand:`dbHash` command obtains a shared (S) lock on the
    database, which prevents writes until the command completes.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free-or-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/dbStats.txt b/source/reference/command/dbStats.txt
@@ -18,6 +18,18 @@ Definition
    The :dbcommand:`dbStats` command returns storage statistics for a
    given database. 
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-limited-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+   
 Syntax
 ------
 
diff --git a/source/reference/command/getCmdLineOpts.txt b/source/reference/command/getCmdLineOpts.txt
@@ -20,6 +20,17 @@ Definition
    :binary:`~bin.mongod` or :binary:`~bin.mongos`. Run
    :dbcommand:`getCmdLineOpts` in the ``admin`` database.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/getLog.txt b/source/reference/command/getLog.txt
@@ -25,6 +25,17 @@ Definition
    :ref:`Relaxed Extended JSON v2.0 <mongodb-extended-json-v2>` format. 
    Previously, log data was returned as plaintext.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/hostInfo.txt b/source/reference/command/hostInfo.txt
@@ -23,6 +23,17 @@ Definition
    You must run the :dbcommand:`hostInfo` command, which takes no
    arguments, against the ``admin`` database. 
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/listCommands.txt b/source/reference/command/listCommands.txt
@@ -19,6 +19,17 @@ Definition
    database commands implemented for the current :binary:`~bin.mongod` or
    :binary:`~bin.mongos` instance.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/lockInfo.txt b/source/reference/command/lockInfo.txt
@@ -19,6 +19,17 @@ Definition
    pending. :dbcommand:`lockInfo` is an internal command available on
    :binary:`~bin.mongod` instances only.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/ping.txt b/source/reference/command/ping.txt
@@ -19,6 +19,17 @@ Definition
    server is responding to commands. This command will return
    immediately even if the server is write-locked:
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/profile.txt b/source/reference/command/profile.txt
@@ -64,6 +64,17 @@ Definition
 
    .. include:: /includes/warning-profiler-performance.rst
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt
@@ -35,6 +35,17 @@ Definition
    applications can run this command at a regular interval to
    collect statistics about the instance.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/shardConnPoolStats.txt b/source/reference/command/shardConnPoolStats.txt
@@ -40,6 +40,17 @@ Definition
    MongoDB returns the connection to the connection pool after every
    operation.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Output
 ------
 
diff --git a/source/reference/command/top.txt b/source/reference/command/top.txt
@@ -32,6 +32,17 @@ microseconds, that each :ref:`event <event-types>` takes to execute and a
 ``count`` metrics reset only after you restart your :binary:`~bin.mongod` 
 instance.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/validate.txt b/source/reference/command/validate.txt
@@ -37,6 +37,17 @@ Definition
    :binary:`~bin.mongosh` provides a wrapper around
    :dbcommand:`validate`.
 
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free-or-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/command/whatsmyuri.txt b/source/reference/command/whatsmyuri.txt
@@ -15,3 +15,14 @@ whatsmyuri
    :dbcommand:`whatsmyuri` is an internal command.
 
    .. slave-ok
+
+Compatibility
+-------------
+
+This command is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
