metrics.yaml 123 KB
Newer Older
Jeff Boek's avatar
Jeff Boek committed
1
2
3
# 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/.
Michael Droettboom's avatar
Michael Droettboom committed
4
---
5
6
$schema: moz://mozilla.org/schemas/glean/metrics/1-0-0

Michael Droettboom's avatar
Michael Droettboom committed
7
8
9
no_lint:
  - CATEGORY_GENERIC

10
events:
11
12
13
14
15
16
17
18
19
20
  app_opened_all_startup:
    type: event
    description: |
      A user opened the app to the HomeActivity. The HomeActivity
      encompasses the home screen, browser screen, settings screen,
      collections and other screens in the nav_graph.
      This differs from the app_opened probe because it measures all
      startups, not just cold startup. Note: There is a short gap
      between the time application goes into background and the time
      android reports the application going into the background.
21
22
23
24
      Note: This metric does not record souce when app opened from
      task switcher: open application -> press home button -> open
      recent tasks -> choose fenix. In this case will report
      [source = unknown, type = hot, has_saved_instance_state = false].
25
    extra_keys:
26
27
28
29
30
31
32
33
34
35
      type:
        description: |
          the startup type for opening fenix. the application and HomeActivity
          either needs to be created or started again. possible values are
          `cold`, `warm`, `hot` or `error`. Error is for impossible cases.
          Please file a bug if you see the error case.
          app created AND HomeActivity created = cold
          app started AND HomeActivity created = warm
          app started AND HomeActivity started = hot
          app created AND HomeActivity started = error
36
37
38
      source:
        description: |
          The method used to open Fenix. Possible values are `app_icon`,
39
40
41
42
43
44
45
46
47
48
49
50
          `custom_tab`, `link` or `unknown`. unknown is for startup sources
          where we can't pinpoint the cause. One UNKNOWN case is the app
          switcher where we don't know what variables to check to ensure this
          startup wasn't caused by something else.
      has_saved_instance_state:
        description: |
          boolean value whether or not startup type has a savedInstance.
          using savedInstance, HomeActivity's previous state can be restored.
          This is an optional key since it is not applicable to all the cases.
          for example, when we are doing a hot start up, we cant have a
          savedInstanceState therefore we report only [APP_ICON, HOT] instead
          of [APP_ICON, HOT, false].
51
52
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11830
53
54
      - https://github.com/mozilla-mobile/fenix/issues/12573
      - https://github.com/mozilla-mobile/fenix/pull/13494
55
56
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12114#pullrequestreview-445245341
57
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
58
      - https://github.com/mozilla-mobile/fenix/pull/13494#pullrequestreview-474050499
59
60
    data_sensitivity:
      - interaction
61
62
63
    notification_emails:
      - esmyth@mozilla.com
      - perf-android-fe@mozilla.com
64
    expires: "2021-06-01"
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
  app_received_intent:
    type: event
    description: |
      The system received an Intent for the HomeActivity. An intent
      is received an external entity wants to the app to display
      content. Intents can be received when the app is closed – at
      which point the app will be opened – or when the app is
      already opened – at which point the already open app will make
      changes such as loading a url. This can be used loosely as a
      heuristic for when the user requested to open the app. The
      HomeActivity encompasses the home screen and browser screen but
      may include other screens. This differs from the app_opened
      probe because it measures all startups, not just cold startup.
    extra_keys:
      source:
        description: |
          The method used to open Fenix. Possible values are `app_icon`,
          `custom_tab`, `link` or `unknown`
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11830
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11940/
87
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
88
89
90
    notification_emails:
      - esmyth@mozilla.com
      - perf-android-fe@mozilla.com
91
    expires: "2021-06-01"
92
93
  app_opened:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
94
    description: |
95
      A user opened the app (from cold start, to the homescreen or browser)
96
    extra_keys:
Jeff Boek's avatar
Jeff Boek committed
97
      source:
Michael Droettboom's avatar
Michael Droettboom committed
98
99
100
        description: |
          The method used to open Fenix. Possible values are: `app_icon`,
          `custom_tab` or `link`
101
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
102
      - https://github.com/mozilla-mobile/fenix/issues/968
103
      - https://github.com/mozilla-mobile/fenix/issues/10616
104
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
105
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
106
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
107
108
    data_sensitivity:
      - interaction
109
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
110
111
      - telemetry-client-dev@mozilla.com
      - fenix-core@mozilla.com
112
    expires: "2021-04-01"
113
114
  search_bar_tapped:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
115
    description: |
116
117
      A user tapped the search bar
    extra_keys:
Jeff Boek's avatar
Jeff Boek committed
118
      source:
Michael Droettboom's avatar
Michael Droettboom committed
119
120
121
        description: |
          The view the user was on when they initiated the search (For example:
          `Home` or `Browser`)
122
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
123
      - https://github.com/mozilla-mobile/fenix/issues/959
124
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
125
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
126
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
127
128
    data_sensitivity:
      - interaction
129
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
130
      - fenix-core@mozilla.com
131
    expires: "2021-04-01"
132
133
  entered_url:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
134
    description: |
135
136
      A user entered a url
    extra_keys:
Jeff Boek's avatar
Jeff Boek committed
137
      autocomplete:
Michael Droettboom's avatar
Michael Droettboom committed
138
139
140
        description: |
          A boolean that tells us whether the URL was autofilled by an
          Autocomplete suggestion
141
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
142
      - https://github.com/mozilla-mobile/fenix/issues/959
143
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
144
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
145
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
146
147
    data_sensitivity:
      - interaction
148
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
149
      - fenix-core@mozilla.com
150
    expires: "2021-04-01"
151
152
  performed_search:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
153
    description: |
154
155
      A user performed a search
    extra_keys:
Jeff Boek's avatar
Jeff Boek committed
156
      source:
Michael Droettboom's avatar
Michael Droettboom committed
157
158
159
160
        description: |
          A string that tells us how the user performed the search. Possible
          values are:

161
162
163
164
          * default.action
          * default.suggestion
          * shortcut.action
          * shortcut.suggestion
165
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
166
      - https://github.com/mozilla-mobile/fenix/issues/959
167
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
168
169
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
      - https://github.com/mozilla-mobile/fenix/pull/1677
170
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
171
172
    data_sensitivity:
      - interaction
173
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
174
      - fenix-core@mozilla.com
175
    expires: "2021-04-01"
176
177
  browser_menu_action:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
178
    description: |
179
180
181
      A browser menu item was tapped
    extra_keys:
      item:
Michael Droettboom's avatar
Michael Droettboom committed
182
183
184
185
        description: |
          A string containing the name of the item the user tapped. These items
          include:

186
            Settings, Help, Desktop Site toggle on/off, Find in Page,
Michael Droettboom's avatar
Michael Droettboom committed
187
188
            New Tab, Private Tab, Share, Report Site Issue, Back/Forward button,
            Reload Button, Quit, Reader Mode On, Reader Mode Off, Open In app,
189
            Add To Top Sites, Add-ons Manager, Bookmarks, History
190
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
191
      - https://github.com/mozilla-mobile/fenix/issues/1024
192
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
193
194
195
      - https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708
      - https://github.com/mozilla-mobile/fenix/pull/5098#issuecomment-529658996
      - https://github.com/mozilla-mobile/fenix/pull/6310
196
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
197
198
    data_sensitivity:
      - interaction
199
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
200
      - fenix-core@mozilla.com
201
    expires: "2021-04-01"
202
203
  total_uri_count:
    type: counter
Michael Droettboom's avatar
Michael Droettboom committed
204
205
206
    description: |
      A counter of URIs visited by the user in the current session, including
      page reloads. This does not include background page requests and URIs from
207
208
209
      embedded pages or private browsing but may be incremented without user
      interaction by website scripts that programmatically redirect to a new
      location.
210
    send_in_pings:
Michael Droettboom's avatar
Michael Droettboom committed
211
      - metrics
212
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
213
214
      - https://github.com/mozilla-mobile/fenix/issues/1301
      - https://github.com/mozilla-mobile/fenix/issues/4456
215
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
216
217
      - https://github.com/mozilla-mobile/fenix/pull/1785
      - https://github.com/mozilla-mobile/fenix/pull/8314
218
219
    data_sensitivity:
      - interaction
220
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
221
      - fenix-core@mozilla.com
222
    expires: "2021-08-01"
223
  preference_toggled:
224
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
225
    description: |
226
      A user toggled a boolean preference in settings
227
228
    extra_keys:
      preference_key:
Michael Droettboom's avatar
Michael Droettboom committed
229
230
231
232
233
234
235
236
237
        description: |
          The preference key for the boolean (true/false) preference the user
          toggled.

          We currently track: show_search_suggestions, remote_debugging,
          telemetry, tracking_protection, search_bookmarks,
          search_browsing_history, show_clipboard_suggestions,
          show_search_shortcuts, open_links_in_a_private_tab (bug in
          implementation https://github.com/mozilla-mobile/fenix/issues/7384),
238
          pref_key_sync_logins, pref_key_sync_bookmarks, pref_key_sync_history,
239
          pref_key_show_voice_search,
Michael Droettboom's avatar
Michael Droettboom committed
240
          and pref_key_show_search_suggestions_in_private.
241
242
      enabled:
        description: "Whether or not the preference is *now* enabled"
243
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
244
245
246
247
248
249
      - https://github.com/mozilla-mobile/fenix/issues/975
      - https://github.com/mozilla-mobile/fenix/issues/5094
      - https://github.com/mozilla-mobile/fenix/issues/5737
      - https://github.com/mozilla-mobile/fenix/issues/5586
      - https://github.com/mozilla-mobile/fenix/issues/6396
      - https://github.com/mozilla-mobile/fenix/issues/6070
250
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
251
252
253
254
255
256
257
      - https://github.com/mozilla-mobile/fenix/pull/1896
      - https://github.com/mozilla-mobile/fenix/pull/5704
      - https://github.com/mozilla-mobile/fenix/pull/5886
      - https://github.com/mozilla-mobile/fenix/pull/5975
      - https://github.com/mozilla-mobile/fenix/pull/6352
      - https://github.com/mozilla-mobile/fenix/pull/6601
      - https://github.com/mozilla-mobile/fenix/pull/6746
258
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
259
260
261
    data_sensitivity:
      - technical
      - interaction
262
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
263
      - fenix-core@mozilla.com
264
    expires: "2021-06-01"
265
266
  whats_new_tapped:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
267
    description: |
268
269
        A user opened the "what's new" page button
    bugs:
270
      - https://github.com/mozilla-mobile/fenix/issues/5021
271
272
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5090
273
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
274
275
    data_sensitivity:
      - interaction
276
277
    notification_emails:
      - fenix-core@mozilla.com
278
    expires: "2021-04-01"
279
280
  opened_link:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
281
282
    description: |
      A user opened a link with Fenix
283
284
    extra_keys:
      mode:
Michael Droettboom's avatar
Michael Droettboom committed
285
        description: |
286
287
288
          The mode the link was opened in. Either 'PRIVATE' or 'NORMAL'. N.B.:
          this probe may be incorrectly implemented: see
          https://github.com/mozilla-mobile/fenix/issues/14133
289
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
290
      - https://github.com/mozilla-mobile/fenix/issues/5737
291
292
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5975
293
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
294
295
    data_sensitivity:
      - interaction
296
297
    notification_emails:
      - fenix-core@mozilla.com
298
    expires: "2021-04-01"
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
  tab_counter_menu_action:
    type: event
    description:
      A tab counter menu item was tapped
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped. These items
          are:

            New tab, New private tab, Close tab
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11442
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11533
314
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
315
316
    data_sensitivity:
      - interaction
317
318
    notification_emails:
      - fenix-core@mozilla.com
319
    expires: "2021-04-01"
320

321
322
323
324
325
326
327
328
329
onboarding:
  fxa_auto_signin:
    type: event
    description:
      The onboarding automatic sign in card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
330
331
    data_sensitivity:
      - interaction
332
333
334
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
335
    expires: "2021-08-01"
336
337
338
339
340
341
342
343
  fxa_manual_signin:
    type: event
    description:
      The onboarding manual sign in card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
344
345
    data_sensitivity:
      - interaction
346
347
348
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
349
    expires: "2021-08-01"
350
351
352
353
354
355
356
357
  privacy_notice:
    type: event
    description:
      The onboarding privacy notice card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
358
359
    data_sensitivity:
      - interaction
360
361
362
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
363
    expires: "2021-08-01"
364
365
366
367
368
369
370
371
  pref_toggled_private_browsing:
    type: event
    description:
      The private browsing preference was selected from the onboarding card.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
372
373
    data_sensitivity:
      - interaction
374
375
376
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
377
    expires: "2021-08-01"
378
379
380
381
382
383
384
385
386
387
388
389
390
  pref_toggled_toolbar_position:
    type: event
    description:
      The toolbar position preference was chosen from the onboarding card.
    extra_keys:
      position:
        description: |
          A string that indicates the position of the toolbar TOP or BOTTOM.
          Default: BOTTOM
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
391
392
    data_sensitivity:
      - interaction
393
394
395
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
396
    expires: "2021-08-01"
397
398
399
400
401
  pref_toggled_tracking_prot:
    type: event
    description:
      The tracking protection preference was chosen from the onboarding card.
    extra_keys:
402
      setting:
403
404
405
406
407
408
409
        description: |
          A string that indicates the Tracking Protection policy STANDARD
          or STRICT. Default: Toggle ON, STANDARD
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
410
411
    data_sensitivity:
      - interaction
412
413
414
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
415
    expires: "2021-08-01"
416
417
418
419
420
421
422
423
  whats_new:
    type: event
    description:
      The onboarding What\'s New card was tapped.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
424
425
    data_sensitivity:
      - interaction
426
427
428
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
429
    expires: "2021-08-01"
430
431
432
433
434
435
436
437
438
439
440
441
442
  pref_toggled_theme_picker:
    type: event
    description:
      The device theme was chosen using the theme picker onboarding card.
    extra_keys:
      theme:
        description: |
          A string that indicates the theme LIGHT, DARK, or FOLLOW DEVICE.
          Default: FOLLOW DEVICE
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
443
444
    data_sensitivity:
      - interaction
445
446
447
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
448
    expires: "2021-08-01"
449
450
451
452
453
454
455
456
  finish:
    type: event
    description:
      The user taps starts browsing and ends the onboarding experience.
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/10824
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11867
457
458
    data_sensitivity:
      - interaction
459
460
461
    notification_emails:
      - fenix-core@mozilla.com
      - erichards@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
462
    expires: "2021-08-01"
463

464
465
search_shortcuts:
  selected:
466
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
467
    description: |
468
      A user selected a search shortcut engine to use
469
    extra_keys:
470
      engine:
Michael Droettboom's avatar
Michael Droettboom committed
471
472
        description: |
          The name of the built-in search engine the user selected as a string
473
    bugs:
474
      - https://github.com/mozilla-mobile/fenix/issues/793
475
    data_reviews:
476
      - https://github.com/mozilla-mobile/fenix/pull/1202#issuecomment-476870449
477
    notification_emails:
478
      - fenix-core@mozilla.com
479
    expires: "2021-08-01"
480

481
482
483
toolbar_settings:
  changed_position:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
484
    description: |
485
486
487
      The user selected a new position for the toolbar
    extra_keys:
      position:
Michael Droettboom's avatar
Michael Droettboom committed
488
489
        description: |
          A string that indicates the new position of the toolbar TOP or BOTTOM
490
491
492
493
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6054
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6608
494
495
    data_sensitivity:
      - interaction
496
497
    notification_emails:
      - fenix-core@mozilla.com
Chenxia Liu's avatar
Chenxia Liu committed
498
    expires: "2021-08-01"
499

500
crash_reporter:
501
502
  opened:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
503
    description: |
504
505
      The crash reporter was displayed
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
506
      - https://github.com/mozilla-mobile/fenix/issues/1040
507
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
508
      - https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708
509
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
510
511
    data_sensitivity:
      - interaction
512
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
513
      - fenix-core@mozilla.com
514
    expires: "2021-04-01"
515
516
  closed:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
517
    description: |
518
519
520
      The crash reporter was closed
    extra_keys:
      crash_submitted:
Michael Droettboom's avatar
Michael Droettboom committed
521
522
523
        description: |
          A boolean that tells us whether or not the user submitted a crash
          report
524
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
525
      - https://github.com/mozilla-mobile/fenix/issues/1040
526
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
527
      - https://github.com/mozilla-mobile/fenix/pull/1214#issue-264756708
528
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
529
530
    data_sensitivity:
      - interaction
531
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
532
      - fenix-core@mozilla.com
533
    expires: "2021-04-01"
534

535
536
537
context_menu:
  item_tapped:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
538
    description: |
539
540
541
      A user tapped an item in the browsers context menu
    extra_keys:
      named:
Michael Droettboom's avatar
Michael Droettboom committed
542
543
544
        description: |
          The name of the item that was tapped. Available items are:

545
546
547
548
549
          ```
          open_in_new_tab, open_in_private_tab, open_image_in_new_tab,
          save_image, share_link, copy_link, copy_image_location
          ```
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
550
      - https://github.com/mozilla-mobile/fenix/issues/957
551
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
552
      - https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010
553
      - https://github.com/mozilla-mobile/fenix/pull/13958#issuecomment-676857877
554
555
    data_sensitivity:
      - interaction
556
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
557
      - fenix-core@mozilla.com
558
    expires: "2021-04-01"
559

560
561
562
563
564
565
566
567
568
login_dialog:
  displayed:
    type: event
    description: |
      The login dialog prompt was displayed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
569
570
    data_sensitivity:
      - interaction
571
572
573
574
575
576
577
578
579
580
581
    notification_emails:
      - fenix-core@mozilla.com
    expires: "2021-02-01"
  cancelled:
    type: event
    description: |
      The login dialog prompt was cancelled
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
582
583
    data_sensitivity:
      - interaction
584
585
586
587
588
589
590
591
592
593
594
    notification_emails:
      - fenix-core@mozilla.com
    expires: "2021-02-01"
  saved:
    type: event
    description: |
      The login dialog prompt "save" button was pressed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
595
596
    data_sensitivity:
      - interaction
597
598
599
600
601
602
603
604
605
606
607
    notification_emails:
      - fenix-core@mozilla.com
    expires: "2021-02-01"
  never_save:
    type: event
    description: |
      The login dialog prompt "never save" button was pressed
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9730
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/13050
608
609
    data_sensitivity:
      - interaction
610
611
612
613
    notification_emails:
      - fenix-core@mozilla.com
    expires: "2021-02-01"

614
615
616
find_in_page:
  opened:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
617
    description: |
618
619
      A user opened the find in page UI
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
620
      - https://github.com/mozilla-mobile/fenix/issues/1036
621
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
622
      - https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010
623
624
    data_sensitivity:
      - interaction
625
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
626
      - fenix-core@mozilla.com
627
    expires: "2021-08-01"
628
629
  closed:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
630
    description: |
631
632
      A user closed the find in page UI
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
633
      - https://github.com/mozilla-mobile/fenix/issues/1036
634
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
635
      - https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010
636
637
    data_sensitivity:
      - interaction
638
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
639
      - fenix-core@mozilla.com
640
    expires: "2021-08-01"
641
642
  searched_page:
    type: event
Michael Droettboom's avatar
Michael Droettboom committed
643
    description: |
644
645
      A user searched the page
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
646
      - https://github.com/mozilla-mobile/fenix/issues/1036
647
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
648
      - https://github.com/mozilla-mobile/fenix/pull/1344#issuecomment-479285010
649
650
    data_sensitivity:
      - interaction
651
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
652
      - fenix-core@mozilla.com
653
    expires: "2021-08-01"
654

655
656
657
metrics:
  default_browser:
    type: boolean
Jeff Boek's avatar
Jeff Boek committed
658
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
659
    description: |
660
661
      Is Fenix the default browser?
    send_in_pings:
Michael Droettboom's avatar
Michael Droettboom committed
662
      - metrics
663
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
664
      - https://github.com/mozilla-mobile/fenix/issues/960
665
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
666
      - https://github.com/mozilla-mobile/fenix/pull/1067#issuecomment-474598673
667
668
    data_sensitivity:
      - interaction
669
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
670
      - fenix-core@mozilla.com
671
    expires: "2021-08-01"
672
673
674
  top_sites_count:
    type: counter
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
675
    description: |
676
677
678
679
680
      A counter that indicates how many top sites a user has. This value will
      only be set if the user has at least *one* top site. If they have 0,
      this ping will not get sent, resulting in a null value. To disambiguate
      between a failed `top_sites_count` ping and 0 top sites, please see
      `has_top_sites`.
681
682
683
684
685
686
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8125
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9556
687
688
    data_sensitivity:
      - interaction
689
690
    notification_emails:
      - fenix-core@mozilla.com
691
    expires: "2021-08-01"
692
693
694
  has_top_sites:
    type: boolean
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
695
    description: |
696
697
698
699
700
701
702
      A boolean that indicates if the user has top sites
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/8125
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9556
703
704
    data_sensitivity:
      - interaction
705
706
    notification_emails:
      - fenix-core@mozilla.com
707
    expires: "2021-08-01"
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
  recently_used_pwa_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many PWAs a user has recently used.
      Threshold for "recency" set in HomeActivity#PWA_RECENTLY_USED_THRESHOLD.
      Currently we are not told by the OS when a PWA is removed by the user,
      so we use the "recently used" heuristic to judge how many PWAs are still
      active, as a proxy for "installed". This value will only be set if the
      user has at least *one* recently used PWA. If they have 0, this metric
      will not be sent, resulting in a null value during analysis on the
      server-side. To disambiguate between a failed `recently_used_pwa_count`
      metric and 0 recent PWAs, please see `has_recent_pwas`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11909
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11982#pullrequestreview-437963817
727
728
    data_sensitivity:
      - interaction
729
730
    notification_emails:
      - fenix-core@mozilla.com
731
    expires: "2021-08-01"
732
733
734
735
736
737
738
739
740
741
742
743
  has_recent_pwas:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has recently used PWAs.
      See recently_used_pwa_count for the actual count.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11909
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11982#pullrequestreview-437963817
744
745
    data_sensitivity:
      - interaction
746
747
    notification_emails:
      - fenix-core@mozilla.com
748
    expires: "2021-08-01"
Jeff Boek's avatar
Jeff Boek committed
749
750
  search_count:
    type: labeled_counter
Michael Droettboom's avatar
Michael Droettboom committed
751
    description: |
752
      The labels for this counter are `<search-engine-name>.<source>`.
Jeff Boek's avatar
Jeff Boek committed
753

Michael Droettboom's avatar
Michael Droettboom committed
754
755
756
757
      If the search engine is bundled with Fenix `search-engine-name` will be
      the name of the search engine. If it's a custom search engine (defined:
      https://github.com/mozilla-mobile/fenix/issues/1607) the value will be
      `custom`.
Jeff Boek's avatar
Jeff Boek committed
758

Michael Droettboom's avatar
Michael Droettboom committed
759
760
761
      `source` will be: `action`, `suggestion`, `widget` or `shortcut`
      (depending on the source from which the search started). Also added the
      `other` option for the source but it should never enter on this case.
Jeff Boek's avatar
Jeff Boek committed
762
    send_in_pings:
Michael Droettboom's avatar
Michael Droettboom committed
763
      - metrics
Jeff Boek's avatar
Jeff Boek committed
764
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
765
766
      - https://github.com/mozilla-mobile/fenix/issues/1158
      - https://github.com/mozilla-mobile/fenix/issues/6556
Jeff Boek's avatar
Jeff Boek committed
767
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
768
769
770
      - https://github.com/mozilla-mobile/fenix/pull/1677
      - https://github.com/mozilla-mobile/fenix/pull/5216
      - https://github.com/mozilla-mobile/fenix/pull/7310
771
772
773
    data_sensitivity:
      - technical
      - interaction
Jeff Boek's avatar
Jeff Boek committed
774
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
775
      - fenix-core@mozilla.com
776
    expires: "2021-08-01"
777
778
  mozilla_products:
    type: string_list
Jeff Boek's avatar
Jeff Boek committed
779
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
780
781
782
783
784
    description: |
      A list of all the Mozilla products installed on device. We currently scan
      for: Firefox, Firefox Beta, Firefox Aurora, Firefox Nightly, Firefox
      Fdroid, Firefox Lite, Reference Browser, Reference Browser Debug, Fenix,
      Focus, and Lockwise.
785
    send_in_pings:
Michael Droettboom's avatar
Michael Droettboom committed
786
      - metrics
787
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
788
      - https://github.com/mozilla-mobile/fenix/issues/1192
789
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
790
791
      - https://github.com/mozilla-mobile/fenix/pull/1953/
      - https://github.com/mozilla-mobile/fenix/pull/5216
792
793
794
    data_sensitivity:
      - technical
      - interaction
795
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
796
      - fenix-core@mozilla.com
797
    expires: "2021-08-01"
798
799
  default_moz_browser:
    type: string
Jeff Boek's avatar
Jeff Boek committed
800
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
801
802
803
    description: |
      The name of the default browser on device if and only if it's a Mozilla
      owned product
804
    send_in_pings:
Michael Droettboom's avatar
Michael Droettboom committed
805
      - metrics
806
    bugs:
Michael Droettboom's avatar
Michael Droettboom committed
807
      - https://github.com/mozilla-mobile/fenix/issues/1192
808
    data_reviews:
Michael Droettboom's avatar
Michael Droettboom committed
809
810
      - https://github.com/mozilla-mobile/fenix/pull/1953/
      - https://github.com/mozilla-mobile/fenix/pull/5216
811
812
813
    data_sensitivity:
      - technical
      - interaction
814
    notification_emails:
Michael Droettboom's avatar
Michael Droettboom committed
815
      - fenix-core@mozilla.com
816
    expires: "2021-08-01"
817
818
819
  adjust_campaign:
    type: string
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
820
821
822
823
    description: |
      A string containing the Adjust campaign ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
824
825
826
    send_in_pings:
      - metrics
    bugs:
827
      - https://github.com/mozilla-mobile/fenix/issues/1298
828
      - https://github.com/mozilla-mobile/fenix/issues/9136
829
830
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/5579
831
832
    data_sensitivity:
      - technical
833
834
    notification_emails:
      - fenix-core@mozilla.com
835
    expires: "2021-08-01"
836
837
838
  adjust_ad_group:
    type: string
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
839
840
841
842
    description: |
      A string containing the Adjust ad group ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
843
844
845
846
847
848
849
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
850
851
    data_sensitivity:
      - interaction
852
853
    notification_emails:
      - fenix-core@mozilla.com
854
    expires: "2021-08-01"
855
856
857
  adjust_creative:
    type: string
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
858
859
860
861
    description: |
      A string containing the Adjust creative ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
862
863
864
865
866
867
868
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
869
870
    data_sensitivity:
      - interaction
871
872
    notification_emails:
      - fenix-core@mozilla.com
873
    expires: "2021-08-01"
874
875
876
  adjust_network:
    type: string
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
877
878
879
880
    description: |
      A string containing the Adjust network ID from which the user installed
      Fenix. This will not send on the first session the user runs. If the
      install is organic, this will be empty.
881
882
883
884
885
886
887
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/1298
      - https://github.com/mozilla-mobile/fenix/issues/9136
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/9253
888
889
    data_sensitivity:
      - interaction
890
891
    notification_emails:
      - fenix-core@mozilla.com
892
    expires: "2021-08-01"
893
894
895
  toolbar_position:
    type: string
    lifetime: application
Michael Droettboom's avatar
Michael Droettboom committed
896
    description: |
897
898
899
900
901
902
903
      A string that indicates the new position of the toolbar TOP or BOTTOM
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/6054
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/6608
904
905
    data_sensitivity:
      - interaction
906
907
    notification_emails:
      - fenix-core@mozilla.com
908
    expires: "2021-08-01"
909
910
911
912
913
914
915
916
917
918
919
  search_widget_installed:
    type: boolean
    lifetime: application
    description: |
      Whether or not the search widget is installed
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/9488
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/10958
920
921
    data_sensitivity:
      - interaction
922
923
    notification_emails:
      - fenix-core@mozilla.com
924
    expires: "2021-08-01"
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
  tabs_open_count:
    type: counter
    lifetime: application
    description: |
      A counter that indicates how many NORMAL tabs a user has open. This
      value will only be set if the user has at least *one* open tab. If they
      have 0, this ping will not get sent, resulting in a null value. To
      disambiguate between a failed `tabs_open_count` ping and 0 open tabs,
      please see `has_open_tabs`.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11479
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12024
940
941
    data_sensitivity:
      - interaction
942
943
    notification_emails:
      - fenix-core@mozilla.com
944
    expires: "2021-08-01"
945
946
947
948
949
950
951
952
953
954
955
  has_open_tabs:
    type: boolean
    lifetime: application
    description: |
      A boolean that indicates if the user has any open NORMAL tabs.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11479
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/12024
956
957
    data_sensitivity:
      - interaction
958
959
    notification_emails:
      - fenix-core@mozilla.com
960
    expires: "2021-08-01"
961

962
963
964
965
966
967
968
969
970
971
972
973
preferences:
  show_search_suggestions:
    type: string_list
    description: >
      Whether or not the user has search suggestions enabled
      default: true
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
974
975
    data_sensitivity:
      - interaction
976
977
    notification_emails:
      - fenix-core@mozilla.com
978
    expires: "2021-08-01"
979
980
981
982
983
984
985
986
987
988
989
  remote_debugging:
    type: string_list
    description: >
      Whether or not the user has remote debugging enabled
      default: false
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/11118
    data_reviews:
      - https://github.com/mozilla-mobile/fenix/pull/11211
990
991
    data_sensitivity:
      - interaction
992
993
    notification_emails:
      - fenix-core@mozilla.com
994
    expires: "2021-08-01"
995
996
997
998
999
1000
  telemetry:
    type: string_list
    description: >
      Whether or not the user has telemetry enabled. Note we should
      never receive a "false" value for this since telemetry would
      not send in that case.
For faster browsing, not all history is shown. View entire blame