DOCS-8257: client metadata capture

source/includes/fact-client-appname.rst

@@ -0,0 +1,7 @@
+.. versionadded:: 3.4
+
+The identifier of the client application which ran the operation.
+If the operation was run in :doc:`the MongoDB shell</mongo>`,
+the appName is always ``"MongoDB Shell"``. If the operation
+originated from a :ecosystem:`driver</drivers>`, ``appName`` may
+be set to a custom string.

source/reference/database-profiler.txt

@@ -124,6 +124,7 @@ example document reflects a find operation:
       },
       "ts" : ISODate("2015-09-03T15:26:14.948Z"),
       "client" : "127.0.0.1",
+      "appName" : "MongoDB Shell",
       "allUsers" : [ ],
       "user" : ""
    }
@@ -481,6 +482,10 @@ operation.
    For some operations, such as :method:`db.eval()`, the client is
    ``0.0.0.0:0`` instead of an actual client.
 
+.. data:: system.profile.appName
+
+   .. include:: /includes/fact-client-appname.rst
+
 .. data:: system.profile.allUsers
 
    An array of authenticated user information (user name and database)

source/reference/log-messages.txt

@@ -70,6 +70,66 @@ the amount of Informational and Debug messages MongoDB outputs.
 
 To set verbosity levels, see :ref:`log-messages-configure-verbosity`.
 
+Client Data
+-----------
+
+.. versionadded:: 3.4
+
+Client application debugging and performance monitoring is easier
+when you can clearly match server events with particular client
+requests. With this in mind, recent MongoDB
+`drivers <https://docs.mongodb.com/ecosystem/drivers/>`_ and client
+applications (including the :program:`mongo` shell) have the ability
+to send identifying information at the time of connection to the
+server. After the connection is established, the client does not send
+the identifying information again unless the connection is dropped
+and reestablished.
+
+The exact fields included vary by client. Below is a sample client
+data document:
+
+.. code-block:: javascript
+
+   {
+      application: {
+        name: "MongoDB Shell"
+      },
+      driver: {
+         name: "MongoDB Internal Client",
+         version: "3.4.0"
+      },
+      os: {
+         type: "Darwin",
+         name: "Mac OS X",
+         architecture: "x86_64",
+         version: "15.3.0"
+      }
+   }
+
+When secondary members of a
+:doc:`replica set </core/replica-set-members/>` initiate
+a connection to a primary, they send similar data. A typical
+connection document is as follows:
+
+.. code-block:: javascript
+
+   {
+      driver: {
+         name: "NetworkInterfaceASIO-Replication",
+         version: "3.4.0"
+      },
+      os: {
+         type: "Darwin",
+         name: "Mac OS X",
+         architecture: "x86_64",
+         version: "15.3.0"
+      }
+   }
+
+For a complete description of client information and required fields,
+see the
+`MongoDB Handshake specification <https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.rst>`_.
+
 .. _log-message-components:
 
 Components

source/reference/method/db.currentOp.txt

@@ -134,6 +134,7 @@ The following is a prototype of :method:`db.currentOp()` output.
             "insert" : <document>,
             "planSummary": <string>,
             "client" : <string>,
+            "appName" : <string>,
             "msg": <string>,
             "progress" : {
                 "done" : <number>,
@@ -337,6 +338,10 @@ Output Fields
    array has operations from many different clients, use this string
    to relate operations to clients.
 
+.. data:: currentOp.appName
+
+   .. include:: /includes/fact-client-appname.rst
+
 .. data:: currentOp.locks
 
    .. versionchanged:: 3.0