From a7c0e119688ed96c3360ad7f3860c38bd392df71 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 26 Feb 2025 17:03:19 -0500 Subject: [PATCH 01/18] DOCSP-47935-log-retention-duration --- snooty.toml | 3 ++- source/logs.txt | 10 ++++++---- source/logs/retention.txt | 30 ++++++++++++++++++++++++++++++ source/logs/retention/duration.txt | 7 +++++++ 4 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 source/logs/retention.txt create mode 100644 source/logs/retention/duration.txt diff --git a/snooty.toml b/snooty.toml index 3d521871..0f183e96 100644 --- a/snooty.toml +++ b/snooty.toml @@ -13,7 +13,8 @@ toc_landing_pages = ["/install", "/configure-mongosh", "/reference/configure-shell-settings", "/reference/ejson", - "/logs" + "/logs", + "/logs/retention" ] [constants] diff --git a/source/logs.txt b/source/logs.txt index 362cc1ea..9539a77e 100644 --- a/source/logs.txt +++ b/source/logs.txt @@ -63,11 +63,13 @@ history: Log Retention ------------- -``mongosh`` retains up to 100 log files for 30 days. ``mongosh`` -automatically deletes log files older than 30 days. +By default, ``mongosh`` retains up to 100 log files for 30 days. +``mongosh`` automatically deletes log files older than 30 days. To +customize log file retention, see :ref:`mongosh-logs-retention`. .. toctree:: :titlesonly: - Specify Log Location - Write Custom Log Entries + Specify Log Location + Write Custom Log Entries + Retention diff --git a/source/logs/retention.txt b/source/logs/retention.txt new file mode 100644 index 00000000..b6fcc506 --- /dev/null +++ b/source/logs/retention.txt @@ -0,0 +1,30 @@ +.. _mongosh-logs-retention: + +============= +Log Retention +============= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +You can customize how |mdb-shell| logs are retained. By default, the +system retains 100 log files for 30 days. You can choose to retain logs +based on a combination of time, file size, and number of log files. + +Get Started +----------- + +To customize log retention, see these pages: + +- :ref:`mongosh-log-file-duration` + +Details +------- + +You can specify multiple criteria for log retention. For example, you +can specify a maximum duration for log files of 60 days and a maximum +file size of 2GB. When you specify multiple log retention criteria, log +files are cleaned up when any of the criteria are met. diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt new file mode 100644 index 00000000..3d868d49 --- /dev/null +++ b/source/logs/retention/duration.txt @@ -0,0 +1,7 @@ +.. _mongosh-log-file-duration: + +================================ +Customize Log Retention Duration +================================ + +Test From 7af6a87081ea8a9453c6650c4c833ffa4e1341a8 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 26 Feb 2025 17:25:12 -0500 Subject: [PATCH 02/18] add duration page to toc --- source/logs/retention.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/logs/retention.txt b/source/logs/retention.txt index b6fcc506..8bb216a9 100644 --- a/source/logs/retention.txt +++ b/source/logs/retention.txt @@ -28,3 +28,8 @@ You can specify multiple criteria for log retention. For example, you can specify a maximum duration for log files of 60 days and a maximum file size of 2GB. When you specify multiple log retention criteria, log files are cleaned up when any of the criteria are met. + +.. toctree:: + :titlesonly: + + Duration From 6d28fe4726b9facf2ba84d67e7abd66f97d1eeb6 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 27 Feb 2025 11:21:17 -0500 Subject: [PATCH 03/18] WIP --- source/includes/list-table-shell-properties.rst | 8 +++++++- source/logs/retention/duration.txt | 16 ++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/source/includes/list-table-shell-properties.rst b/source/includes/list-table-shell-properties.rst index aee4c81c..2892e181 100644 --- a/source/includes/list-table-shell-properties.rst +++ b/source/includes/list-table-shell-properties.rst @@ -51,7 +51,7 @@ - 6 - The depth to which objects are printed. Setting ``inspectDepth`` to ``Infinity`` (the javascript object) prints all nested - objects to their full depth. + objects to their full depth. * - ``logLocation`` - string @@ -59,6 +59,12 @@ - Directory where MongoDB Shell writes log files. Specify an absolute filepath. See :ref:`mongosh-log-location`. + * - ``logRetentionDays`` + - integer + - 30 + - Number of days that |mdb-shell| log files are retained. Only + applicable when ``disableLogging`` is ``false``. + * - ``redactHistory`` - string - ``remove`` diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index 3d868d49..ef43d795 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -1,7 +1,15 @@ .. _mongosh-log-file-duration: -================================ -Customize Log Retention Duration -================================ +============================= +Modify Log Retention Duration +============================= -Test +You can modify how long |mdb-shell| log files are retained. By default, +log files are retained for 30 days. + +Steps +----- + +To modify how long log files are retained, set the ``logRetentionDays`` +configuration options. You can set configuration options in the +configuration API or a configuration file. From 07bd49bb171d97494f1e84c6fad1b9889fa3dfc7 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 09:57:54 -0500 Subject: [PATCH 04/18] edit --- source/includes/list-table-shell-properties.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/source/includes/list-table-shell-properties.rst b/source/includes/list-table-shell-properties.rst index f21c14f4..8a28c658 100644 --- a/source/includes/list-table-shell-properties.rst +++ b/source/includes/list-table-shell-properties.rst @@ -65,9 +65,13 @@ absolute filepath. See :ref:`mongosh-log-location`. * - ``logRetentionDays`` - - integer + - integer or Infinity - 30 - - Number of days that |mdb-shell| log files are retained. + - Number of days that |mdb-shell| log files are retained. If this + value is set to ``Infinity``, log files are not deleted based on + age. To prevent log storage from growing too large, you should + always specify at least one log retention criteria. See + :ref:`mongosh-logs-retention`. * - ``redactHistory`` - string From c7d69a9bfce7ee6db86273d3ea716c61d662a0ad Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:02:31 -0500 Subject: [PATCH 05/18] edit --- source/logs/retention/duration.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index f8e14c49..4f89df68 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -58,3 +58,15 @@ days: mongosh: logRetentionDays: 60 + +Disable Duration-Based Log Cleanup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To not delete log files based on log file age, set ``logRetentionDays`` +to ``Infinity``. You can perform this action through the config API or +configuration file. + +.. important:: + + To prevent log storage from growing too large, you should always + specify at least one log retention criteria. From 27f1fc783a78055e9ad8ec58147cd15f22d69bcc Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:04:08 -0500 Subject: [PATCH 06/18] wording --- source/includes/log-retention-multiple-criteria.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/log-retention-multiple-criteria.rst b/source/includes/log-retention-multiple-criteria.rst index 4d927918..feb8b0e0 100644 --- a/source/includes/log-retention-multiple-criteria.rst +++ b/source/includes/log-retention-multiple-criteria.rst @@ -1,4 +1,4 @@ You can specify multiple criteria for log retention. For example, you can specify a maximum duration for log files of 60 days and a maximum -log file size of 2GB. In this scenario, logs are deleted when any -criteria is met, starting with the oldest logs. +log file size of 2GB. Logs are deleted when any retention criterion is +met, starting with the oldest logs. From 5a37429d9986c89ffccc7539f233a1f266ee5bb1 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:05:01 -0500 Subject: [PATCH 07/18] edit --- source/includes/list-table-shell-properties.rst | 2 +- source/logs/retention/duration.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/list-table-shell-properties.rst b/source/includes/list-table-shell-properties.rst index 8a28c658..d52b2675 100644 --- a/source/includes/list-table-shell-properties.rst +++ b/source/includes/list-table-shell-properties.rst @@ -70,7 +70,7 @@ - Number of days that |mdb-shell| log files are retained. If this value is set to ``Infinity``, log files are not deleted based on age. To prevent log storage from growing too large, you should - always specify at least one log retention criteria. See + always specify at least one log retention criterion. See :ref:`mongosh-logs-retention`. * - ``redactHistory`` diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index 4f89df68..afa6bd2f 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -69,4 +69,4 @@ configuration file. .. important:: To prevent log storage from growing too large, you should always - specify at least one log retention criteria. + specify at least one log retention criterion. From 1edfd55225ec2cca32b152aa491a925c3ff82bc2 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:06:38 -0500 Subject: [PATCH 08/18] edit --- source/includes/list-table-shell-properties.rst | 4 ++-- source/logs/retention/duration.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/includes/list-table-shell-properties.rst b/source/includes/list-table-shell-properties.rst index d52b2675..528692c0 100644 --- a/source/includes/list-table-shell-properties.rst +++ b/source/includes/list-table-shell-properties.rst @@ -69,8 +69,8 @@ - 30 - Number of days that |mdb-shell| log files are retained. If this value is set to ``Infinity``, log files are not deleted based on - age. To prevent log storage from growing too large, you should - always specify at least one log retention criterion. See + age. To prevent log storage from growing too large, always + specify at least one log retention criterion. See :ref:`mongosh-logs-retention`. * - ``redactHistory`` diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index afa6bd2f..b6dd2c4a 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -68,5 +68,5 @@ configuration file. .. important:: - To prevent log storage from growing too large, you should always - specify at least one log retention criterion. + To prevent log storage from growing too large, always specify at + least one log retention criterion. From 18663f20f317bb56fd19fc932db27f6a6cb301ae Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:11:00 -0500 Subject: [PATCH 09/18] edit --- source/includes/log-retention-multiple-criteria.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/log-retention-multiple-criteria.rst b/source/includes/log-retention-multiple-criteria.rst index feb8b0e0..33f34c42 100644 --- a/source/includes/log-retention-multiple-criteria.rst +++ b/source/includes/log-retention-multiple-criteria.rst @@ -1,4 +1,4 @@ You can specify multiple criteria for log retention. For example, you can specify a maximum duration for log files of 60 days and a maximum -log file size of 2GB. Logs are deleted when any retention criterion is -met, starting with the oldest logs. +log storage size of 2GB. Logs are deleted when any retention criterion +is met, starting with the oldest logs. From b06fe682f1e65ebbd9fa50b818d35c1c9232e60e Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:18:40 -0500 Subject: [PATCH 10/18] wording --- source/logs/retention/duration.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index b6dd2c4a..00c4be6b 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -62,9 +62,9 @@ days: Disable Duration-Based Log Cleanup ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To not delete log files based on log file age, set ``logRetentionDays`` -to ``Infinity``. You can perform this action through the config API or -configuration file. +To instruct |mdb-shell| to not delete logs based on file age, set +``logRetentionDays`` to ``Infinity``. You can perform this action +through the config API or configuration file. .. important:: From b1a0999875e1b79b763c11ad8189074de5d1dc0b Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 10:37:22 -0500 Subject: [PATCH 11/18] retry build From 0181e39ae870892e8b222bd1c1f71c8937d10c15 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 12:25:15 -0500 Subject: [PATCH 12/18] DOCSP-47935-log-storage-size --- .../specify-one-retention-criterion.rst | 4 + source/logs/retention.txt | 2 + source/logs/retention/duration.txt | 11 ++- source/logs/retention/size.txt | 91 +++++++++++++++++++ 4 files changed, 104 insertions(+), 4 deletions(-) create mode 100644 source/includes/specify-one-retention-criterion.rst create mode 100644 source/logs/retention/size.txt diff --git a/source/includes/specify-one-retention-criterion.rst b/source/includes/specify-one-retention-criterion.rst new file mode 100644 index 00000000..ecb4fb3d --- /dev/null +++ b/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. diff --git a/source/logs/retention.txt b/source/logs/retention.txt index 21eaea7f..99dbc051 100644 --- a/source/logs/retention.txt +++ b/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-retention-gb` Details ------- @@ -30,3 +31,4 @@ Details :titlesonly: Duration + Storage Size diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index 00c4be6b..c1cb112b 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -4,6 +4,12 @@ Modify Log Retention Duration ============================= +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + You can modify how long |mdb-shell| log files are retained. A log cleanup process automatically deletes log files older than the specified retention period. By default, log files are retained for 30 days. @@ -66,7 +72,4 @@ To instruct |mdb-shell| to not delete logs based on file age, set ``logRetentionDays`` to ``Infinity``. You can perform this action through the config API or configuration file. -.. important:: - - To prevent log storage from growing too large, always specify at - least one log retention criterion. +.. include:: /includes/specify-one-retention-criterion.rst diff --git a/source/logs/retention/size.txt b/source/logs/retention/size.txt new file mode 100644 index 00000000..3977a5b7 --- /dev/null +++ b/source/logs/retention/size.txt @@ -0,0 +1,91 @@ +.. _mongosh-log-retention-gb: + +=============================== +Modify Maximum Log Storage Size +=============================== + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +You can specify a maximum combined storage size for |mdb-shell| log +files. If the total size of all log files exceeds the maximum, log files +are deleted until the combined size is below the threshold, starting +with the oldest log files. By default, there is no maximum log storage +size. + +About this Task +--------------- + +To specify a maximum log storage size, set the ``logRetentionGB`` +configuration option. ``logRetentionGB`` can be any positive float +value (including less than ``1``). + +.. include:: /includes/log-retention-multiple-criteria.rst + +To check the current storage size of log files, check the size of the +log folder. To see the current log folder, run the following command +from |mdb-shell|: + +.. code-block:: javascript + + config.get('logLocation') + +Before you Begin +---------------- + +To check the current maximum log storage size, run the following +command: + +.. code-block:: javascript + + config.get("logRetentionGB") + +Steps +----- + +To modify maximum log storage size, set the ``logRetentionGB`` +configuration option. You can set configuration options in the +:ref:`configuration API ` or a +:ref:`configuration file `. + +Modify Maximum Log Storage Size with the API +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following command uses the config API to set the maximum log storage +size to 3.5 GB: + +.. io-code-block:: + :copyable: true + + .. input:: + :language: javascript + + config.set("logRetentionGB", 3.5) + + .. output:: + :language: javascript + + Setting "logRetentionGB" has been changed + +Modify Maximum Log Storage Size with a Configuration File +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following configuration file sets the maximum log storage size to +3.5 GB: + +.. code-block:: yaml + + mongosh: + logRetentionGB: 3.5 + +Disable Maximum Log Storage Size +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To instruct |mdb-shell| to not delete logs based on storage size, set +``logRetentionGB`` to ``Infinity``. You can perform this action +through the config API or configuration file. + +.. include:: /includes/specify-one-retention-criterion.rst From c8960b4a8d2714c8669d7f949fb1c62f1a1af0ae Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Fri, 28 Feb 2025 12:29:42 -0500 Subject: [PATCH 13/18] add setting to table --- source/includes/list-table-shell-properties.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/includes/list-table-shell-properties.rst b/source/includes/list-table-shell-properties.rst index 528692c0..7cdc5375 100644 --- a/source/includes/list-table-shell-properties.rst +++ b/source/includes/list-table-shell-properties.rst @@ -73,6 +73,18 @@ specify at least one log retention criterion. See :ref:`mongosh-logs-retention`. + * - ``logRetentionGB`` + - float or Infinity + - Unset + - Maximum amount of space in gigabytes used for |mdb-shell| logs. + If the combined size of |mdb-shell| logs exceeds this value, log + files are deleted starting with the oldest logs. + + If this value is set to ``Infinity``, log files are not deleted + based on storage size. To prevent log storage from growing too + large, always specify at least one log retention criterion. See + :ref:`mongosh-logs-retention`. + * - ``redactHistory`` - string - ``remove`` From 39c19fce76dbfcb954bdd0d728a62197555602fa Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Mon, 3 Mar 2025 10:04:33 -0500 Subject: [PATCH 14/18] wording --- source/logs/retention.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/logs/retention.txt b/source/logs/retention.txt index 21eaea7f..5bfa8d20 100644 --- a/source/logs/retention.txt +++ b/source/logs/retention.txt @@ -12,7 +12,7 @@ Log Retention You can customize how |mdb-shell| logs are retained. By default, the system retains 100 log files for 30 days. You can choose to retain logs -based on a combination of time, file size, and number of log files. +based on a combination of time, storage size, and number of log files. Get Started ----------- From 42e287d3cc2b18624c9fd09360aca61f67b0da06 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Mon, 3 Mar 2025 10:20:54 -0500 Subject: [PATCH 15/18] fix conflict --- source/logs/retention/duration.txt | 3 --- 1 file changed, 3 deletions(-) diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index 6626fff2..c1cb112b 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -4,15 +4,12 @@ Modify Log Retention Duration ============================= -<<<<<<< HEAD .. contents:: On this page :local: :backlinks: none :depth: 1 :class: singlecol -======= ->>>>>>> refs/remotes/upstream/master You can modify how long |mdb-shell| log files are retained. A log cleanup process automatically deletes log files older than the specified retention period. By default, log files are retained for 30 days. From d60cfa2698a9c447e3063b37dee78d2fc492b8c0 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Mon, 3 Mar 2025 11:28:28 -0500 Subject: [PATCH 16/18] edit --- source/logs/retention/duration.txt | 6 +++++- source/logs/retention/size.txt | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/source/logs/retention/duration.txt b/source/logs/retention/duration.txt index c1cb112b..76679f5a 100644 --- a/source/logs/retention/duration.txt +++ b/source/logs/retention/duration.txt @@ -70,6 +70,10 @@ Disable Duration-Based Log Cleanup To instruct |mdb-shell| to not delete logs based on file age, set ``logRetentionDays`` to ``Infinity``. You can perform this action -through the config API or configuration file. +through the config API or configuration file. For example: + +.. code-block:: javascript + + config.set("logRetentionDays", Infinity) .. include:: /includes/specify-one-retention-criterion.rst diff --git a/source/logs/retention/size.txt b/source/logs/retention/size.txt index 3977a5b7..7b718c74 100644 --- a/source/logs/retention/size.txt +++ b/source/logs/retention/size.txt @@ -88,4 +88,8 @@ To instruct |mdb-shell| to not delete logs based on storage size, set ``logRetentionGB`` to ``Infinity``. You can perform this action through the config API or configuration file. +.. code-block:: javascript + + config.set("logRetentionGB", Infinity) + .. include:: /includes/specify-one-retention-criterion.rst From 33375925ae647cc04b64e0ba0be492675a15c2ee Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Mon, 3 Mar 2025 11:34:24 -0500 Subject: [PATCH 17/18] add text --- source/logs/retention/size.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/logs/retention/size.txt b/source/logs/retention/size.txt index 7b718c74..b6905c83 100644 --- a/source/logs/retention/size.txt +++ b/source/logs/retention/size.txt @@ -85,8 +85,8 @@ Disable Maximum Log Storage Size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To instruct |mdb-shell| to not delete logs based on storage size, set -``logRetentionGB`` to ``Infinity``. You can perform this action -through the config API or configuration file. +``logRetentionGB`` to ``Infinity``. You can perform this action through +the config API or configuration file. For example: .. code-block:: javascript From b1e3144d9049365de9a6f1da89ed73873ea6b90a Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 5 Mar 2025 13:08:37 -0500 Subject: [PATCH 18/18] wording --- source/logs/retention/size.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/logs/retention/size.txt b/source/logs/retention/size.txt index b6905c83..b46185ef 100644 --- a/source/logs/retention/size.txt +++ b/source/logs/retention/size.txt @@ -27,7 +27,7 @@ value (including less than ``1``). To check the current storage size of log files, check the size of the log folder. To see the current log folder, run the following command -from |mdb-shell|: +from the |mdb-shell|: .. code-block:: javascript @@ -84,9 +84,9 @@ The following configuration file sets the maximum log storage size to Disable Maximum Log Storage Size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To instruct |mdb-shell| to not delete logs based on storage size, set -``logRetentionGB`` to ``Infinity``. You can perform this action through -the config API or configuration file. For example: +To instruct the |mdb-shell| to not delete logs based on storage size, +set ``logRetentionGB`` to ``Infinity``. You can perform this action +through the config API or configuration file. For example: .. code-block:: javascript