Docsp 27636: Add maxDocumentLength (#375)

* DOCSP-27636: Adding new logging settings options.

* Added Logger section

* Added code example

* PR feedback

* Missed a label correction.

* Final PR feedback touches

Author: DBirtolo-mdb

source/fundamentals/connection/mongoclientsettings.txt

@@ -42,7 +42,7 @@ To create a ``MongoClientSettings`` object, use the
 settings. After chaining them, use the ``build()`` method to create the
 ``MongoClientSettings`` object.
 
-The following table describes all the methods you can chain to modify your
+The following table describes the methods you can chain to modify your
 connection behavior:
 
 .. list-table::
@@ -71,6 +71,10 @@ connection behavior:
      - Applies the ``ConnectionPoolSettings.Builder`` block and then sets the
        :ref:`connection pool settings <mcs-connectionpool-settings>`.
 
+   * - ``applyToLoggerSettings()``
+     - Applies the ``LoggerSettings.Builder`` block and then sets the
+       :ref:`logger settings <mcs-logger-settings>`.
+
    * - ``applyToServerSettings()``
      - Applies the ``ServerSettings.Builder`` block and then sets the
        :ref:`server settings <mcs-server-settings>`.
@@ -201,7 +205,7 @@ Chain the `applyToClusterSettings() <{+api+}/apidocs/mongodb-driver-core/com/mon
 method to modify the driver's behavior when interacting with your
 MongoDB cluster.
 
-The following table describes all the methods you can chain to your
+The following table describes the methods you can chain to your
 settings to modify the driver's behavior:
 
 .. list-table::
@@ -289,60 +293,6 @@ regardless of the type of MongoDB cluster its' a part of:
    in your connection URI. See :ref:`<connection-options>` for more
    information.
 
-.. _mcs-socket-settings:
-
-Socket Settings
----------------
-
-Chain the `applyToSocketSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSocketSettings(com.mongodb.Block)>`__
-method to modify the driver's behavior when connecting and communicating
-with your MongoDB server.
-
-The following table describes all the methods you can chain to your settings
-to modify the driver's behavior:
-
-.. list-table::
-   :widths: 40 60
-   :header-rows: 1
-
-   * - Method
-     - Description
-
-   * - ``applyConnectionString()``
-     - Uses the settings from a ``ConnectionString`` object.
-
-   * - ``applySettings()``
-     - Uses the socket settings specified in a ``SocketSettings`` object.
-
-   * - ``connectTimeout()``
-     - Sets the maximum time to connect to an available socket before throwing
-       a timeout exception.
-
-   * - ``readTimeout()``
-     - Sets the maximum time to read to an available socket before throwing a
-       timeout exception.
-
-   * - ``receiveBufferSize()``
-     - Sets the socket's buffer size when receiving.
-
-   * - ``sendBufferSize()``
-     - Sets the socket's buffer size when sending.
-
-Example
-~~~~~~~
-
-This example specifies the following driver behavior in a MongoDB socket:
-
-- To connect to an available socket within ``10 SECONDS``
-- To read from an available socket within ``15 SECONDS``
-
-.. literalinclude:: /includes/fundamentals/code-snippets/mcs.java
-   :start-after: begin SocketSettings
-   :end-before: end SocketSettings
-   :language: java
-   :emphasize-lines: 3-5
-   :dedent:
-
 .. _mcs-connectionpool-settings:
 
 Connection Pool Settings
@@ -351,7 +301,7 @@ Connection Pool Settings
 Chain the `applyToConnectionPoolSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToConnectionPoolSettings(com.mongodb.Block)>`__
 method to modify the way the driver manages its connection pool.
 
-The following table describes all the methods you can chain to your
+The following table describes the methods you can chain to your
 settings to modify the driver's behavior:
 
 .. list-table::
@@ -421,6 +371,41 @@ This example specifies the following driver behavior in a pool of
    :emphasize-lines: 3-5
    :dedent:
 
+.. _mcs-logger-settings:
+
+Logger Settings
+---------------
+
+Chain the `applyToLoggerSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToLoggerSettings(com.mongodb.Block)>`__
+method to modify the logging behavior of the driver.
+
+The following table describes the methods you can chain to your
+settings to modify the logging behavior:
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+
+   * - ``maxDocumentLength()``
+     - Sets the maximum document length, in characters, of a single log
+       message.
+
+Example
+~~~~~~~
+
+This example specifies that the maximum number of characters for a single log
+message is set to ``5000`` characters.
+
+.. literalinclude:: /includes/fundamentals/code-snippets/mcs.java
+   :start-after: begin LoggerSettings
+   :end-before: end LoggerSettings
+   :language: java
+   :emphasize-lines: 3-4
+   :dedent:
+
 .. _mcs-server-settings:
 
 Server Settings
@@ -430,7 +415,7 @@ Chain the `applyToServerSettings() <{+api+}/apidocs/mongodb-driver-core/com/mong
 method to modify the driver's behavior when monitoring each MongoDB
 server.
 
-The following table describes all the methods you can chain to your
+The following table describes the methods you can chain to your
 settings to modify the driver's behavior:
 
 .. list-table::
@@ -474,6 +459,60 @@ This example specifies the following driver behavior in a MongoDB server:
    :emphasize-lines: 3-5
    :dedent:
 
+.. _mcs-socket-settings:
+
+Socket Settings
+---------------
+
+Chain the `applyToSocketSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSocketSettings(com.mongodb.Block)>`__
+method to modify the driver's behavior when connecting and communicating
+with your MongoDB server.
+
+The following table describes the methods you can chain to your settings
+to modify the driver's behavior:
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+
+   * - ``applyConnectionString()``
+     - Uses the settings from a ``ConnectionString`` object.
+
+   * - ``applySettings()``
+     - Uses the socket settings specified in a ``SocketSettings`` object.
+
+   * - ``connectTimeout()``
+     - Sets the maximum time to connect to an available socket before throwing
+       a timeout exception.
+
+   * - ``readTimeout()``
+     - Sets the maximum time to read to an available socket before throwing a
+       timeout exception.
+
+   * - ``receiveBufferSize()``
+     - Sets the socket's buffer size when receiving.
+
+   * - ``sendBufferSize()``
+     - Sets the socket's buffer size when sending.
+
+Example
+~~~~~~~
+
+This example specifies the following driver behavior in a MongoDB socket:
+
+- To connect to an available socket within ``10 SECONDS``
+- To read from an available socket within ``15 SECONDS``
+
+.. literalinclude:: /includes/fundamentals/code-snippets/mcs.java
+   :start-after: begin SocketSettings
+   :end-before: end SocketSettings
+   :language: java
+   :emphasize-lines: 3-5
+   :dedent:
+
 .. _mcs-ssl-settings:
 
 TLS/SSL Settings
@@ -483,7 +522,7 @@ Chain the `applyToSslSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb
 method to modify the driver's behavior when using TLS/SSL to secure a
 connection between your application and MongoDB.
 
-The following table describes all the methods you can chain to your
+The following table describes the methods you can chain to your
 settings to modify the driver's behavior:
 
 .. list-table::

source/includes/fundamentals/code-snippets/mcs.java

@@ -134,4 +134,20 @@ private static void createSslSettings() {
             System.out.print("---------------------------------------");
         }
     }
+
+    private static void createLoggerSettings() {
+        try {
+            ////begin LoggerSettings
+            MongoClient mongoClient = MongoClients.create(
+                MongoClientSettings.builder().applyConnectionString(new ConnectionString("<your connection string>"))
+                .applyToLoggerSettings(builder ->
+                     builder.maxDocumentLength(5_000))
+                .build());
+            //end LoggerSettings
+            mongoClient.listDatabaseNames().forEach(n -> System.out.println(n));
+            mongoClient.close();
+        } finally {
+            System.out.print("---------------------------------------");
+        }
+    }
 }