DOCSP-19979-compass-telemetry-options

source/settings.txt

@@ -72,4 +72,4 @@ Learn more
    Block Write Operations </settings/read-only>
    Specify Read Preference & Tags </settings/specify-read-preference-tags>
    Toggle Chrome DevTools </settings/enable-dev-tools>
-
+   Configure Telemetry </settings/telemetry>

source/settings/command-line-options.txt

@@ -213,6 +213,8 @@ value in the :guilabel:`Settings` panel.
      - Enable sending usage statistics. Use ``--no-trackUsageStatistics``
        to disable sending usage statistics.
 
+       To learn more, see :ref:`compass-telemetry`.
+
    * - .. option:: --username
      - Specifies a username for authentication to Compass and the MongoDB 
        deployment provided in the connection string 

source/settings/config-file.txt

@@ -137,6 +137,8 @@ Settings
    * - trackUsageStatistics
      - Allow |compass-short| to send anonymous usage statistics.
 
+       To learn more, see :ref:`compass-telemetry`.
+
 .. include:: /includes/fact-configuration-options-executable.rst
 
 Example 

source/settings/settings-reference.txt

@@ -142,6 +142,8 @@ You can configure the following settings on the |compass| interface:
      - Privacy
      - Allow |compass-short| to send anonymous usage statistics.
 
+       To learn more, see :ref:`compass-telemetry`.
+
    * - Give Product Feedback 
      - Privacy
      - Allow our Product team to occasionally reach out for feedback about 

source/settings/telemetry.txt

@@ -0,0 +1,134 @@
+.. _compass-telemetry:
+
+===========================
+Configure Telemetry Options
+===========================
+
+.. facet::
+   :name: genre
+   :values: tutorial
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+|compass-short| collects anonymous aggregated usage data to improve
+MongoDB products. |compass-short| collects this information by default,
+but you can disable this data collection.
+
+About this Task
+---------------
+
+|compass-short| telemetry tracks the following data:
+
+- The type of MongoDB deployment that you connect |compass-short| to.
+  For example, Enterprise Edition, Community Edition, or Atlas Data
+  Lake.
+
+- Actions that you perform in |compass-short|, such as creating
+  collections and indexes. Telemetry only tracks the general action
+  performed, and does not track field values or namespaces.
+
+- Errors.
+
+|compass-short| *does not* track:
+
+- IP addresses, hostnames, usernames, or credentials
+
+- Queries run in |compass-short|
+
+- Data stored in your MongoDB deployment
+
+- Personal identifiable information
+
+For more information, see `MongoDB's Privacy Policy
+<https://www.mongodb.com/legal/privacy-policy?tck=docs_mongosh>`__.
+
+.. tip::
+
+   |compass-short| Isolated Edition automatically disables telemetry.
+   For more information on different |compass-short| editions, see
+   :ref:`compass-feature-table`.
+
+Steps
+-----
+
+You can toggle telemetry in either: 
+
+- The |compass-short| :ref:`Settings window
+  <compass-settings-reference>`
+
+- :ref:`Command line options <cli-options>`
+
+- :ref:`Configuration file options <config-file>`
+
+Settings Window
+~~~~~~~~~~~~~~~
+
+To toggle telemetry from the |compass-short| settings:
+
+.. procedure:: 
+   :style: normal
+
+   .. step:: Open the Settings window.
+
+      a. In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`
+
+      b. Click :guilabel:`Settings`
+
+         .. figure:: /images/compass/settings-panel-location.png
+            :scale: 40% 
+            :alt: Settings window location under the MongoDB Compass system menu
+
+      .. tip::
+
+         Alternatively, you can use keyboard shortcuts to open the
+         :guilabel:`Settings` window: 
+
+         - Windows / Linux: ``Ctrl`` + ``,``
+
+         - Mac: ``⌘`` + ``,``
+
+   .. step:: In the left pane of the :guilabel:`Settings` window, click :guilabel:`Privacy`.
+
+   .. step:: Toggle :guilabel:`Enable Usage Statistics`.
+
+   .. step:: Click :guilabel:`Save`.
+
+Command Line
+~~~~~~~~~~~~
+
+To disable telemetry from the command line, start |compass-short| with
+the ``--no-trackUsageStatistics`` option.
+
+.. code-block:: sh
+
+   <path-to-Compass-executable> --no-trackUsageStatistics
+
+.. note::
+
+  The name and filepath of the |compass-short| executable depend on your
+  operating system. For more information, see
+  :ref:`compass-executable-location`.
+
+Configuration File
+~~~~~~~~~~~~~~~~~~
+
+To disable telemetry from the |compass-short| configuration file, set
+``trackUsageStatistics`` to ``false``.
+
+EJSON
+`````
+
+.. code-block:: json
+
+   { "trackUsageStatistics": false }
+
+YAML
+````
+
+.. code-block:: yaml
+
+   trackUsageStatistics: false