Skip to content

Commit cf8fe0a

Browse files
jeff-allen-mongojeff-allen-mongo
authored
DOCSP-19979-compass-telemetry-options (#697)
* WIP * DOCSP-19979-compass-telemetry-options * edits * undo protect connection string changes * edits * reformat steps * spacing * edit * wording * review feedback * review feedback
1 parent 451b9d1 commit cf8fe0a

File tree

5 files changed

+144
-1
lines changed

5 files changed

+144
-1
lines changed

‎source/settings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ Learn more
7272
Block Write Operations </settings/read-only>
7373
Specify Read Preference & Tags </settings/specify-read-preference-tags>
7474
Toggle Chrome DevTools </settings/enable-dev-tools>
75-
75+
Configure Telemetry </settings/telemetry>

‎source/settings/command-line-options.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ value in the :guilabel:`Settings` panel.
213213
- Enable sending usage statistics. Use ``--no-trackUsageStatistics``
214214
to disable sending usage statistics.
215215

216+
To learn more, see :ref:`compass-telemetry`.
217+
216218
* - .. option:: --username
217219
- Specifies a username for authentication to Compass and the MongoDB
218220
deployment provided in the connection string

‎source/settings/config-file.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ Settings
137137
* - trackUsageStatistics
138138
- Allow |compass-short| to send anonymous usage statistics.
139139

140+
To learn more, see :ref:`compass-telemetry`.
141+
140142
.. include:: /includes/fact-configuration-options-executable.rst
141143

142144
Example

‎source/settings/settings-reference.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ You can configure the following settings on the |compass| interface:
142142
- Privacy
143143
- Allow |compass-short| to send anonymous usage statistics.
144144

145+
To learn more, see :ref:`compass-telemetry`.
146+
145147
* - Give Product Feedback
146148
- Privacy
147149
- Allow our Product team to occasionally reach out for feedback about

‎source/settings/telemetry.txt

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
.. _compass-telemetry:
2+
3+
===========================
4+
Configure Telemetry Options
5+
===========================
6+
7+
.. facet::
8+
:name: genre
9+
:values: tutorial
10+
11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 1
15+
:class: singlecol
16+
17+
|compass-short| collects anonymous aggregated usage data to improve
18+
MongoDB products. |compass-short| collects this information by default,
19+
but you can disable this data collection.
20+
21+
About this Task
22+
---------------
23+
24+
|compass-short| telemetry tracks the following data:
25+
26+
- The type of MongoDB deployment that you connect |compass-short| to.
27+
For example, Enterprise Edition, Community Edition, or Atlas Data
28+
Lake.
29+
30+
- Hostnames of the deployments that you connect |compass-short| to.
31+
32+
- Actions that you perform in |compass-short|, such as creating
33+
collections and indexes. Telemetry only tracks the general action
34+
performed, and does not track field values or namespaces.
35+
36+
- Anonymized queries run in |compass-short|. These queries are stored
37+
such that they cannot be associated to individual users.
38+
39+
- Errors.
40+
41+
|compass-short| *does not* track:
42+
43+
- IP addresses, usernames, or credentials
44+
45+
- Data stored in your MongoDB deployment
46+
47+
- Personal identifiable information
48+
49+
For more information, see `MongoDB's Privacy Policy
50+
<https://www.mongodb.com/legal/privacy-policy?tck=docs_mongosh>`__.
51+
52+
.. tip::
53+
54+
|compass-short| Isolated Edition automatically disables telemetry.
55+
For more information on different |compass-short| editions, see
56+
:ref:`compass-feature-table`.
57+
58+
Steps
59+
-----
60+
61+
You can toggle telemetry in either:
62+
63+
- The |compass-short| :ref:`Settings window
64+
<compass-settings-reference>`
65+
66+
- :ref:`Command line options <cli-options>`
67+
68+
- :ref:`Configuration file options <config-file>`
69+
70+
Settings Window
71+
~~~~~~~~~~~~~~~
72+
73+
To toggle telemetry from the |compass-short| settings:
74+
75+
.. procedure::
76+
:style: normal
77+
78+
.. step:: Open the Settings window.
79+
80+
a. In the |compass-short| top menu bar, click :guilabel:`MongoDB Compass`
81+
82+
b. Click :guilabel:`Settings`
83+
84+
.. figure:: /images/compass/settings-panel-location.png
85+
:scale: 40%
86+
:alt: Settings window location under the MongoDB Compass system menu
87+
88+
.. tip::
89+
90+
Alternatively, you can use keyboard shortcuts to open the
91+
:guilabel:`Settings` window:
92+
93+
- Windows / Linux: ``Ctrl`` + ``,``
94+
95+
- Mac: ``⌘`` + ``,``
96+
97+
.. step:: In the left pane of the :guilabel:`Settings` window, click :guilabel:`Privacy`.
98+
99+
.. step:: Toggle :guilabel:`Enable Usage Statistics`.
100+
101+
.. step:: Click :guilabel:`Save`.
102+
103+
Command Line
104+
~~~~~~~~~~~~
105+
106+
To disable telemetry from the command line, start |compass-short| with
107+
the ``--no-trackUsageStatistics`` option.
108+
109+
.. code-block:: sh
110+
111+
<path-to-Compass-executable> --no-trackUsageStatistics
112+
113+
.. note::
114+
115+
The name and filepath of the |compass-short| executable depend on your
116+
operating system. For more information, see
117+
:ref:`compass-executable-location`.
118+
119+
Configuration File
120+
~~~~~~~~~~~~~~~~~~
121+
122+
To disable telemetry from the |compass-short| configuration file, set
123+
``trackUsageStatistics`` to ``false``.
124+
125+
EJSON
126+
`````
127+
128+
.. code-block:: json
129+
130+
{ "trackUsageStatistics": false }
131+
132+
YAML
133+
````
134+
135+
.. code-block:: yaml
136+
137+
trackUsageStatistics: false

0 commit comments

Comments
 (0)