DOCS-15016 add apiversion to serverStatus (#443) (#513)

* DOCS-15016 add apiversion to serverStatus

* add code block to versioned-api.txt

* remove quotes

* remove reference to 4.7

* Add placeholder comments

* Add context

* verb tense update

* populates -> appears

* xuerui comments #1

* command -> metric

* monospace appname on versioned-api.txt

* a -> for a

Author: ianf-mongodb

source/reference/command/serverStatus.txt

@@ -4870,6 +4870,11 @@ metrics
 .. code-block:: javascript
 
    "metrics" : {
+      "apiVersions": {
+         "<appName1>": <string>, 
+         "<appName2>": <string>, 
+         "<appName3>": <string>
+      },
       "aggStageCounters" : {
             "<aggregation stage>" : NumberLong(<num>)
       },
@@ -5046,6 +5051,36 @@ metrics
 
    *New in version 4.4 (4.2.6 and 4.0.19).* 
 
+.. _server-status-apiVersions:
+
+.. serverstatus:: metrics.apiVersions
+
+   A document with client applications and the version of Stable 
+   API which they are configured with. Consider the following when
+   viewing ``metrics.apiVersions``:
+
+   - The only possible returned values for each ``appname`` are 
+     ``default`` or ``1``.
+
+   - API version metrics are retained for 24 hours. If
+     no commands are issued with a specific API version from an 
+     application in the past 24 hours, that ``appname`` and API version 
+     will be removed from the metrics. This also applies to the 
+     ``default`` API version metric.
+
+   - Set the ``appname`` when connecting to a MongoDB instance by 
+     specifying the ``appname`` in the connection URI. ``?appName=ZZZ`` 
+     sets the ``appname`` to ``ZZZZ``.
+
+   - Drivers accessing the Stable API can set a default ``appname``.
+
+   - If no ``appname`` is configured, a default value will be 
+     automatically populated based on the product. For example, for a 
+     :compass:`MongoDB Compass </>` connection with no ``appname`` in 
+     the URI, the metric returns: ``'MongoDB Compass': [ 'default' ]``.
+
+   *New in version 5.0.* 
+
 .. serverstatus:: metrics.operatorCounters
 
    A document with a number that indicates how often

source/reference/stable-api.txt

@@ -206,6 +206,21 @@ By default, clients are *non-strict*. A non-strict client allows you
 to run any command, regardless of whether or not it belongs to the 
 Stable API.
 
+Checking Client API Versions
+----------------------------
+
+Use the :dbcommand:`serverStatus` command to check for your 
+application's configured API version. For each application connected to 
+your MongoDB instance, an ``appname`` appears in the ``apiVersions`` 
+document.
+
+See :ref:`metrics.apiVersions <server-status-apiVersions>` for more 
+information.
+
+.. code-block:: javascript
+
+   db.runCommand( { serverStatus: 1 } ).metrics.apiVersions
+
 Create a Strict Client 
 ----------------------
 

source/release-notes/5.0.txt

@@ -988,6 +988,9 @@ Aggregation Metrics
   - :serverstatus:`metrics.dotsAndDollarsFields`
   - :serverstatus:`metrics.operatorCounters`
 
+API Version Metrics
+  - :serverstatus:`metrics.apiVersions`
+
 Replication Metrics
   - :serverstatus:`metrics.repl.reconfig.numAutoReconfigsForRemovalOfNewlyAddedFields`