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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
|
# 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 :: Tabbed Browser'
browser.engagement:
tab_unload_count:
type: counter
description: >
The count of tab unload events by TabUnloader due to a low-memory
situation.
This metric was generated to correspond to the Legacy Telemetry
scalar browser.engagement.tab_unload_count.
bugs:
- https://bugzil.la/1715858
data_reviews:
- https://bugzil.la/1715858
notification_emails:
- dao@mozilla.com
- rtestard@mozilla.com
expires: never
telemetry_mirror: BROWSER_ENGAGEMENT_TAB_UNLOAD_COUNT
tab_reload_count:
type: counter
description: >
The count of tab reload events by the user after unloaded.
This metric was generated to correspond to the Legacy Telemetry
scalar browser.engagement.tab_reload_count.
bugs:
- https://bugzil.la/1715858
data_reviews:
- https://bugzil.la/1715858
notification_emails:
- dao@mozilla.com
- rtestard@mozilla.com
expires: never
telemetry_mirror: BROWSER_ENGAGEMENT_TAB_RELOAD_COUNT
tab_explicit_unload:
type: event
description: >
Recorded when the user explicitly unloads tab(s) from memory via
the tab context menu.
notification_emails:
- gstoll@mozilla.com
- haftandilian@mozilla.com
bugs:
- https://bugzil.la/1926390
data_reviews:
- https://bugzil.la/1926390
data_sensitivity:
- interaction
extra_keys:
unload_selected_tab:
description: whether the currently-selected tab is unloaded
type: boolean
all_tabs_unloaded:
description: whether all tabs in the window were unloaded
type: boolean
tabs_unloaded:
description: The number of tabs unloaded in this operation
type: quantity
memory_before:
description: Memory usage before unloading tabs (in bytes)
type: quantity
memory_after:
description: Memory usage after unloading tabs (in bytes)
type: quantity
time_to_unload_in_ms:
description: Time to unload tabs (in ms)
type: quantity
expires: never
tab_unload_to_reload:
type: timing_distribution
description: >
How long (sec) a tab had been unloaded until it was reloaded.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram TAB_UNLOAD_TO_RELOAD.
time_unit: second
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1715858
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1715858
notification_emails:
- tkikuchi@mozilla.com
expires: never
telemetry_mirror: TAB_UNLOAD_TO_RELOAD
browser.ui.interaction:
all_tabs_panel_dragstart_tab_event_count:
type: counter
description: >
Records a count of how many times a drag event started for a tab
within the All Tabs panel.
This metric was generated to correspond to the Legacy Telemetry
scalar
browser.ui.interaction.all_tabs_panel_dragstart_tab_event_count.
bugs:
- https://bugzil.la/1804722
data_reviews:
- https://bugzil.la/1804722
notification_emails:
- shong@mozilla.com
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_UI_INTERACTION_ALL_TABS_PANEL_DRAGSTART_TAB_EVENT_COUNT
no_lint:
- COMMON_PREFIX
all_tabs_panel_entrypoint:
type: labeled_counter
description: >
Records a count of how many times the All Tabs Panel was opened,
keyed on a string describing the entrypoint.
This metric was generated to correspond to the Legacy Telemetry
scalar browser.ui.interaction.all_tabs_panel_entrypoint.
bugs:
- https://bugzil.la/1804722
data_reviews:
- https://bugzil.la/1804722
notification_emails:
- shong@mozilla.com
- mconley@mozilla.com
expires: never
telemetry_mirror: BROWSER_UI_INTERACTION_ALL_TABS_PANEL_ENTRYPOINT
no_lint:
- COMMON_PREFIX
tabgroup:
create_group:
type: event
description: >
Recorded when the user creates a new tab group via
the tab context menu or through drag and drop.
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
bugs:
- https://bugzil.la/1938423
- https://bugzil.la/1954500
data_reviews:
- https://bugzil.la/1938423
- https://bugzil.la/1954500
data_sensitivity:
- interaction
extra_keys:
source:
description: The means by which the tab group was created
type: string
tabs:
description: The number of tabs in the group when it was created
type: quantity
layout:
description: The layout of the tab strip when the group was created (either "horizontal" or "vertical")
type: string
id:
description: The ID of the created tab group
type: string
expires: never
reopen:
type: event
description: >
Recorded when a user reopens a saved tab group
notification_emails:
- dao@mozilla.com
- dwalker@mozilla.com
- jswinarton@mozilla.com
- dwalker@mozilla.com
bugs:
- https://bugzil.la/1938425
data_reviews:
- https://bugzil.la/1938425
extra_keys:
source:
description: The surface used to find and recall the saved group
type: string
layout:
description: The tabs layout (horizontal or vertical)
type: string
id:
description: The ID of the tab group. Tab group IDs are derived from their creation timestamps and have no other relationship to any tab group metadata.
type: string
type:
description: Whether the user reopened a saved group or a deleted group.
type: string
expires: never
add_tab:
type: event
disabled: true # To be controlled by server knobs during Firefox 138 launch due to expected high volume
description: >
Recorded when the user adds one or more ungrouped tabs to an existing tab group
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938424
data_reviews:
- https://bugzil.la/1938424
data_sensitivity:
- interaction
extra_keys:
source:
description: The system, surface, or control the user used to add the tab(s) to the tab group
type: string
tabs:
description: The number of tabs added to the tab group
type: quantity
layout:
description: The layout of the tab strip when the tabs were added (either "horizontal" or "vertical")
type: string
expires: never
active_groups:
type: labeled_quantity
description: >
Records the number of groups present in the tab bar, split by expanded or collapsed.
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
bugs:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
data_reviews:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
expires: never
unit: tab groups
labels:
- expanded
- collapsed
tabs_per_active_group:
type: labeled_quantity
description: >
Records statistics about the number of tabs per active group: max, median, average and min.
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
bugs:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
data_reviews:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
expires: never
unit: tabs
labels:
- max
- median
- average
- min
saved_groups:
type: quantity
description: >
Records the number of saved tab groups present in the user's session
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938398
data_reviews:
- https://bugzil.la/1938398
expires: never
unit: tab groups
tabs_per_saved_group:
type: labeled_quantity
description: >
Records statistics about the number of tabs per saved tab group: max, median, average and min.
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938398
data_reviews:
- https://bugzil.la/1938398
expires: never
unit: tabs
labels:
- max
- median
- average
- min
tab_count_in_groups:
type: labeled_quantity
description: >
Records the latest number of tabs in the tab bar, split by being inside a group or outside.
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
bugs:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
data_reviews:
- https://bugzil.la/1938397
- https://bugzil.la/1954500
expires: never
unit: tabs
labels:
- inside
- outside
save:
type: event
description: >
Recorded when the user saves a tab group
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
bugs:
- https://bugzil.la/1938426
data_reviews:
- https://bugzil.la/1938426
expires: never
extra_keys:
user_triggered:
description: >
Whether the user explicitly chose to save the tab group, or the group
was automatically saved as a result of browser operations (e.g. the
user closed a window that has open tab groups).
type: boolean
id:
description: The ID of the saved tab group
type: string
delete:
type: event
description: >
Recorded when the user deletes a tab group
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938430
data_reviews:
- https://bugzil.la/1938430
data_sensitivity:
- interaction
extra_keys:
source:
description: The system, surface, or control the user used to delete the tab group
type: string
id:
description: Tab group ID of the tab group being deleted. Tab group IDs are derived from their creation timestamps and have no other relationship to any tab group metadata.
type: string
expires: never
ungroup:
type: event
description: >
Recorded when the user ungroups all tabs of a tab group
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1963713
data_reviews:
- https://bugzil.la/1963713
data_sensitivity:
- interaction
extra_keys:
source:
description: The system, surface, or control the user used to ungroup the tabs of the tab group
type: string
expires: never
tab_interactions:
type: labeled_counter
description: >
Records interactions with tabs related to a group: open, add tab to
group, duplicate, create a new tab, close a tab, reorder, and remove from
group
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938405
- https://bugzil.la/1960360
- https://bugzil.la/1961161
data_reviews:
- https://bugzil.la/1938405
- https://bugzil.la/1960360
- https://bugzil.la/1961161
data_sensitivity:
- interaction
labels:
- activate
- add
- duplicate
- new
- close_tabstrip
- close_tabmenu
- close_tab_other
- reorder
- remove_same_window
- remove_other_window
- remove_new_window
expires: never
group_interactions:
type: labeled_counter
description: >
Records interactions with tab groups: expand/collapse; rename, change
color; save/reopen/delete; ungroup tabs; open from tab menu/recent/
Awesomebar; move to another window
notification_emails:
- dao@mozilla.com
- jswinarton@mozilla.com
- sthompson@mozilla.com
bugs:
- https://bugzil.la/1938401
data_reviews:
- https://bugzil.la/1938401
data_sensitivity:
- interaction
labels:
- expand
- collapse
- rename
- change_color
- save
- reopen
- open_tabmenu
- open_recent
- open_suggest
- delete
- ungroup
- move_window
expires: never
smart_tab_optin:
type: event
description: >
Recorded when onboards to smart tab grouping through opt-in UI
notification_emails:
- rrando@mozilla.com
- vbaungally@mozilla.com
bugs:
- https://bugzil.la/1956073
data_reviews:
- https://bugzil.la/1956073
data_sensitivity:
- interaction
extra_keys:
step:
description: step and description of opt-in screen interaction
type: string
expires: never
no_lint:
- COMMON_PREFIX
smart_tab_topic:
type: event
description: >
Recorded when the user saves a tab group label with the ml topic
model
notification_emails:
- rrando@mozilla.com
- vbaungally@mozilla.com
bugs:
- https://bugzil.la/1949010
- https://bugzil.la/1961641
data_reviews:
- https://bugzil.la/1949010
- https://bugzil.la/1961641
data_sensitivity:
- interaction
extra_keys:
action:
description: >
whether the user saved or canceled generating a label
type: string
tabs_in_group:
description: >
number of tabs in the group for which model is generating a
label
type: quantity
ml_label_length:
description: length of label suggested by model
type: quantity
user_label_length:
description: length of label saved by the user
type: quantity
levenshtein_distance:
description: >
Levenshtein distance between label suggested by model
and saved by user
type: quantity
model_revision:
description: topic model version currently running
type: string
id:
description: The ID of the created tab group
type: string
label_reason:
description: Whether the model suggested no label due to low probability or dissimilar tabs
type: string
expires: never
no_lint:
- COMMON_PREFIX
smart_tab_suggest:
type: event
description: >
Recorded when the user saves suggested tabs using the ml
embedding model
notification_emails:
- rrando@mozilla.com
- vbaungally@mozilla.com
bugs:
- https://bugzil.la/1949010
data_reviews:
- https://bugzil.la/1949010
data_sensitivity:
- interaction
extra_keys:
action:
description: whether the user saved or canceled
type: string
tabs_in_window:
description: number of tabs in current window
type: quantity
tabs_in_group:
description: number of tabs in the current group
type: quantity
tabs_suggested:
description: number of tabs suggested by the ml model
type: quantity
tabs_approved:
description: number of tabs the user saved from the suggestions
type: quantity
tabs_removed:
description: >
number of tabs the user removed from the
suggestions
type: quantity
model_revision:
description: embedding model version currently running
type: string
id:
description: The ID of the created tab group
type: string
expires: never
no_lint:
- COMMON_PREFIX
smart_tab:
type: event
description: >
Recorded when any pref cause smart tabs to be enabled / disabled
notification_emails:
- rrando@mozilla.com
- vbaungally@mozilla.com
bugs:
- https://bugzil.la/1962228
data_reviews:
- https://bugzil.la/1962228
data_sensitivity:
- interaction
extra_keys:
enabled:
description: whether the preference was enabled or disabled in any way
type: boolean
expires: never
no_lint:
- COMMON_PREFIX
smart_tab_enabled:
# metrics
type: boolean
lifetime: application
description: >
Records if the user has smart tab groups enabled
notification_emails:
- rrando@mozilla.com
- vbaungally@mozilla.com
bugs:
- https://bugzil.la/1962228
data_reviews:
- https://bugzil.la/1962228
data_sensitivity:
- interaction
expires: never
send_in_pings:
- metrics
no_lint:
- COMMON_PREFIX
browser.tabswitch:
update:
type: timing_distribution
description: >
Firefox: Time in ms spent updating UI in response to a tab switch
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_SWITCH_UPDATE_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
notification_emails:
- perf-telemetry-alerts@mozilla.com
- mconley@mozilla.com
expires: never
telemetry_mirror: FX_TAB_SWITCH_UPDATE_MS
total:
type: timing_distribution
description: >
Firefox: Time in ms between tab selection and tab content paint in e10s
windows
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_SWITCH_TOTAL_E10S_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1156592
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1156592
- https://bugzilla.mozilla.org/show_bug.cgi?id=1489524
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: FX_TAB_SWITCH_TOTAL_E10S_MS
spinner_visible:
type: timing_distribution
description: >
Firefox: If the spinner interstitial displays during tab switching,
records the time in ms the graphic is visible
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_SWITCH_SPINNER_VISIBLE_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1156592
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1156592
notification_emails:
- mconley@mozilla.com
- dothayer@mozilla.com
expires: never
telemetry_mirror: FX_TAB_SWITCH_SPINNER_VISIBLE_MS
spinner_visible_trigger:
type: labeled_counter
description: >
Diagnostic probe to aid in categorizing tab switch spinners. Records what
most recently set the loadTimer to null if a spinner was displayed.
This metric was generated to correspond to the Legacy Telemetry
categorical histogram FX_TAB_SWITCH_SPINNER_VISIBLE_TRIGGER.
labels:
- none
- preActions
- postActions
- onLoadTimeout
- onLayersReady
- onSizeModeOrOcc
- onEndSwapDocShells
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1442068
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1442068
notification_emails:
- dothayer@mozilla.com
expires: never
telemetry_mirror: h#FX_TAB_SWITCH_SPINNER_VISIBLE_TRIGGER
browser.tabclose:
time_anim:
type: timing_distribution
description: >
Firefox: Time taken from the point of closing a tab (with animation), to
the browser element being removed from the DOM. (ms).
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_CLOSE_TIME_ANIM_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1488952
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1488952
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: FX_TAB_CLOSE_TIME_ANIM_MS
time_no_anim:
type: timing_distribution
description: >
Firefox: Time taken from the point of closing a tab (without animation) to
the browser element being removed from the DOM. (ms).
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_CLOSE_TIME_NO_ANIM_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1714255
- https://bugzilla.mozilla.org/show_bug.cgi?id=1730041
- https://bugzilla.mozilla.org/show_bug.cgi?id=1754640
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1714255
- https://bugzilla.mozilla.org/show_bug.cgi?id=1730041
- https://bugzilla.mozilla.org/show_bug.cgi?id=1754640
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: FX_TAB_CLOSE_TIME_NO_ANIM_MS
permit_unload_time:
type: timing_distribution
description: >
Firefox: Time taken to run permitUnload on a browser during tab close to
see whether or not we're allowed to close the tab (ms).
This metric was generated to correspond to the Legacy Telemetry
exponential histogram FX_TAB_CLOSE_PERMIT_UNLOAD_TIME_MS.
time_unit: millisecond
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1714255
- https://bugzilla.mozilla.org/show_bug.cgi?id=1730041
- https://bugzilla.mozilla.org/show_bug.cgi?id=1754640
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1340842
- https://bugzilla.mozilla.org/show_bug.cgi?id=1714255
- https://bugzilla.mozilla.org/show_bug.cgi?id=1730041
- https://bugzilla.mozilla.org/show_bug.cgi?id=1754640
notification_emails:
- mconley@mozilla.com
expires: never
telemetry_mirror: FX_TAB_CLOSE_PERMIT_UNLOAD_TIME_MS
|
