(DOCSP-10364): Document mongosh logging (#18)

* (DOCSP-10364): mongosh logging

* (DOCSP-10364): try to fix some tabs

* (DOCSP-10364): try to fix other tabs

* (DOCSP-10364): formatting fixes

* (DOCSP-10364): copy review feedback

* (DOCSP-10364): tech review feedback

Author: jwilliams-mongo

source/includes/steps-view-logs.yaml

@@ -0,0 +1,96 @@
+---
+title: "Find your Session ID."
+level: 4
+ref: session-id
+content: |
+
+  .. example::
+
+     |mdb-shell| displays the session ID each time you open the shell.
+
+     .. code-block:: javascript
+        :copyable: false
+        :emphasize-lines: 3
+
+        $ mongosh
+
+        Current sessionID: c2961dbd6b73b052671d9df0
+        Connecting to: mongodb://127.0.0.1:27017
+        Using MongoDB: 4.2.8
+        Using Mongosh Beta: 0.0.6
+
+---
+title: "View the log for the session."
+level: 4
+ref: view-session-log
+content: |
+
+  |mdb-shell| saves the log for each session to your user's
+  ``.mongodb/mongosh`` directory:
+
+  .. tabs::
+
+     .. tab::
+        :tabid: macOS and Linux
+
+        .. code-block:: sh
+
+           ~/.mongodb/mongosh/<sessionId>_log
+
+        Run the following command to view the log for a session:
+
+        .. code-block:: sh
+
+           cat ~/.mongodb/mongosh/<sessionId>_log
+
+        Run the following command to tail the log for a session:
+
+        .. code-block:: sh
+
+           tail -f ~/.mongodb/mongosh/<sessionId>_log
+
+        .. tip::
+
+           You can pipe the output to an installed ``ndjson`` pretty
+           printer, such as `pino-colada
+           <https://www.npmjs.com/package/pino-colada>`__ 
+           or `pino-pretty <https://www.npmjs.com/package/pino-pretty>`__
+           to improve readability:
+
+           .. code-block:: sh
+
+              tail -f ~/.mongodb/mongosh/<sessionId>_log | pino-colada
+
+     .. tab::
+        :tabid: windows
+
+        .. code-block:: sh
+
+           %UserProfile%/.mongodb/mongosh/<sessionId>_log
+
+        Run the following PowerShell command to view the log for a session:
+
+        .. code-block:: sh
+
+           Get-Content %UserProfile%/.mongodb/mongosh/<sessionId>_log
+
+        Run the following PowerShell command to tail the log for a
+        session:
+
+        .. code-block:: sh
+
+           Get-Content %UserProfile%/.mongodb/mongosh/<sessionId>_log -Wait
+
+        .. tip::
+
+           You can pipe the output to an installed ``ndjson`` pretty
+           printer, such as `pino-colada
+           <https://www.npmjs.com/package/pino-colada>`__ 
+           or `pino-pretty <https://www.npmjs.com/package/pino-pretty>`__
+           to improve readability:
+
+           .. code-block:: sh
+
+              Get-Content %UserProfile%/.mongodb/mongosh/<sessionId>_log -Wait | pino-colada
+
+...

source/index.txt

@@ -114,4 +114,5 @@ Learn More
       /connect
       /crud
       /run-agg-pipelines
+      /logs
       /reference

source/logs.txt

@@ -0,0 +1,50 @@
+.. _mdb-shell-logs:
+
+===========================
+Retrieve MongoDB Shell Logs
+===========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. include:: /includes/admonitions/fact-mdb-shell-beta.rst
+
+|mdb-shell| stores logs for each session in `ndjson
+<http://ndjson.org/>`__ format using `pino
+<https://github.com/pinojs/pino>`__. 
+
+You can view or tail the logs for a |mdb-shell| session based on its
+session ID. 
+
+View |mdb-shell| Logs
+---------------------
+
+.. include:: /includes/steps/view-logs.rst
+
+View |mdb-shell| Command History
+--------------------------------
+
+|mdb-shell| saves a history of all commands you've run across sessions.
+When a new command is issued, it is added to the beginning of the
+history file.
+
+Open the following file in a text editor to view the |mdb-shell| command
+history:
+
+.. list-table::
+   :header-rows: 1
+   :widths: 1 2
+
+   * - Operating System
+     - Path to History File
+
+   * - macOS and Linux
+     - ``~/.mongodb/mongosh/.mongosh_repl_history``
+
+   * - Windows
+     - ``%UserProfile%/.mongodb/mongosh/.mongosh_repl_history``