From d2a3ecff5226edc89eeb99d715824f780e53dff7 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 20 Nov 2024 16:02:27 -0500 Subject: [PATCH 01/11] WIP --- source/settings.txt | 2 +- source/settings/command-line-options.txt | 2 + source/settings/config-file.txt | 2 + source/settings/settings-reference.txt | 2 + source/settings/telemetry.txt | 49 ++++++++++++++++++++++++ 5 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 source/settings/telemetry.txt diff --git a/source/settings.txt b/source/settings.txt index cf438906f..a687cd848 100644 --- a/source/settings.txt +++ b/source/settings.txt @@ -72,4 +72,4 @@ Learn more Block Write Operations Specify Read Preference & Tags Toggle Chrome DevTools - + Configure Telemetry diff --git a/source/settings/command-line-options.txt b/source/settings/command-line-options.txt index 470fb1e2f..38e7d6fb7 100644 --- a/source/settings/command-line-options.txt +++ b/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 diff --git a/source/settings/config-file.txt b/source/settings/config-file.txt index 303a99fbd..c8f18f490 100644 --- a/source/settings/config-file.txt +++ b/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 diff --git a/source/settings/settings-reference.txt b/source/settings/settings-reference.txt index 3df79d886..d4f3b782c 100644 --- a/source/settings/settings-reference.txt +++ b/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 diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt new file mode 100644 index 000000000..45f2ebf67 --- /dev/null +++ b/source/settings/telemetry.txt @@ -0,0 +1,49 @@ +.. _compass-telemetry: + +=========================== +Configure Telemetry Options +=========================== + +.. default-domain:: mongodb + +.. 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 at any time. + +What Kind of Data |compass-short| Tracks +---------------------------------------- + +|compass-short| tracks the following data: + +- The type of MongoDB deployment |compass-short| is connected to. For + example, Enterprise Edition, Community Edition, or Atlas Data Lake. + +- User actions performed in |compass-short|, such as creating + collections and indexes. |compass-short| 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 +`__. + +Toggle Telemetry Collection +--------------------------- + +To modify whether |compass-short| collections telemetry data, From 53fdcd52d1511f0e7d772dc1c44e227214caf488 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Wed, 20 Nov 2024 16:50:22 -0500 Subject: [PATCH 02/11] DOCSP-19979-compass-telemetry-options --- .../settings/protect-connection-strings.txt | 32 ++++--- source/settings/telemetry.txt | 91 ++++++++++++++++++- 2 files changed, 104 insertions(+), 19 deletions(-) diff --git a/source/settings/protect-connection-strings.txt b/source/settings/protect-connection-strings.txt index a611abf3d..a6e735f52 100644 --- a/source/settings/protect-connection-strings.txt +++ b/source/settings/protect-connection-strings.txt @@ -49,30 +49,34 @@ You can set the ``protectConnectionStrings`` option in either: .. procedure:: :style: normal - .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. + .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass` .. figure:: /images/compass/settings-panel-location.png :scale: 40% :alt: Settings panel location under the MongoDB Compass system menu - - Alternatively, you can use keyboard shortcuts to open the - :guilabel:`Settings` panel: - - - Windows / Linux: ``Ctrl`` + ``,`` - - - Mac: ``⌘`` + ``,`` - .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`. + .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings` - |compass-short| opens a dialog box where you can configure your |compass| - settings. + |compass-short| opens a dialog box where you can configure your + |compass| settings. - .. step:: Toggle :guilabel:`Protect Connection String Secrets`. + .. tip:: + + Alternatively, you can use keyboard shortcuts to open the + :guilabel:`Settings` panel: + + - Windows / Linux: ``Ctrl`` + ``,`` + + - Mac: ``⌘`` + ``,`` + + .. step:: In the :guilabel:`Settings`` window, select :guilabel:`Privacy` + + .. step:: Toggle :guilabel:`Enable Usage Statistics`. .. step:: Click :guilabel:`Save`. -Command Line Example -~~~~~~~~~~~~~~~~~~~~ +Command Line +~~~~~~~~~~~~ The following command starts |compass-short| from the command line and sets the ``--protectConnectionStrings`` option: diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 45f2ebf67..c8b9ba33e 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -16,8 +16,8 @@ Configure Telemetry Options MongoDB products. |compass-short| collects this information by default, but you can disable this data collection at any time. -What Kind of Data |compass-short| Tracks ----------------------------------------- +About this Task +--------------- |compass-short| tracks the following data: @@ -43,7 +43,88 @@ What Kind of Data |compass-short| Tracks For more information, see `MongoDB's Privacy Policy `__. -Toggle Telemetry Collection ---------------------------- +.. tip:: -To modify whether |compass-short| collections telemetry data, + |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 panel ` + +- A :ref:`command line option ` + +- A :ref:`configuration file ` + +|compass-short| Settings Panel +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. procedure:: + :style: normal + + .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass` + + .. figure:: /images/compass/settings-panel-location.png + :scale: 40% + :alt: Settings panel location under the MongoDB Compass system menu + + .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings` + + |compass-short| opens a dialog box where you can configure your + |compass| settings. + + .. tip:: + + Alternatively, you can use keyboard shortcuts to open the + :guilabel:`Settings` panel: + + - Windows / Linux: ``Ctrl`` + ``,`` + + - Mac: ``⌘`` + ``,`` + + .. step:: In the :guilabel:`Settings`` window, select :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 + + --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 + From 9295ae89fcc0072fe439ed860eb75e594d114c3d Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 09:45:41 -0500 Subject: [PATCH 03/11] edits --- source/settings/telemetry.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index c8b9ba33e..e2ea59c82 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -72,10 +72,10 @@ You can toggle telemetry in either: :scale: 40% :alt: Settings panel location under the MongoDB Compass system menu - .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings` + .. step:: Click :guilabel:`Settings` - |compass-short| opens a dialog box where you can configure your - |compass| settings. + |compass-short| opens a window where you can configure your + settings. .. tip:: @@ -86,11 +86,11 @@ You can toggle telemetry in either: - Mac: ``⌘`` + ``,`` - .. step:: In the :guilabel:`Settings`` window, select :guilabel:`Privacy` + .. step:: In the :guilabel:`Settings` window, click :guilabel:`Privacy` - .. step:: Toggle :guilabel:`Enable Usage Statistics`. + .. step:: Toggle :guilabel:`Enable Usage Statistics` - .. step:: Click :guilabel:`Save`. + .. step:: Click :guilabel:`Save` Command Line ~~~~~~~~~~~~ From 8135a8b663eb717b73afec6c042f711194b2afaf Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 09:45:57 -0500 Subject: [PATCH 04/11] undo protect connection string changes --- .../settings/protect-connection-strings.txt | 32 ++++++++----------- 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/source/settings/protect-connection-strings.txt b/source/settings/protect-connection-strings.txt index a6e735f52..a611abf3d 100644 --- a/source/settings/protect-connection-strings.txt +++ b/source/settings/protect-connection-strings.txt @@ -49,34 +49,30 @@ You can set the ``protectConnectionStrings`` option in either: .. procedure:: :style: normal - .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass` + .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`. .. figure:: /images/compass/settings-panel-location.png :scale: 40% :alt: Settings panel location under the MongoDB Compass system menu + + Alternatively, you can use keyboard shortcuts to open the + :guilabel:`Settings` panel: + + - Windows / Linux: ``Ctrl`` + ``,`` + + - Mac: ``⌘`` + ``,`` - .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings` + .. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`. - |compass-short| opens a dialog box where you can configure your - |compass| settings. + |compass-short| opens a dialog box where you can configure your |compass| + settings. - .. tip:: - - Alternatively, you can use keyboard shortcuts to open the - :guilabel:`Settings` panel: - - - Windows / Linux: ``Ctrl`` + ``,`` - - - Mac: ``⌘`` + ``,`` - - .. step:: In the :guilabel:`Settings`` window, select :guilabel:`Privacy` - - .. step:: Toggle :guilabel:`Enable Usage Statistics`. + .. step:: Toggle :guilabel:`Protect Connection String Secrets`. .. step:: Click :guilabel:`Save`. -Command Line -~~~~~~~~~~~~ +Command Line Example +~~~~~~~~~~~~~~~~~~~~ The following command starts |compass-short| from the command line and sets the ``--protectConnectionStrings`` option: From d12efd1a23cd3a70116b7a01223c3db095cf1813 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 09:47:06 -0500 Subject: [PATCH 05/11] edits --- source/settings/telemetry.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index e2ea59c82..87c33ec07 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -4,7 +4,9 @@ Configure Telemetry Options =========================== -.. default-domain:: mongodb +.. facet:: + :name: genre + :values: tutorial .. contents:: On this page :local: @@ -14,7 +16,7 @@ Configure Telemetry Options |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 at any time. +but you can disable this data collection. About this Task --------------- From 1082a5c318c784254136f20604fd80f1d4ac1846 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 09:57:37 -0500 Subject: [PATCH 06/11] reformat steps --- source/settings/telemetry.txt | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 87c33ec07..da69b1de9 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -58,26 +58,25 @@ You can toggle telemetry in either: - The |compass-short| :ref:`Settings panel ` -- A :ref:`command line option ` +- :ref:`Command line options ` -- A :ref:`configuration file ` +- :ref:`Configuration file options ` -|compass-short| Settings Panel -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Settings Panel +~~~~~~~~~~~~~~ .. procedure:: :style: normal - .. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass` - - .. figure:: /images/compass/settings-panel-location.png - :scale: 40% - :alt: Settings panel location under the MongoDB Compass system menu - - .. step:: Click :guilabel:`Settings` - - |compass-short| opens a window where you can configure your - settings. + .. 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 panel location under the MongoDB Compass system menu .. tip:: From 4de966fd4c9b08bc5d0f72c1987b1ae56c11c310 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 10:30:39 -0500 Subject: [PATCH 07/11] spacing --- source/settings/telemetry.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index da69b1de9..2ccfb5240 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -128,4 +128,3 @@ YAML .. code-block:: yaml trackUsageStatistics: false - From dc86e3c81e2356dc3b1760618b00fdb5ee62640c Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 10:32:12 -0500 Subject: [PATCH 08/11] edit --- source/settings/telemetry.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 2ccfb5240..7da6b6862 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -65,6 +65,8 @@ You can toggle telemetry in either: Settings Panel ~~~~~~~~~~~~~~ +To disable telemetry from the |compass-short| settings: + .. procedure:: :style: normal From 50789f4a6a90610072558b538584e4cb71f3dd85 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 10:35:41 -0500 Subject: [PATCH 09/11] wording --- source/settings/telemetry.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 7da6b6862..63c44affa 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -65,7 +65,7 @@ You can toggle telemetry in either: Settings Panel ~~~~~~~~~~~~~~ -To disable telemetry from the |compass-short| settings: +To toggle telemetry from the |compass-short| settings: .. procedure:: :style: normal From 9357a6bbd56720f05f0596c5b53a84383b80f21b Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 12:25:34 -0500 Subject: [PATCH 10/11] review feedback --- source/settings/telemetry.txt | 42 ++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 63c44affa..19d0cb2f6 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -21,26 +21,27 @@ but you can disable this data collection. About this Task --------------- -|compass-short| tracks the following data: +|compass-short| telemetry tracks the following data: -- The type of MongoDB deployment |compass-short| is connected to. For - example, Enterprise Edition, Community Edition, or Atlas Data Lake. +- The type of MongoDB deployment that you connect |compass-short| to. + For example, Enterprise Edition, Community Edition, or Atlas Data + Lake. -- User actions performed in |compass-short|, such as creating - collections and indexes. |compass-short| only tracks the general - action performed, and does not track field values or namespaces. +- 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. +- IP addresses, hostnames, usernames, or credentials -- Queries run in |compass-short|. +- Queries run in |compass-short| -- Data stored in your MongoDB deployment. +- Data stored in your MongoDB deployment -- Personal identifiable information. +- Personal identifiable information For more information, see `MongoDB's Privacy Policy `__. @@ -56,21 +57,22 @@ Steps You can toggle telemetry in either: -- The |compass-short| :ref:`Settings panel ` +- The |compass-short| :ref:`Settings window + ` - :ref:`Command line options ` - :ref:`Configuration file options ` -Settings Panel -~~~~~~~~~~~~~~ +Settings Window +~~~~~~~~~~~~~~~ To toggle telemetry from the |compass-short| settings: .. procedure:: :style: normal - .. step:: Open the Settings window + .. step:: Open the Settings window. a. In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass` @@ -78,22 +80,22 @@ To toggle telemetry from the |compass-short| settings: .. figure:: /images/compass/settings-panel-location.png :scale: 40% - :alt: Settings panel location under the MongoDB Compass system menu + :alt: Settings window location under the MongoDB Compass system menu .. tip:: - Alternatively, you can use keyboard shortcuts to open the - :guilabel:`Settings` panel: + Alternatively, you can use keyboard shortcuts to open the + :guilabel:`Settings` window: - Windows / Linux: ``Ctrl`` + ``,`` - Mac: ``⌘`` + ``,`` - .. step:: In the :guilabel:`Settings` window, click :guilabel:`Privacy` + .. step:: In the left pane of the :guilabel:`Settings` window, click :guilabel:`Privacy`. - .. step:: Toggle :guilabel:`Enable Usage Statistics` + .. step:: Toggle :guilabel:`Enable Usage Statistics`. - .. step:: Click :guilabel:`Save` + .. step:: Click :guilabel:`Save`. Command Line ~~~~~~~~~~~~ From 4970a46dbd7c3df71c2f5b93a966077125373d70 Mon Sep 17 00:00:00 2001 From: jeff-allen-mongo Date: Thu, 21 Nov 2024 17:29:27 -0500 Subject: [PATCH 11/11] review feedback --- source/settings/telemetry.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/source/settings/telemetry.txt b/source/settings/telemetry.txt index 19d0cb2f6..364169429 100644 --- a/source/settings/telemetry.txt +++ b/source/settings/telemetry.txt @@ -27,17 +27,20 @@ About this Task For example, Enterprise Edition, Community Edition, or Atlas Data Lake. +- Hostnames of the deployments that you connect |compass-short| to. + - 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. +- Anonymized queries run in |compass-short|. These queries are stored + such that they cannot be associated to individual users. + - Errors. |compass-short| *does not* track: -- IP addresses, hostnames, usernames, or credentials - -- Queries run in |compass-short| +- IP addresses, usernames, or credentials - Data stored in your MongoDB deployment