DOCSP-48000-log-compression (#386)

* DOCSP-48000-log-compression

* edits

* clarify restart behavior

* add cross link

Author: jeff-allen-mongo

source/includes/list-table-shell-properties.rst

@@ -57,6 +57,13 @@
      - The depth to which objects are printed. Setting ``inspectDepth``
        to ``Infinity`` (the javascript object) prints all nested
        objects to their full depth. 
+   
+   * - ``logCompressionEnabled``
+     - boolean
+     - false
+     - Specifies whether |mdb-shell| compresses log files. When this
+       value is ``true``, |mdb-shell| uses gzip to compress logs. See
+       :ref:`mongosh-log-compression`.
 
    * - ``logLocation``
      - string

source/logs.txt

@@ -72,3 +72,4 @@ automatically deletes log files older than 30 days.
    Disable Logging </logs/disable>
    Specify Log Location <logs/location> 
    Write Custom Log Entries <logs/custom-entries> 
+   Enable Log Compression </logs/compression>

source/logs/compression.txt

@@ -0,0 +1,76 @@
+.. _mongosh-log-compression:
+
+======================
+Enable Log Compression
+======================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can enable compression for |mdb-shell| log files. By default,
+|mdb-shell| does not compress log files.
+
+About this Task
+---------------
+
+When log compression is enabled, |mdb-shell| compresses log files with
+gzip.
+
+After you toggle log compression, you must start a new |mdb-shell|
+session for the change to take effect.
+
+Before you Begin
+----------------
+
+To check if log compression is enabled, run the following command from
+|mdb-shell|:
+
+.. code-block:: javascript
+
+   config.get("logCompressionEnabled")
+
+Steps
+-----
+
+To enable log compression, set the ``logCompressionEnabled``
+configuration option to ``true``. You can set configuration options in
+the :ref:`configuration API <configure-settings-api>` or a
+:ref:`configuration file <configure-settings-global>`.
+
+Enable Log Compression with the Configuration API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following command uses the config API to enable log compression:
+
+.. io-code-block::
+   :copyable: true
+
+   .. input::
+      :language: javascript
+
+      config.set("logCompressionEnabled", true)
+
+   .. output::
+      :language: javascript
+
+      Setting "logCompressionEnabled" has been changed
+
+Enable Log Compression with a Configuration File
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following configuration file enables log compression:
+
+.. code-block:: yaml
+
+   mongosh:
+     logCompressionEnabled: true
+
+Disable Log Compression
+~~~~~~~~~~~~~~~~~~~~~~~
+
+To disable log compression, set ``logCompressionEnabled`` to ``false``.
+You can perform this action through the config API or configuration
+file.

source/logs/location.txt

@@ -34,9 +34,8 @@ To view the current log file location, use the :ref:`config API
 
    config.get("logLocation")
 
-After you modify your log file location, your current MongoDB Shell
-session continues to use the previous log file location. Sessions that
-start after you change the log file location use the updated location.
+After you modify your log file location, you must start a new
+|mdb-shell| session for the change to take effect.
 
 Log File Names
 ~~~~~~~~~~~~~~