DOCSP-47888-custom-log-location (#379)

* DOCSP-47888-custom-log-location

* WIP

* first draft

* wording

* wording

* add on this page

* wording

* use iocodeblock

* retry build

* test staging

* remove TEST

* add link

* use tip

* remove test

* add info for log file prefixes

Author: jeff-allen-mongo

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

@@ -53,6 +53,12 @@
        to ``Infinity`` (the javascript object) prints all nested
        objects to their full depth. 
 
+   * - ``logLocation``
+     - string
+     - Depends on your operating system. See :ref:`mdb-shell-view-logs`.
+     - Directory where MongoDB Shell writes log files. Specify an
+       absolute filepath. See :ref:`mongosh-log-location`.
+
    * - ``redactHistory``
      - string
      - ``remove``

source/logs.txt

@@ -30,6 +30,11 @@ View |mdb-shell| Logs
 
 .. include:: /includes/steps/view-logs.rst
 
+.. tip::
+  
+   To change where MongoDB Shell writes logs, see
+   :ref:`mongosh-log-location`.
+
 .. _mdb-shell-command-history:
 
 View |mdb-shell| Command History
@@ -64,4 +69,5 @@ automatically deletes log files older than 30 days.
 .. toctree::
    :titlesonly:
 
+   Specify Log Location <logs/location> 
    Write Custom Log Entries <logs/custom-entries> 

source/logs/location.txt

@@ -0,0 +1,93 @@
+.. _mongosh-log-location:
+
+=========================
+Specify Log File Location
+=========================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+You can specify where MongoDB Shell writes log files. By default,
+MongoDB Shell saves the log for each session to your user's
+``.mongodb/mongosh`` directory, which depends on your operating system:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Operating System
+     - Default Log Location
+   * - macOS and Linux
+     - ``~/.mongodb/mongosh/<LogID>_log``
+   * - Windows
+     - ``%UserProfile%/AppData/Local/mongodb/mongosh/<LogID>_log``
+
+About this Task
+---------------
+
+To view the current log file location, use the :ref:`config API
+<configure-settings-api>` to return the ``logLocation`` value:
+
+.. code-block:: javascript
+
+   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.
+
+Log File Names
+~~~~~~~~~~~~~~
+
+If you modify the default log file location, log files have a
+``mongosh_`` prefix before the session ID. For example, the log for
+session ID ``67be0c0eb6227e211a1979e8`` is saved as
+``mongosh_67be0c0eb6227e211a1979e8_log``.
+
+If you use the default log file location, the file name does not include
+the ``mongosh_`` prefix. For example, the log for session ID
+``67be0c0eb6227e211a1979e8`` is saved as
+``67be0c0eb6227e211a1979e8_log``.
+
+Steps
+-----
+
+To change the log file location, modify the ``logLocation``
+configuration option. You can modify configuration options with the
+configuration API or a configuration file.
+
+.. important::
+
+   Specify ``logLocation`` as an absolute filepath.
+
+Modify Log Location with the API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following command uses the config API to set the ``logLocation``
+setting to ``/path/to/log/directory``:
+
+.. io-code-block::
+   :copyable: true
+
+   .. input::
+      :language: javascript
+
+      config.set("logLocation", "/path/to/log/directory")
+
+   .. output::
+      :language: javascript
+
+      Setting "logLocation" has been changed
+
+Modify Log Location with a Configuration File
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following :ref:`configuration file <configure-settings-global>` sets
+the ``logLocation`` setting to ``/path/to/log/directory``:
+
+.. code-block:: yaml
+
+   mongosh:
+     logLocation: "/path/to/log/directory"