Source code

Revision control

Other Tools

1
=========
2
Stub Ping
3
=========
4
5
When the stub installer completes with almost any result [1]_, it generates a ping containing some data about the system and about how the installation went. This ping isn't part of Firefox unified telemetry, it's a bespoke system; we can't use the telemetry client code when it isn't installed yet.
6
7
8
Querying the stub ping
9
----------------------
10
11
The stub ping data is available (to those with a Mozilla LDAP login) on `Redash <https://sql.telemetry.mozilla.org>`_. Make sure to select the ``DSMO-RS`` data source. The ``download_stats`` table is the main data table. It contains the columns in the following list.
12
13
Some of the columns are marked [DEPRECATED] because they involve features that were removed when the stub installer was streamlined in Firefox 55. These columns were not removed to keep compatibility and so we could continue to use the old data, but they should no longer be used.
14
15
timestamp
16
Time the ping was received
17
18
build_channel
19
Channel the installer was built with the branding for ("release", "beta", "nightly", or "default")
20
21
update_channel
22
Value of MOZ_UPDATE_CHANNEL for the installer build; should generally be the same as build_channel
23
24
version
25
Version number of the installed product, or 0 if the installation failed. This is **not** the version of the installer itself.
26
27
build_id
28
Build ID of the installed product, or 0 of the installation failed
29
30
locale
31
Locale of the installer and of the installed product, in AB_CD format
32
33
amd64_bit_build
34
True if a 64-bit build was selected for installation. This means the OS is 64-bit, the RAM requirement was met, and no third-party software that blocks 64-bit installations was found.
35
36
amd64bit_os
37
True if the version of Windows on the machine was 64-bit
38
39
os_version
40
Version number of Windows in ``major.minor.build`` format [2]_
41
42
service_pack
43
Latest Windows service pack installed on the machine
44
45
server_os
46
True if the installed OS is a server version of Windows
47
48
admin_user
49
True if the installer was run by a user with administrator privileges (and the UAC prompt was accepted)
50
51
default_path
52
[DEPRECATED] True if the default installation path was not changed. We no longer support changing this in the streamlined stub, so this should always be true once `bug 1351697 <https://bugzilla.mozilla.org/show_bug.cgi?id=1351697>`_ is fixed
53
54
set_default
55
[DEPRECATED] True if the option to set the new installation as the default browser was left selected. We no longer attempt to change the default browser setting in the streamlined stub, so this should always be false.
56
57
new_default
58
[DEPRECATED] True if the new installation was successfully made the default browser. We no longer attempt to change the default browser setting in the streamlined stub, so this should always be false.
59
60
old_default
61
True if an existing installation of Firefox was already set as the default browser
62
63
had_old_install
64
True if at least one existing installation of Firefox was found on the system prior to this installation
65
66
old_version
67
Version of the previously existing Firefox installation, if any
68
69
old_build_id
70
Build ID of the previously existing Firefox installation, if any
71
72
bytes_downloaded
73
Size of the full installer data that was transferred before the download ended (whether it failed, was canceled, or completed normally)
74
75
download_size
76
Expected size of the full installer download according to the HTTP response headers
77
78
download_retries
79
Number of times the full installer download was retried or resumed. 10 retries is the maximum.
80
81
download_time
82
Number of seconds spent downloading the full installer
83
84
download_latency
85
Seconds between sending the full installer download request and receiving the first response data
86
87
download_ip
88
IP address of the server the full installer was download from (can be either IPv4 or IPv6)
89
90
manual_download
91
True if the user clicked on the button that opens the manual download page. The prompt to do that is shown after the installation fails or is canceled.
92
93
intro_time
94
[DEPRECATED] Seconds the user spent on the intro screen. The streamlined stub no longer has this screen, so this should always be 0.
95
96
options_time
97
[DEPRECATED] Seconds the user spent on the options screen. The streamlined stub no longer has this screen, so this should always be 0.
98
99
download_phase_time
100
Seconds spent in the download phase; should be very close to download_time, since nothing else happens in this phase.
101
102
preinstall_time
103
Seconds spent verifying the downloaded full installer and preparing to run it
104
105
install_time
106
Seconds the full installer ran for
107
108
finish_time
109
Seconds spent waiting for the installed application to launch
110
111
succeeded
112
True if a new installation was successfully created. False if that didn't happen for any reason, including when the user closed the installer window.
113
114
disk_space_error
115
[DEPRECATED] True if the installation failed because the drive we're trying to install to does not have enough space. The streamlined stub no longer sends a ping in this case, because the installation drive can no longer be selected.
116
117
no_write_access
118
[DEPRECATED] True if the installation failed because the user doesn't have permission to write to the path we're trying to install to. The streamlined stub no longer sends a ping in this case, because the installation drive can no longer be selected.
119
120
download_cancelled
121
True if the installation failed because the user closed the window during the download.
122
123
out_of_retries
124
True if the installation failed because the download had to be retried too many times (currently 10)
125
126
file_error
127
True if the installation failed because the downloaded file couldn't be read from
128
129
sig_not_trusted
130
True if the installation failed because the signature on the downloaded file wasn't valid and/or wasn't signed by a trusted authority
131
132
sig_unexpected
133
True if the installation failed because the signature on the downloaded file didn't have the expected subject and issuer names
134
135
install_timeout
136
True if the installation failed because running the full installer timed out. Currently that means it ran for more than 150 seconds for a new installation, or 165 seconds for a paveover installation.
137
138
new_launched
139
True if the installation succeeded and we were able to launch the newly installed application.
140
141
old_running
142
True if the installation succeeded and we weren't able to launch the newly installed application because a copy of Firefox was already running.
143
144
attribution
145
Any attribution data that was included with the installer
146
147
profile_cleanup_prompt
148
0: neither profile cleanup prompt was shown
149
150
1: the "reinstall" version of the profile cleanup prompt was shown (no existing installation was found, but the user did have an old Firefox profile)
151
152
2: the "paveover" version of the profile cleanup prompt was shown (an installation of Firefox was already present, but it's an older version)
153
154
profile_cleanup_requested
155
True if either profile cleanup prompt was shown and the user accepted the prompt
156
157
158
.. [1] No ping is sent if the installer exits early because initial system requirements checks fail.
159
.. [2] Previous versions of Windows have used a very small set of build numbers through their entire lifecycle. However, Windows 10 gets a new build number with every major update (about every 6 months), and many more builds have been released on its insider channels. So, to prevent a huge amount of noise, queries using this field should generally filter out the build number and only use the major and minor version numbers to differentiate Windows versions, unless the build number is specifically needed.