(DOCSP-18928): Compass logs (#386)

* (DOCSP-18928): Compass logs

* formatting

* word tweak

* updates per copy review

Author: jeff-allen-mongo

source/faq.txt

@@ -51,6 +51,16 @@ data in the operating system's credentials API. For more information on
 how Keytar operates and the specific APIs it accesses, refer to the
 `Keytar Github documentation <https://github.com/atom/node-keytar>`_.
 
+.. _compass-faq-logs:
+
+Does Compass Maintain Logs?
+---------------------------
+
+As part of normal operation, |compass| maintains a running log of
+events. |compass-short| logs provide a history of operations and can
+help diagnose errors. For more information on |compass-short| logs,
+including their format and location, see :ref:`compass-logs`.
+
 .. _compass-faq-non-genuine:
 
 Why am I seeing a warning about a non-genuine MongoDB server?
@@ -143,4 +153,3 @@ selected, |compass| is allowed to make requests to a third-party
 mapping service.
 
 .. include:: /includes/fact-isolated-ver-third-party-mapping.rst
-

source/release-notes.txt

@@ -135,6 +135,9 @@ Bug Fixes:
 
 New Features:
 
+- Adds :ref:`client-side logging <compass-logs>` for |compass|
+  operations.
+
 - Improved |compass| startup time.
 
 - Adds support for `MongoDB 5.1 features

source/troubleshooting.txt

@@ -7,6 +7,9 @@ Troubleshooting
 This section provides advice for troubleshooting problems with
 |compass|.
 
+:doc:`/troubleshooting/logs`
+  Retrieve |compass| logs to diagnose errors.
+
 :doc:`Connection Errors </troubleshooting/connection-errors>`
   Resolve issues with connecting |compass| to the MongoDB server.
 
@@ -15,4 +18,6 @@ This section provides advice for troubleshooting problems with
 .. toctree::
    :titlesonly:
 
+   /troubleshooting/logs
    /troubleshooting/connection-errors
+   

source/troubleshooting/connection-errors.txt

@@ -10,6 +10,9 @@ Compass Connection Errors
    :depth: 1
    :class: singlecol
 
+The sections on this page list common errors seen when connecting to
+|compass| and provide possible solutions.
+
 MongoDB Not Running on the Provided Host and Port
 -------------------------------------------------
 
@@ -334,6 +337,13 @@ Solutions
 - Verify that your selected authentication mechanism is supported by
   your MongoDB database.
 
+Check the Compass Logs
+----------------------
+
+The |compass-short| logs can provide additional information on
+connection errors. You may find more detailed error messages to help
+diagnose your issue. For more information, see :ref:`compass-logs`.
+
 Additional Resources
 --------------------
 

source/troubleshooting/logs.txt

@@ -0,0 +1,84 @@
+.. _compass-logs:
+
+=====================
+Retrieve Compass Logs
+=====================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+As part of normal operation, |compass| maintains a running log of
+events. |compass-short| logs provide a history of operations and can
+help diagnose errors.
+
+.. note::
+
+   |compass| redacts credentials from the logs.
+
+View Compass Logs
+-----------------
+
+.. procedure::
+   :style: normal
+
+   .. step:: In the |compass-short| top menu bar, click :guilabel:`Help`.
+
+   .. step:: In the :guilabel:`Help` menu, click :guilabel:`Open Log File`.
+
+      |compass-short| opens a dialog containing the location of your log file.
+
+   .. step:: Choose how to open the log file.
+
+      You can either:
+
+      - Copy the path to the log file to your clipboard.
+
+      - Open the folder containing your log file.
+
+      - Extract the log file and view it as a text file.
+
+Compass Log Location
+--------------------
+
+|compass-short| maintains one log file per session, compressed into a
+gzip archive file. The corresponding session ID is included in the log
+file name.
+
+The directory where |compass-short| writes logs depends on your
+operating system.
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 10 20
+
+   * - Operating System
+     - Directory
+   * - macOS
+     - ``~/.mongodb/compass/<LogID>_log.gz``
+   * - Linux
+     - ``~/.mongodb/compass/<LogID>_log.gz``
+   * - Windows
+     - ``%UserProfile%/AppData/Local/mongodb/compass/<LogID>_log.gz``
+
+Log File Format
+---------------
+
+|compass-short| outputs log messages in structured JSON format. The
+messages are written in the same format used for MongoDB server logs.
+
+.. seealso::
+
+   To learn more about MongoDB logs and see examples, see
+   :ref:`log-messages-ref`.
+
+Log Retention
+-------------
+
+|compass-short| retains log files for 30 days. Log files older than 30
+days are automatically deleted.