aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/howto/creator-telemetry.qdoc
blob: 6b0671e639377a7cbcd0cb9459798e02bf2134a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
**
****************************************************************************/

/*!
    \page creator-telemetry.html
    \if defined(qtdesignstudio)
    \previouspage creator-editor-external.html
    \else
    \previouspage creator-task-lists.html
    \endif
    \nextpage collecting-usage-statistics.html

    \title Managing Data Collection

    \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
    collected.

    If you accept, all collected and transmitted data is fully transparent to
    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.


    See \l {Collecting Usage Statistics} for more information about the data
    transmitted by the telemetry plugin and \l {Specifying Telemetry Settings}
    {specifying telemetry settings}.
    \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 UsageStatistic.
    \image studio-usage-statistics.png "Enabling Usage Statistics"
    \endif

    \if defined(qtdesignstudio)
    See below for more information about the collected data:

    \list
        \li \l {Collecting Usage Statistics}
        \li \l {Collecting User Feedback}
        \li \l {Reporting Crashes}
    \endlist
    \endif

    \section1 Principles of Data Collection

    No personal data, such as names, IP addresses, MAC addresses, or project
    and path names are collected. However, QUuid objects are used to identify
    data records that belong to one user. The objects cannot be converted
    back to the actual values from which they were generated.

    For more information about Qt privacy policy, select
    \l{https://www.qt.io/terms-conditions/#privacy}
    {Legal Notice and Privacy Policy}.
*/

/*!
    \page collecting-usage-statistics.html
    \previouspage creator-telemetry.html
    \if defined(qtdesignstudio)
    \nextpage collecting-user-feedback.html
    \else
    \nextpage creator-help-overview.html
    \endif

    \title Collecting Usage Statistics

    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
    \QC respects the same privacy rules.

    The data is transmitted to the backend storage using an encrypted
    connection. The storage is located in the same Heroku backend as the
    Qt installer backend. Physically, data is stored in the Amazon cloud.

    \section1 Specifying Telemetry Settings

    To determine what data is transmitted to the backend storage:

    \list 1
        \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry
            > \uicontrol {Usage Statistics}.
            \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 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
*/

/*!
    \page collecting-user-feedback.html
    \previouspage collecting-usage-statistics.html
    \nextpage creator-crashpad.html

    \title Collecting User Feedback

    A pop-up survey asking for your feedback will appear for some of the features
    after you have been using them for some time. You will be asked to to rate
    the usefulness of the feature on a scale of one to five stars. You must rate
    the feature with at least one star if you wish to submit your rating. You
    are also encouraged to give additional written feedback. After you select
    \uicontrol Skip or \uicontrol Submit, the pop-up survey will not appear for
    the same feature again.

    \image studio-feedback-popup.png "User feedback pop-up survey for Flow Editor"

    For the pop-up survey to appear, you must enable collecting statistics, and
    also allow collecting \uicontrol {4 - Detailed usage statistics} in
    \uicontrol Tools > \uicontrol Options >  \uicontrol Telemetry >
    \uicontrol {Usage Statistics} > \uicontrol {Telemetry mode}.
    You can review the submitted user feedback in
    \uicontrol Tools > \uicontrol Options > \uicontrol Telemetry >
    \uicontrol {Usage Statistics} > \uicontrol {Collected Data} by selecting
    \uicontrol {Qt Quick Designer Usage of views and actions} in
    \uicontrol {Data sources}.
*/

/*!
    \page creator-crashpad.html
    \previouspage collecting-user-feedback.html
    \nextpage studio-help.html

    \title Reporting Crashes

    You can enable \QDS to report crashes automatically. \QDS uses Google
    Crashpad to collect crashes and report them to the Sentry backend storage
    for processing. The purpose of Crashpad is to capture application state in
    sufficient detail to allow developers to diagnose and, where possible, fix
    the issue causing the crash. Crashpad may capture arbitrary contents from
    the memory of a crashed process, including user sensitive information, URLs,
    and other content provided by the users. The collected reports are used for
    the sole purpose of fixing bugs. For more information on Crashpad, see the
    \l {https://chromium.googlesource.com/crashpad/crashpad/+/master/doc/overview_design.md}
    {documentation} by Google. For more information on processing and storing
    of the collected data, see \l {https://sentry.io/security/}
    {Security & Compliance} by Sentry.

    To enable sending crash reports, select \uicontrol Tools > \uicontrol
    Options > \uicontrol Environment > \uicontrol System
    (\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"
*/