summaryrefslogtreecommitdiffstats
path: root/mobile/android/focus-android/app/metrics.yaml
blob: e0fecc694ee604ec1bf436743ba7dce19bdaabe2 (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
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
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
# 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/.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

no_lint:
  - CATEGORY_GENERIC
  - COMMON_PREFIX

browser:
  is_default:
    type: boolean
    lifetime: application
    description: |
      Is Focus the default browser? This is true only if the user
      changes the default browser through the app settings.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/4545
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5065#issuecomment-894328647
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  default_search_engine:
    type: string
    lifetime: application
    description: |
      A string containing the default search engine name.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/4545
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5065#issuecomment-894328647
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    send_in_pings:
      - baseline
      - metrics
    no_lint:
      - BASELINE_PING
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  locale_override:
    type: string
    lifetime: application
    description: |
      The locale that differs from the system locale if a user
      specifically overrides it for the app.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/4545
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5065#issuecomment-894328647
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  total_uri_count:
    type: counter
    description: |
      Records count of URIs visited by the user in the current session,
      including page reloads.
      It does not include background page requests and URIs from embedded pages
      but may be incremented without user interaction by website scripts
      that programmatically redirect to a new location.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5518
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5523
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - mcarare@mozilla.com
    send_in_pings:
      - metrics
      - baseline
    no_lint:
      - BASELINE_PING
    expires: never
  install_source:
    type: string
    lifetime: application
    description: Used to identify the source the app was installed from.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5684
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5694
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  back_button_pressed:
    type: event
    description: Back button has been presed on a browser tab.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5914
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5913
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      action_performed:
        description: |
          The action performed by pressing back button:
          erase_to_home or erase_to_external_app.
        type: string
  report_site_issue_counter:
    type: counter
    description: |
      A counter that indicates how many times a user has tapped
      the report site issue from browser menu
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5897
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5898
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

perf.startup:
  startup_type:
    type: labeled_counter
    description: |
      Indicates how the browser was started. The label is divided into two
      variables. `state` is how cached the browser is when started. `path` is
      what code path we are expected to take. Together, they create a combined
      label: `state_path`. For brevity, the specific states are documented in
      the [Fenix perf
      glossary](https://wiki.mozilla.org/index.php?title=Performance/Fenix/Glossary).
      <br><br>
      This implementation is intended to be simple, not comprehensive. We list
      the implications below.

      <br><br>
      These ways of opening the app undesirably adds events to our primary
      buckets (non-`unknown` cases):
      <br>- App switcher cold/warm: `cold/warm_` + duplicates path from
      previous launch
      <br>- An Intent is sent internally that's uses `ACTION_MAIN` or
      `ACTION_VIEW` could be: `*_main/view` (unknown if this ever happens)
      <br>- A command-line launch uses `ACTION_MAIN` or `ACTION_VIEW` could be:
      `*_main/view`

      <br><br>
      These ways of opening the app undesirably do not add their events to our
      primary buckets:
      <br>- Close and reopen the app very quickly: no event is recorded.

      <br><br>
      These ways of opening the app don't affect our primary buckets:
      <br>- App switcher hot: `hot_unknown`
      <br>- PWA (all states): `unknown_unknown`
      <br>- Custom tab: `unknown_view`
      <br>- Cold start where a service or other non-activity starts the process
      (not manually tested) - this seems to happen if you have the homescreen
      widget: `unknown_*`
      <br>- Another activity is drawn before MainActivity or CustomTabActivity
      (e.g. widget voice
      search): `unknown_*`

      <br>
      In addition to the events above, the `unknown` state may be chosen when we
      were unable to determine a cause due to implementation details or the API
      was used incorrectly. We may be able to record the events listed above
      into different buckets but we kept the implementation simple for now.
      <br><br>
      N.B.: for implementation simplicity, we duplicate the logic in app that
      determines `path` so it's not perfectly accurate. In one way, we record we
      is intended to happen rather than what actually happened (e.g. the user
      may click a link so we record VIEW but the app does a MAIN by going to the
      homescreen because the link was invalid).
    labels:
      - cold_main
      - cold_view
      - cold_unknown
      - warm_main
      - warm_view
      - warm_unknown
      - hot_main
      - hot_view
      - hot_unknown
      - unknown_main
      - unknown_view
      - unknown_unknown
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7079
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/
    data_sensitivity:
      - interaction
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - mleclair@mozilla.com
    expires: never

activation:
  activation_id:
    type: uuid
    lifetime: user
    description: |
      An alternate identifier, not correlated with the client_id, generated once
      and only sent with the activation ping.
    send_in_pings:
      - activation
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/4545
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/issues/4901
    data_sensitivity:
      - highly_sensitive
    notification_emails:
      - android-probes@mozilla.com
      - jalmeida@mozilla.com
    expires: never

legacy_ids:
  client_id:
    type: uuid
    description: |
      Sets the legacy client ID as part of the deletion-request ping.
      **No longer reported set since Focus 124, where legacy telemetry was removed**.
    send_in_pings:
      - deletion-request
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/4545
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805256
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5512#issuecomment-1023668181
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1805256
    notification_emails:
      - jalmeida@mozilla.com
      - android-probes@mozilla.com
      - tlong@mozilla.com
    expires: never

browser.search:
  with_ads:
    type: labeled_counter
    description: |
      Records counts of SERP pages with adverts displayed.
      The key format is
      `<provider-name>.in-content.[sap|sap-follow-on|organic].[code|none](.[channel])?`,
      where:

      * `provider-name` is the name of the provider,
      * `sap|sap-follow-on|organic` is the search access point,
      * `code` is set when the url matches any of the provider's code prefixes,
      * `channel` is set to the url "channel" query parameter.
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4967
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1804057
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1799049
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1809447
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/4968#issuecomment-879256443
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/focus-android/pull/8109#issuecomment-1337394286
      - https://github.com/mozilla-mobile/firefox-android/pull/523#issuecomment-1377494482
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  ad_clicks:
    type: labeled_counter
    description: |
      Records clicks of adverts on SERP pages.
      The key format is
      `<provider-name>.in-content.[sap|sap-follow-on|organic].[code|none](.[channel])?`,
      where:

      * `provider-name` is the name of the provider,
      * `sap|sap-follow-on|organic` is the search access point,
      * `code` is set when the url matches any of the provider's code prefixes,
      * `channel` is set to the url "channel" query parameter.
    send_in_pings:
      - metrics
      - baseline
    no_lint:
      - BASELINE_PING
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4967
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1804057
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1809447
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/4968#issuecomment-879256443
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/focus-android/pull/8109#issuecomment-1337394286
      - https://github.com/mozilla-mobile/firefox-android/pull/523#issuecomment-1377494482
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  in_content:
    type: labeled_counter
    description: |
      Records the type of interaction a user has on SERP pages.
    send_in_pings:
      - metrics
      - baseline
    no_lint:
      - BASELINE_PING
    bugs:
      - https://github.com/mozilla-mobile/fenix/issues/4967
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1809447
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/4968#issuecomment-879256443
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/523#issuecomment-1377494482
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

  search_count:
    type: labeled_counter
    description: |
      The labels for this counter are `<search-engine-name>.<source>`.

      If the search engine is bundled with Focus `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`.

      `source` will be: `action`, `suggestion`
    send_in_pings:
      - metrics
      - baseline
    no_lint:
      - BASELINE_PING
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/6229
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/6238
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

mozilla_products:
  has_fenix_installed:
    type: boolean
    lifetime: application
    description: |
       If Fenix is installed on the users's device.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5295
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5303
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  is_fenix_default_browser:
    type: boolean
    lifetime: application
    description: |
      Fenix is the default browser on user's device
    send_in_pings:
      - metrics
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5295
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5303
      - https://github.com/mozilla-mobile/focus-android/pull/6315
      - https://github.com/mozilla-mobile/firefox-android/pull/632
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

autocomplete:
  domain_added:
    type: counter
    description: |
      A counter that indicates how many times a user has added
      a website to the autocomplete list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5885
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5886
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  domain_removed:
    type: counter
    description: |
      A counter that indicates how many times a user has removed
      a website from the autocomplete list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5885
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5886
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  list_order_changed:
    type: counter
    description: |
      A counter that indicates how many times a user has reordered
      the autocomplete list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5885
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5886
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  top_sites_setting_changed:
    type: event
    description: |
      Autocomplete setting for top sites has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5885
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  favorite_sites_setting_changed:
    type: event
    description: |
      Autocomplete setting for favorite sites has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5885
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean

shortcuts:
  shortcuts_on_home_number:
    type: quantity
    description: |
      The number of shortcuts the user has on home screen,
      0, 1, 2, 3 or 4 (maximum)
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5056
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5189
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    unit: shortcut(s)
  shortcut_opened_counter:
    type: counter
    description: |
      A counter that indicates how many times a user has opened
      a website from a shortcut in the home screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5056
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5189
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  shortcut_added_counter:
    type: counter
    description: |
      A counter that indicates how many times a user has added
      a website to shortcuts.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5056
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5189
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  shortcut_removed_counter:
    type: labeled_counter
    description: |
      A counter that indicates how many times a user has removed
      a website from shortcuts.
      It also indicates the screen it was removed from, home or browser.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5056
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5189
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    labels:
      - removed_from_browser_menu
      - removed_from_home_screen
tracking_protection:
  toolbar_shield_clicked:
    type: counter
    description: |
      A counter that indicates how many times a user has opened
      the tracking protection settings panel from the toolbar.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

  tracking_protection_changed:
    type: event
    description: |
      The user has changed the setting for enhanced tracking protection.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting for ETP, true for ON, false for OFF
        type: boolean

  has_ever_changed_etp:
    type: boolean
    description: |
      The user has changed the setting for enhanced tracking protection
      at least once.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/5543
    data_sensitivity:
      - interaction
    lifetime: user
    notification_emails:
      - android-probes@mozilla.com
      - mcarare@mozilla.com
    expires: never

  tracker_setting_changed:
    type: event
    description: |
      The user has changed the advertising tracker protection state.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    extra_keys:
      source_of_change:
        description: The source of interaction, "Panel" or "Settings"
        type: string
      tracker_changed:
        description: |
          The tracker changed, "Advertising", "Analytics", "Social", "Content"
        type: string
      is_enabled:
        description: The new setting for tracker, true for ON, false for OFF
        type: boolean

  has_social_blocked:
    type: boolean
    description: |
      The user has changed the setting for enhanced tracking protection
      at least once.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

  has_advertising_blocked:
    type: boolean
    description: |
      The user has changed the setting for enhanced tracking protection
      at least once.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

  has_analytics_blocked:
    type: boolean
    description: |
      The user has changed the setting for enhanced tracking protection
      at least once.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

  has_content_blocked:
    type: boolean
    description: |
      The user has changed the setting for enhanced tracking protection
      at least once.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5057
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5163
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
pro_tips:
  tip_displayed:
    type: event
    description: A pro tip has been displayed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5541
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5542
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      tip_id:
        description: |
          The tip code of tip being displayed. Can be one of fresh_look_tip,
          shortcuts_tip, allow_list_tip, etp_tip,request_desktop_tip.
          Note that fresh_look_tip is automatically displayed on home screen.
        type: string
  link_in_tip_clicked:
    type: event
    description: A link in a pro tip has been clicked.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5541
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5542
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      tip_id:
        description: |
          The tip code of tip being clicked.
          Can be one of fresh_look_tip, allow_list_tip, request_desktop_tip.
        type: string

preferences:
  user_theme:
    type: string
    description: >
      A string that indicates the theme.
      Can be one of LIGHT, DARK, or FOLLOW DEVICE.
      Default is FOLLOW DEVICE.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5519
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5526
      - https://github.com/mozilla-mobile/focus-android/pull/7418#issuecomment-1195518264
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never

app_opened:
  from_icons:
    type: event
    description: |
      The user has opened the app using launcher icons
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5546
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5552
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      open_type:
        description: |
          Can be "Launch" if Focus was not already opened or "Resume" if it was.
        type: string
  from_launcher_site_shortcut:
    type: event
    description: |
      The user has opened the app using launcher website shortcut
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5547
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5839
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  browse_intent:
    type: event
    description: |
      App was opened from a browse intent.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5547
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5839
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  text_selection_intent:
    type: event
    description: |
      App was opened from a text selection intent.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5547
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5839
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  share_intent:
    type: event
    description: |
      App was opened from a share intent.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5547
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5839
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_search:
        description: Is the shared intent a search?
        type: boolean


add_to_home_screen:
  dialog_displayed:
    type: event
    description: The dialog for adding home screen shorcut was displayed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5548
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5598
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  add_button_tapped:
    type: event
    description: The add(yes) option from add to home dialog was tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5548
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5598
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      has_edited_title:
        description: Did the user edit the default title provided by the app?
        type: boolean
  cancel_button_tapped:
    type: event
    description: The cancel(no) option from add to home dialog was tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5548
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5598
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
set_default_browser:
  from_app_settings:
    type: event
    description: |
      The user has changed default browser from the app.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5636
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5637
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_default:
        description: Shows if Focus was already default.
        type: boolean
  from_os_settings:
    type: event
    description: |
      The user has opened the OS settings to set default browser.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5636
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5637
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_default:
        description: Shows if Focus was already default.
        type: boolean
  learn_more_opened:
    type: event
    description: |
      The user has opened the learn more link.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5636
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5637
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_default:
        description: Shows if Focus was already default.
        type: boolean

tab_count:
  session_button_tapped:
    type: event
    description: The session button has been tapped to see session list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5644
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  session_list_item_tapped:
    type: event
    description: The user has switched to a tab from the session list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5644
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  session_list_closed:
    type: event
    description: The user has closed the session list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5644
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  erase_button_tapped:
    type: event
    description: The erease button has been tapped to close opened sessions.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5644
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  new_tab_opened:
    type: event
    description: A new tab has opened.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5644
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
      source:
        description: |
          Tab opened from "custom tab", "context menu" or from "Window.open()"
        type: string
  app_backgrounded:
    type: custom_distribution
    description: Number of opened tabs when the app has been send to background.
    range_min: 0
    range_max: 50
    bucket_count: 51
    histogram_type: linear
    unit: tabs
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5583
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5793
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

search_bar:
  entered_url:
    type: event
    description: The user has entered a full url.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5546
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5660
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  performed_search:
    type: event
    description: The user has entered text and performed a search.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5546
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5660
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      engine_name:
        description: The name of the engine used to perform the search.
        type: string

show_search_suggestions:
  enabled_from_panel:
    type: event
    description: The "yes" option from the suggestion panel has been tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5840
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5858
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  disabled_from_panel:
    type: event
    description: The "no"" option from the suggestion panel has been tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5840
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5858
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  changed_from_settings:
    type: event
    description: The enabled state has been changed from the settings screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5840
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5858
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting value, true for ON, false for OFF
        type: boolean

downloads:
  download_started:
    type: event
    description: A download has been started.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  download_paused:
    type: event
    description: A download has been paused.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  download_canceled:
    type: event
    description: A download has been cancelled.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  download_completed:
    type: event
    description: A download has been completed successfully.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  download_failed:
    type: event
    description: The download has failed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      file_extension:
        description: The extension of the downloaded file.
        type: string
  open_button_tapped:
    type: event
    description: The open button from download confirmation was tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5650
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5663
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      open_successful:
        description: Did the user succeed in opening the downloaded file?
        type: boolean
      file_extension:
        description: The extension of the downloaded file.
        type: string

search_engines:
  open_settings:
    type: event
    description: The user has opened the search engines settings page.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  add_engine_tapped:
    type: event
    description: The user has tapped on the add another search engine button.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  save_engine_tapped:
    type: event
    description: The user has tried to save a custom engine.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      save_successful:
        description: If the engine has been saved successfully.
        type: boolean
  set_default:
    type: event
    description: The user has set a search engine as default.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      engine_type:
        description: |
          The engine type set as default. Can be either "custom" or "bundled".
        type: string
  remove_engines:
    type: event
    description: The user has removed search engines.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      engine_count:
        description: How many search engines has the user removed
        type: quantity
  open_remove_screen:
    type: event
    description: The user has clicked the remove option from menu.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_engines_count:
        description: How many search engines did the user had at that point.
        type: quantity
  restore_default_engines:
    type: event
    description: The user has restored the default search engines
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_engines_count:
        description: How many search engines did the user had at that point.
        type: quantity
  learn_more_tapped:
    type: event
    description: The learn more button was tapped.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5646
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5713
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

open_with:
  list_displayed:
    type: event
    description: The list of apps has been opened.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5654
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5703
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      list_size:
        description: The number of apps in the list
        type: quantity
  list_item_tapped:
    type: event
    description: The uer has opened the url with a app from the list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5654
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5703
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      package_name:
        description: The app the user has chosen is a Mozilla product.
        type: boolean
  install_firefox:
    type: event
    description: The user has clicked install Firefox from store item.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5654
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5703
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

crash_reporter:
  displayed:
    type: event
    description: The crash report has been displayed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5652
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5725
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  close_report:
    type: event
    description: The crash report has been submitted.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5652
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5725
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      submit_report:
        description: Did the user choose to send the report?
        type: boolean

browser_menu:
  navigation_toolbar_action:
    type: event
    description: The user has tapped on a navigation toolbar item.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5648
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped:
          back, forward, share, reload, stop
        type: string
  browser_menu_action:
    type: event
    description: The user has tapped on a browser menu item.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5648
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped:
          add_to_homescreen, desktop_view_off, desktop_view_on,
          find_in_page, open_in_app, settings
        type: string

custom_tabs_toolbar:
  navigation_toolbar_action:
    type: event
    description: The user tapped on a navigation toolbar item in a custom tab.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5649
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped:
          back, forward, reload, stop
        type: string
  browser_menu_action:
    type: event
    description: The user tapped on a browser menu item item in a custom tab.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5649
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      item:
        description: |
          A string containing the name of the item the user tapped:
          desktop_view_off, desktop_view_on, find_in_page, open_in_app,
          add_to_homescreen, open_in browser
        type: string
  close_tab_tapped:
    type: event
    description: The user has closed a custom tab.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5649
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  action_button_tapped:
    type: event
    description: The user has tapped the actionbutton a custom tab.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5649
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5748
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

tracking_protection_exceptions:
  allow_list_opened:
    type: event
    description: The user has opened the exceptions list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5753
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5758
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  allow_list_cleared:
    type: event
    description: The user has removed all items from exceptions list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5753
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5758
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      list_size:
        description: The number of exceptions in the list.
        type: quantity
  selected_items_removed:
    type: event
    description: The user has removed the selected items from exceptions list.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5753
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5758
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      list_size:
        description: The number of selected items removed.
        type: quantity

notifications:
  open_button_tapped:
    type: event
    description: The user has tapped the Open option button from notification.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  erase_open_button_tapped:
    type: event
    description: The user has tapped the Erase & Open button from notification.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  notification_tapped:
    type: event
    description: The user has tapped the notification to close the app.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
  permission_granted:
    type: boolean
    description: |
      True if notifications are allowed from OS settings, otherwise false.
      Prior to Android 13, notifications were allowed by default;
      starting with Android 13,the user must explicitly grant the permission.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1803358
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/475
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - technical
    notification_emails:
      - android-probes@mozilla.com
    expires: never

app_shortcuts:
  just_erase_button_tapped:
    type: event
    description: The user has tapped the Erase option button from shortcuts.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity
  erase_open_button_tapped:
    type: event
    description: The user has tapped the Erase & Open button from shortcuts.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      opened_tabs:
        description: Number of currently opened tabs
        type: quantity

recent_apps:
  app_removed_from_list:
    type: event
    description: The user removed the apps from recent apps screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5651
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5769
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

context_menu:
  item_tapped:
    type: event
    description: The user has tapped an option from context menu.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5647
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5773
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      item_name:
        description: |
          The name of the item that was tapped. One of the following:
          open_in_new_tab, open_in_private_tab, open_image_in_new_tab,
          save_image, share_link, copy_link, copy_image_location, share_image
        type: string

onboarding:
  first_screen_close_button:
    type: event
    description: The user has tapped on close button from the first screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7500
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7566#issuecomment-1235551604
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  get_started_button:
    type: event
    description: The user has tapped on get started button.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7500
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7566#issuecomment-1235551604
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  default_browser_button:
    type: event
    description: The user has tapped on set as default browser button.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7500
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7566#issuecomment-1235551604
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  skip_button:
    type: event
    description: The user has tapped on skip button.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7500
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7566#issuecomment-1235551604
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  second_screen_close_button:
    type: event
    description: The user has tapped on close button from the second screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7500
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7566#issuecomment-1235551604
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
  page_displayed:
    type: event
    description: A page from onboarding has been displayed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5635
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5869
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_item:
        description: The curent displayed item position.
        type: quantity
  skip_button_tapped:
    type: event
    description: The user has tapped to skip onboarding.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5635
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5869
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_item:
        description: The curent displayed item position.
        type: quantity
  finish_button_tapped:
    type: event
    description: The user has tapped to finish onboarding.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5635
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5869
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_item:
        description: The curent displayed item position.
        type: quantity
  next_button_tapped:
    type: event
    description: The user has tapped next onboarding.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5635
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5869
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      current_item:
        description: The curent displayed item position.
        type: quantity

search_suggestions:
  suggestion_tapped:
    type: event
    description: Search suggestion selected.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5662
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5864
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      engine_name:
        description: The name of the engine used to perform the search.
        type: string
  search_tapped:
    type: event
    description: The typed text search was selected.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5662
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5864
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      engine_name:
        description: The name of the engine used to perform the search.
        type: string
  autocomplete_arrow_tapped:
    type: event
    description: Search suggestion selected.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5662
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5864
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never

advanced_settings:
  remote_debug_setting_changed:
    type: event
    description: |
      Remote debugging setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  open_links_setting_changed:
    type: event
    description: |
      Open links setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
privacy_settings:
  telemetry_setting_changed:
    type: event
    description: |
      Telemetry setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  safe_browsing_setting_changed:
    type: event
    description: |
      Safe browsing setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  unlock_setting_changed:
    type: event
    description: |
      Biometric unlock setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  stealth_setting_changed:
    type: event
    description: |
      Stealth setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/5653
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/5940
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: The new setting true for ON, false for OFF
        type: boolean
  block_cookies_changed:
    type: event
    description: |
      Block cookies setting has changed.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/6097
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/6105
      - https://github.com/mozilla-mobile/focus-android/pull/7906
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
      - rtestard@mozilla.com
    expires: never
    extra_keys:
      is_enabled:
        description: |
          A string containing the new block cookies option the user has chosen:
          yes, third_party_only, third_party_tracker, cross_site, no
        type: string

metrics:
  start_reason_process_error:
    type: boolean
    description: |
      The `AppStartReasonProvider.ProcessLifecycleObserver.onCreate` was
      unexpectedly called twice. We can use this metric to validate our
      assumptions about how these APIs are called. This probe can be removed
      once we validate these assumptions.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7079
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/
    data_sensitivity:
      - technical
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - mleclair@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  start_reason_activity_error:
    type: boolean
    description: |
      The `AppStartReasonProvider.ActivityLifecycleCallbacks.onActivityCreated`
      was unexpectedly called twice. We can use this metric to validate our
      assumptions about how these APIs are called. This probe can be removed
      once we validate these assumptions.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7079
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/
    data_sensitivity:
      - technical
    notification_emails:
      - perf-telemetry-alerts@mozilla.com
      - mleclair@mozilla.com
    expires: never
    metadata:
      tags:
        - Performance
  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/focus-android/issues/
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7474
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search

search_widget:
  new_tab_button:
    type: event
    description: |
      A user pressed anywhere from the Focus logo until the start of the
      microphone icon, opening a new tab search screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7474
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  voice_button:
    type: event
    description: |
      A user pressed the microphone icon, opening a new voice search screen.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7474
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  promote_dialog_shown:
    type: event
    description: |
      Promote search widget dialog is shown to the user.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7506
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7657#issuecomment-1252242947
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
      - https://github.com/mozilla-mobile/firefox-android/pull/4040
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  add_to_home_screen_button:
    type: event
    description: |
      The user has pressed on add search widget
      to home screen button from promote dialog.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7506
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7657#issuecomment-1252242947
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
  widget_was_added:
    type: event
    description: |
      The user has added successfully the search widget from
      promote search widget dialog.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7506
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/7657#issuecomment-1252242947
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Search
cookie_banner:
  visited_setting:
    type: event
    description: A user visited the cookie banner handling screen
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7965
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/8008#issuecomment-1322266028
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  setting_changed:
    type: event
    description: |
      A user changed their setting.
    extra_keys:
      cookie_banner_setting:
        description: |
          The new setting for cookie banner handling: disabled,reject_all,
          or reject_or_accept_all.
        type: string
    bugs:
      - https://github.com/mozilla-mobile/focus-android/issues/7965
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/8008#issuecomment-1322266028
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  cookie_banner_cfr_shown:
    type: event
    description: |
      Cfr for cookie banner is shown to the user.
    bugs:
      - https://github.com/mozilla-mobile/focus-android/
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  exception_added:
    type: event
    description: |
      A user added a cookie banner handling exception through
      the toggle in the protections panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797578
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/8124#issuecomment-1344449866
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  report_site_domain:
    type: url
    description: |
      A user can report a site domain(Ex. for https://edition.cnn.com/
      site domain will be cnn.com) when the cookie banner reducer is not
      working from the cookie banner details panel.
    lifetime: ping
    send_in_pings:
      - cookie-banner-report-site
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1803589
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/389#pullrequestreview-1341440145
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - technical
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  report_site_cancel_button:
    type: event
    description: |
      The user has pressed the report site domain cancel button
      from the cookie banner reducer details panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1803589
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/389#pullrequestreview-1341440145
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  report_domain_site_button:
    type: event
    description: |
      The user has pressed the report site domain button
      from the cookie banner reducer details panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1803589
    data_reviews:
      - https://github.com/mozilla-mobile/firefox-android/pull/389#pullrequestreview-1341440145
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  exception_removed:
    type: event
    description: |
      A user removed a cookie banner handling
      exception through the toggle in the protections panel.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797578
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/8124#issuecomment-1344449866
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security

  visited_panel:
    type: event
    description: A user visited the cookie banner exception panel
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797578
    data_reviews:
      - https://github.com/mozilla-mobile/focus-android/pull/8124#issuecomment-1344449866
      - https://github.com/mozilla-mobile/firefox-android/pull/3320
    data_sensitivity:
      - interaction
    notification_emails:
      - android-probes@mozilla.com
    expires: never
    metadata:
      tags:
        - Privacy&Security