Doc: Add information about Telemetry and Crashpad settings

Change-Id: I94af94cd99537cc5fe15f3bd33b5edcafe0b33e2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
This commit is contained in:
Johanna Vanhatapio
2020-12-08 13:39:30 +02:00
parent 17d7f24911
commit 2b1de0c084
4 changed files with 26 additions and 4 deletions

View File

@@ -34,7 +34,7 @@
\endif
\title Managing Data Collection Settings
\if defined (qtcreator)
When you install \QC as a part of Qt installation, you are asked whether
you allow it to collect pseudonymous information about your system and \QC
use. If you decline, the plugin is not installed and no analytics data is
@@ -44,6 +44,14 @@
you. You can change the settings for collecting and transmitting data any
time. By default, no data is collected and you have to select a telemetry
mode for data collection to begin.
\else
To enable the use of the telemetry plugin, you need to select \uicontrol
{Enable Usage Statistics} in the splash screen that appears when you first
launch \QDS. If the splash screen does not appear, you can enable the
telemetry plugin by selecting \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol UsageStatistics.
\image studio-usage-statistics.png "Enabling Usage Statistics"
\endif
\section1 Principles of Data Collection
@@ -58,7 +66,7 @@
\section1 Collecting Usage Statistics
The Telemetry plugin uses the
The telemetry plugin uses the
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
{KUserFeedback} framework to collect the usage data. The library
has been designed from the user data privacy point of view and
@@ -75,10 +83,10 @@
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry
> \uicontrol {Usage Statistics}.
\image qtcreator-telemetry-settings.png
\image qtcreator-telemetry-settings.png "Telemetry settings"
\li In the \uicontrol {Telemetry mode} list, select the mode that
determines what kind of data is collected.
\li In the \uicontrol {Data} list, select entries to view
\li In the \uicontrol {Data sources} list, select entries to view
exactly what data is collected. Deselect check boxes for data
that you do not want to transmit to the backend storage.
\endlist
@@ -104,5 +112,12 @@
(\uicontrol {Qt Design Studio} > \uicontrol Preferences > \uicontrol
Environment > \uicontrol System on \macos), and then select
\uicontrol {Enable crash reporting}.
Since crash reports take up disk space, you may wish to remove them when
they are no longer needed. Select \uicontrol {Clear local crash reports} to
remove the crash report data.
\image studio-crashpad-checkbox.png "Checkbox for enabling crash reporting"
\endif
*/

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

View File

@@ -89,9 +89,16 @@
tools.
\li \l{Managing Data Collection Settings}
\if defined (qtcreator)
You can enable \QC to report crashes automatically. If you agreed to
pseudonymous user statistics collection during the \QC installation,
you can turn it on and determine what type of data is collected and
transmitted to the backend storage.
\else
You can enable \QDS to report crashes automatically. If you enable
the telemetry plugin, you can turn on the pseudonymous user
statistics collection and determine what type of data is collected
and transmitted to the backend storage.
\endif
\endlist
*/