DOCSP-48005-max-log-file-count (#388)

* DOCSP-48005-max-log-file-count

* edits

* edits

* reset duration file

* review feedback

Author: jeff-allen-mongo

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

@@ -71,6 +71,14 @@
      - Directory where MongoDB Shell writes log files. Specify an
        absolute filepath. See :ref:`mongosh-log-location`.
 
+   * - ``logMaxFileCount``
+     - integer or Infinity
+     - 100
+     - Maximum number of log files that the |mdb-shell| retains. After
+       the |mdb-shell| reaches the maximum log file count, it starts
+       deleting the oldest log files until the count is below the
+       threshold. See :ref:`mongosh-log-file-count`.
+
    * - ``logRetentionDays``
      - integer or Infinity
      - 30

source/includes/specify-one-retention-criterion.rst

@@ -0,0 +1,4 @@
+.. important::
+
+   To prevent log storage from growing too large, always specify at
+   least one log retention criterion.

source/logs/retention.txt

@@ -20,6 +20,7 @@ Get Started
 To customize log retention, see these pages:
 
 - :ref:`mongosh-log-file-duration`
+- :ref:`mongosh-log-file-count`
 
 Details
 -------
@@ -30,3 +31,4 @@ Details
    :titlesonly:
 
    Duration </logs/retention/duration>
+   File Count </logs/retention/file-count>

source/logs/retention/file-count.txt

@@ -0,0 +1,83 @@
+.. _mongosh-log-file-count:
+
+=============================
+Modify Maximum Log File Count
+=============================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can specify the maximum number of log files that the |mdb-shell|
+retains. After the |mdb-shell| reaches the maximum log file count, it
+starts deleting the oldest log files until the count is below the
+threshold.
+
+The |mdb-shell| stores one log file for each session. By default, the
+|mdb-shell| stores up to 100 log files.
+
+About this Task
+---------------
+
+.. include:: /includes/log-retention-multiple-criteria.rst
+
+Before you Begin
+----------------
+
+To check the current maximum log file count, run the following command:
+
+.. code-block:: javascript
+
+   config.get("logMaxFileCount")
+
+Steps
+-----
+
+To modify the maximum log file count, set the ``logMaxFileCount``
+configuration option. You can set configuration options in the
+:ref:`configuration API <configure-settings-api>` or a
+:ref:`configuration file <configure-settings-global>`.
+
+Modify Maximum Log File Count with the Configuration API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following command uses the config API to set the maximum log file
+count to 200:
+
+.. io-code-block::
+   :copyable: true
+
+   .. input::
+      :language: javascript
+
+      config.set("logMaxFileCount", 200)
+
+   .. output::
+      :language: javascript
+
+      Setting "logMaxFileCount" has been changed
+
+Modify Maximum Log File Count with a Configuration File
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following configuration file sets the maximum log file count to 200:
+
+.. code-block:: yaml
+
+   mongosh:
+     logMaxFileCount: 200
+
+Disable Maximum Log File Limit
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To disable the maximum log file limit, set ``logMaxFileCount`` to
+``Infinity``. You can perform this action through the config API or
+configuration file. For example:
+
+.. code-block:: javascript
+
+   config.set("logMaxFileCount", Infinity)
+
+.. include:: /includes/specify-one-retention-criterion.rst