Skip to content

Commit 53fdcd5

Browse files
DOCSP-19979-compass-telemetry-options
1 parent d2a3ecf commit 53fdcd5

File tree

2 files changed

+104
-19
lines changed

2 files changed

+104
-19
lines changed

source/settings/protect-connection-strings.txt

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -49,30 +49,34 @@ You can set the ``protectConnectionStrings`` option in either:
4949
.. procedure::
5050
:style: normal
5151

52-
.. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`.
52+
.. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`
5353

5454
.. figure:: /images/compass/settings-panel-location.png
5555
:scale: 40%
5656
:alt: Settings panel location under the MongoDB Compass system menu
57-
58-
Alternatively, you can use keyboard shortcuts to open the
59-
:guilabel:`Settings` panel:
60-
61-
- Windows / Linux: ``Ctrl`` + ``,``
62-
63-
- Mac: ``⌘`` + ``,``
6457

65-
.. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`.
58+
.. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`
6659

67-
|compass-short| opens a dialog box where you can configure your |compass|
68-
settings.
60+
|compass-short| opens a dialog box where you can configure your
61+
|compass| settings.
6962

70-
.. step:: Toggle :guilabel:`Protect Connection String Secrets`.
63+
.. tip::
64+
65+
Alternatively, you can use keyboard shortcuts to open the
66+
:guilabel:`Settings` panel:
67+
68+
- Windows / Linux: ``Ctrl`` + ``,``
69+
70+
- Mac: ``⌘`` + ``,``
71+
72+
.. step:: In the :guilabel:`Settings`` window, select :guilabel:`Privacy`
73+
74+
.. step:: Toggle :guilabel:`Enable Usage Statistics`.
7175

7276
.. step:: Click :guilabel:`Save`.
7377

74-
Command Line Example
75-
~~~~~~~~~~~~~~~~~~~~
78+
Command Line
79+
~~~~~~~~~~~~
7680

7781
The following command starts |compass-short| from the command line and sets
7882
the ``--protectConnectionStrings`` option:

source/settings/telemetry.txt

Lines changed: 86 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Configure Telemetry Options
1616
MongoDB products. |compass-short| collects this information by default,
1717
but you can disable this data collection at any time.
1818

19-
What Kind of Data |compass-short| Tracks
20-
----------------------------------------
19+
About this Task
20+
---------------
2121

2222
|compass-short| tracks the following data:
2323

@@ -43,7 +43,88 @@ What Kind of Data |compass-short| Tracks
4343
For more information, see `MongoDB's Privacy Policy
4444
<https://www.mongodb.com/legal/privacy-policy?tck=docs_mongosh>`__.
4545

46-
Toggle Telemetry Collection
47-
---------------------------
46+
.. tip::
4847

49-
To modify whether |compass-short| collections telemetry data,
48+
|compass-short| Isolated Edition automatically disables telemetry.
49+
For more information on different |compass-short| editions, see
50+
:ref:`compass-feature-table`.
51+
52+
Steps
53+
-----
54+
55+
You can toggle telemetry in either:
56+
57+
- The |compass-short| :ref:`Settings panel <compass-settings-reference>`
58+
59+
- A :ref:`command line option <cli-options>`
60+
61+
- A :ref:`configuration file <config-file>`
62+
63+
|compass-short| Settings Panel
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
65+
66+
.. procedure::
67+
:style: normal
68+
69+
.. step:: In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`
70+
71+
.. figure:: /images/compass/settings-panel-location.png
72+
:scale: 40%
73+
:alt: Settings panel location under the MongoDB Compass system menu
74+
75+
.. step:: In the :guilabel:`MongoDB Compass` menu, click :guilabel:`Settings`
76+
77+
|compass-short| opens a dialog box where you can configure your
78+
|compass| settings.
79+
80+
.. tip::
81+
82+
Alternatively, you can use keyboard shortcuts to open the
83+
:guilabel:`Settings` panel:
84+
85+
- Windows / Linux: ``Ctrl`` + ``,``
86+
87+
- Mac: ``⌘`` + ``,``
88+
89+
.. step:: In the :guilabel:`Settings`` window, select :guilabel:`Privacy`
90+
91+
.. step:: Toggle :guilabel:`Enable Usage Statistics`.
92+
93+
.. step:: Click :guilabel:`Save`.
94+
95+
Command Line
96+
~~~~~~~~~~~~
97+
98+
To disable telemetry from the command line, start |compass-short| with
99+
the ``--no-trackUsageStatistics`` option.
100+
101+
.. code-block:: sh
102+
103+
<path-to-Compass-executable> --no-trackUsageStatistics
104+
105+
.. note::
106+
107+
The name and filepath of the |compass-short| executable depend on your
108+
operating system. For more information, see
109+
:ref:`compass-executable-location`.
110+
111+
Configuration File
112+
~~~~~~~~~~~~~~~~~~
113+
114+
To disable telemetry from the |compass-short| configuration file, set
115+
``trackUsageStatistics`` to ``false``.
116+
117+
EJSON
118+
`````
119+
120+
.. code-block:: json
121+
122+
{ "trackUsageStatistics": false }
123+
124+
YAML
125+
````
126+
127+
.. code-block:: yaml
128+
129+
trackUsageStatistics: false
130+

0 commit comments

Comments
 (0)