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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- 'Firefox :: General'
browser.engagement:
active_ticks:
type: counter
description: |
The number of five-second intervals ('ticks') the user was considered
'active'.
'active' means keyboard or mouse interaction with the application.
It doesn't take into account whether or not the window has focus or is in
the foreground, only if it is receiving these interaction events.
Migrated from Telemetry's `browser.engagement.active_ticks`.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1376942 # Telemetry
- https://bugzilla.mozilla.org/show_bug.cgi?id=1545172 # Telemetry
- https://bugzilla.mozilla.org/show_bug.cgi?id=1741674
- https://bugzilla.mozilla.org/show_bug.cgi?id=1755050
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781578
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1545172#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781578
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811152#c5
data_sensitivity:
- interaction
notification_emails:
- loines@mozilla.com
expires: never
send_in_pings:
- baseline
- metrics
no_lint:
- BASELINE_PING
uri_count:
type: counter
description: |
The number of total non-unique http(s) URIs visited, including page
reloads, after the session has been restored. URIs on minimized or
background tabs may also be counted. Private browsing uris are included.
Migrated from Telemetry's
`browser.engagement.total_uri_count_normal_and_private_mode`.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1535169 # Telemetry
- https://bugzilla.mozilla.org/show_bug.cgi?id=1741674
- https://bugzilla.mozilla.org/show_bug.cgi?id=1755050
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781578
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1535169#c14
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781578
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811152#c5
data_sensitivity:
- interaction
notification_emails:
- loines@mozilla.com
expires: never
send_in_pings:
- baseline
- metrics
no_lint:
- BASELINE_PING
profile_count:
type: quantity
unit: profiles
description: |
Windows only count of the browser profiles on the current system. This
counts profiles that have been used across all Windows user accounts on
machine since this probe was added. The value persists across installs.
A value of 0 is reported if there is an error determining the correct
count. Unset on other platforms.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1813195
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1647422#c8
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- rtestard@mozilla.com
send_in_pings:
- metrics
expires: never
installation.first_seen:
failure_reason:
type: string
description: >
Only sent if unable to collect firstSeen data. Can have
value "NotFoundError" if file not found or other values
depending on the failure reason.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_FAILURE_REASON
installer_type:
type: string
description: >
The type of installer used to install Firefox.
The value is one of "stub", "full", or "msix"
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_INSTALLER_TYPE
version:
type: string
description: >
The application version installed by the installer
(not necessarily the current version)
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_VERSION
admin_user:
type: boolean
description: >
Whether the installer is running from an elevated admin user
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_ADMIN_USER
install_existed:
type: boolean
description: >
Whether there was already an install in this location
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_INSTALL_EXISTED
profdir_existed:
type: boolean
description: >
Whether the top-level profile directory existed
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_PROFDIR_EXISTED
other_inst:
type: boolean
description: >
Whether there was already any non-MSIX install on this system
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_OTHER_INST
other_msix_inst:
type: boolean
description: >
Whether there was already any MSIX install on this system
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_OTHER_MSIX_INST
silent:
type: boolean
description: >
(optional, present if installer_type is "full")
Whether this was a silent install
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_SILENT
from_msi:
type: boolean
description: >
(optional, present if installer_type is "full")
Whether this was an MSI install
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_FROM_MSI
default_path:
type: boolean
description: >
(optional, present if installer_type is "full")
Whether the default path was used
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1811374
data_sensitivity:
- technical
notification_emails:
- rtestard@mozilla.com
- application-update-telemetry-alerts@mozilla.com
expires: never
telemetry_mirror: INSTALLATION_FIRSTSEEN_DEFAULT_PATH
performance.interaction:
tab_switch_composite:
type: timing_distribution
time_unit: millisecond
telemetry_mirror: FX_TAB_SWITCH_COMPOSITE_E10S_MS
description: >
Time between tab selection and first composite of the tab content onto the
screen.
(Migrated from the geckoview metric of the same name.)
metadata:
tags:
- 'Firefox :: Tabbed Browser'
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1481704
- https://bugzilla.mozilla.org/show_bug.cgi?id=1529352
- https://bugzilla.mozilla.org/show_bug.cgi?id=1580077
- https://bugzilla.mozilla.org/show_bug.cgi?id=1877842
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1580077#c10
notification_emails:
- mconley@mozilla.com
- perf-telemetry-alerts@mozilla.com
expires: never
browser.usage:
interaction:
type: event
description: >
The user interacted with something in the Firefox Desktop frontend.
Could be via mouse or keyboard, could be a command or a UI element.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1889111
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1889111
expires: 132
data_sensitivity: [interaction]
notification_emails:
- chutten@mozilla.com
extra_keys:
flow_id:
type: string
description: >
An UUIDv4 used to group interaction events together under the
assumption that they're part of the same user activity.
See BrowserUsageTelemetry's FLOW_IDLE_TIME for details.
source:
type: string
description: >
The source of the interaction. Usually a UI section
(like `bookmarks_bar` or `content_context`), but can also be an input
method (like `keyboard`).
The full list of supported `source`s can be found in
`BrowserUsageTelemetry`'s `BROWSER_UI_CONTAINER_IDS. Plus `keyboard`
and panes from `about:preferences` listed in `PREFERENCES_PANES`.
See `_getWidgetContainer` for details.
widget_id:
type: string
description: >
The item interacted with.
Usually the `id` of the DOM Node that the user used,
sometimes the `id` of the parent or ancestor Node instead.
This node is then conjugated by obscuring any addon id in it
(turning it to the string `addonX` where `X` is a number stable
within a browsing session) and then replacing any underscore with a
hyphen.
See `BrowserUsageTelemetry#_getWidgetID` and `telemetryId`.
e.g. "Browser:Reload", "key-newNavigatorTab", "PanelUI-Bookmarks".
send_in_pings:
- prototype-no-code-events
|
