summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/fhr/dataformat.rst
blob: b067f9d0c74d3b7d28952eca299d0bb47207aeb7 (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
.. _healthreport_dataformat:

==============
Payload Format
==============

Currently, the Firefox Health Report is submitted as a compressed JSON
document. The root JSON element is an object. A *version* field defines
the version of the payload which in turn defines the expected contents
the object.

As of 2013-07-03, desktop submits Version 2, and Firefox for Android submits
Version 3 payloads.

Version 3
=========

Version 3 is a complete rebuild of the document format. Events are tracked in
an "environment". Environments are computed from a large swath of local data
(e.g., add-ons, CPU count, versions), and a new environment comes into being
when one of its attributes changes.

Client documents, then, will include descriptions of many environments, and
measurements will be attributed to one particular environment.

A map of environments is present at the top level of the document, with the
current named "current" in the map. Each environment has a hash identifier and
a set of attributes. The current environment is completely described, and has
its hash present in a "hash" attribute. All other environments are represented
as a tree diff from the current environment, with their hash as the key in the
"environments" object.

A removed add-on has the value 'null'.

There is no "last" data at present.

Daily data is hierarchical: by day, then by environment, and then by
measurement, and is present in "data", just as in v2.

Leading by example::

    {
      "lastPingDate": "2013-06-29",
      "thisPingDate": "2013-07-03",
      "version": 3,
      "environments": {
        "current": {
          "org.mozilla.sysinfo.sysinfo": {
            "memoryMB": 1567,
            "cpuCount": 4,
            "architecture": "armeabi-v7a",
            "_v": 1,
            "version": "4.1.2",
            "name": "Android"
          },
          "org.mozilla.profile.age": {
            "_v": 1,
            "profileCreation": 15827
          },
          "org.mozilla.addons.active": {
            "QuitNow@TWiGSoftware.com": {
              "appDisabled": false,
              "userDisabled": false,
              "scope": 1,
              "updateDay": 15885,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "blocklistState": 0,
              "type": "extension",
              "installDay": 15885,
              "version": "1.18.02"
            },
            "{dbbf9331-b713-6eda-1006-205efead09dc}": {
              "appDisabled": false,
              "userDisabled": "askToActivate",
              "scope": 8,
              "updateDay": 15779,
              "foreignInstall": true,
              "blocklistState": 0,
              "type": "plugin",
              "installDay": 15779,
              "version": "11.1 r115"
            },
            "desktopbydefault@bnicholson.mozilla.org": {
              "appDisabled": false,
              "userDisabled": true,
              "scope": 1,
              "updateDay": 15870,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "blocklistState": 0,
              "type": "extension",
              "installDay": 15870,
              "version": "1.1"
            },
            "{6e092a7f-ba58-4abb-88c1-1a4e50b217e4}": {
              "appDisabled": false,
              "userDisabled": false,
              "scope": 1,
              "updateDay": 15828,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "blocklistState": 0,
              "type": "extension",
              "installDay": 15828,
              "version": "1.1.0"
            },
            "{46551EC9-40F0-4e47-8E18-8E5CF550CFB8}": {
              "appDisabled": false,
              "userDisabled": true,
              "scope": 1,
              "updateDay": 15879,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "blocklistState": 0,
              "type": "extension",
              "installDay": 15879,
              "version": "1.3.2"
            },
            "_v": 1
          },
          "org.mozilla.appInfo.appinfo": {
            "_v": 3,
            "appLocale": "en_us",
            "osLocale": "en_us",
            "distribution": "",
            "acceptLangIsUserSet": 0,
            "isTelemetryEnabled": 1,
            "isBlocklistEnabled": 1
          },
          "geckoAppInfo": {
            "updateChannel": "nightly",
            "id": "{aa3c5121-dab2-40e2-81ca-7ea25febc110}",
            "os": "Android",
            "platformBuildID": "20130703031323",
            "platformVersion": "25.0a1",
            "vendor": "Mozilla",
            "name": "fennec",
            "xpcomabi": "arm-eabi-gcc3",
            "appBuildID": "20130703031323",
            "_v": 1,
            "version": "25.0a1"
          },
          "hash": "tB4Pnnep9yTxnMDymc3dAB2RRB0=",
          "org.mozilla.addons.counts": {
            "extension": 4,
            "plugin": 1,
            "_v": 1,
            "theme": 0
          }
        },
        "k2O3hlreMeS7L1qtxeMsYWxgWWQ=": {
          "geckoAppInfo": {
            "platformBuildID": "20130630031138",
            "appBuildID": "20130630031138",
            "_v": 1
          },
          "org.mozilla.appInfo.appinfo": {
            "_v": 2,
          }
        },
        "1+KN9TutMpzdl4TJEl+aCxK+xcw=": {
          "geckoAppInfo": {
            "platformBuildID": "20130626031100",
            "appBuildID": "20130626031100",
            "_v": 1
          },
          "org.mozilla.addons.active": {
            "QuitNow@TWiGSoftware.com": null,
            "{dbbf9331-b713-6eda-1006-205efead09dc}": null,
            "desktopbydefault@bnicholson.mozilla.org": null,
            "{6e092a7f-ba58-4abb-88c1-1a4e50b217e4}": null,
            "{46551EC9-40F0-4e47-8E18-8E5CF550CFB8}": null,
            "_v": 1
          },
          "org.mozilla.addons.counts": {
            "extension": 0,
            "plugin": 0,
            "_v": 1
          }
        }
      },
      "data": {
        "last": {},
        "days": {
          "2013-07-03": {
            "tB4Pnnep9yTxnMDymc3dAB2RRB0=": {
              "org.mozilla.appSessions": {
                "normal": [
                  {
                    "r": "P",
                    "d": 2,
                    "sj": 653
                  },
                  {
                    "r": "P",
                    "d": 22
                  },
                  {
                    "r": "P",
                    "d": 5
                  },
                  {
                    "r": "P",
                    "d": 0
                  },
                  {
                    "r": "P",
                    "sg": 3560,
                    "d": 171,
                    "sj": 518
                  },
                  {
                    "r": "P",
                    "d": 16
                  },
                  {
                    "r": "P",
                    "d": 1079
                  }
                ],
                "_v": "4"
              }
            },
            "k2O3hlreMeS7L1qtxeMsYWxgWWQ=": {
              "org.mozilla.appSessions": {
                "normal": [
                  {
                    "r": "P",
                    "d": 27
                  },
                  {
                    "r": "P",
                    "d": 19
                  },
                  {
                    "r": "P",
                    "d": 55
                  }
                ],
                "_v": "4"
              },
              "org.mozilla.searches.counts": {
                "bartext": {
                  "google": 1
                },
                "_v": "4"
              },
              "org.mozilla.experiment": {
                "lastActive": "some.experiment.id"
                "_v": "1"
              }
            }
          }
        }
      }
    }

App sessions in Version 3
-------------------------

Sessions are divided into "normal" and "abnormal". Session objects are stored as discrete JSON::

    "org.mozilla.appSessions": {
      _v: 4,
      "normal": [
        {"r":"P", "d": 123},
      ],
      "abnormal": [
        {"r":"A", "oom": true, "stopped": false}
      ]
    }

Keys are:

"r"
    reason. Values are "P" (activity paused), "A" (abnormal termination).
"d"
    duration. Value in seconds.
"sg"
    Gecko startup time (msec). Present if this is a clean launch. This
    corresponds to the telemetry timer *FENNEC_STARTUP_TIME_GECKOREADY*.
"sj"
    Java activity init time (msec). Present if this is a clean launch. This
    corresponds to the telemetry timer *FENNEC_STARTUP_TIME_JAVAUI*,
    and includes initialization tasks beyond initial
    *onWindowFocusChanged*.

Abnormal terminations will be missing a duration and will feature these keys:

"oom"
    was the session killed by an OOM exception?
"stopped"
    was the session stopped gently?

Version 3.2
-----------

As of Firefox 35, the search counts measurement is now bumped to v6, including the *activity* location for the search activity.

Version 3.1
-----------

As of Firefox 27, *appinfo* is now bumped to v3, including *osLocale*,
*appLocale* (currently always the same as *osLocale*), *distribution* (a string
containing the distribution ID and version, separated by a colon), and
*acceptLangIsUserSet*, an integer-boolean that describes whether the user set
an *intl.accept_languages* preference.

The search counts measurement is now at version 5, which indicates that
non-partner searches are recorded. You'll see identifiers like "other-Foo Bar"
rather than "other".


Version 3.2
-----------

In Firefox 32, Firefox for Android includes a device configuration section
in the environment description::

    "org.mozilla.device.config": {
      "hasHardwareKeyboard": false,
      "screenXInMM": 58,
      "screenLayout": 2,
      "uiType": "default",
      "screenYInMM": 103,
      "_v": 1,
      "uiMode": 1
    }

Of these, the only keys that need explanation are:

uiType
    One of "default", "smalltablet", "largetablet".
uiMode
    A mask of the Android *Configuration.uiMode* value, e.g.,
    *UI_MODE_TYPE_CAR*.
screenLayout
    A mask of the Android *Configuration.screenLayout* value. One of the
    *SCREENLAYOUT_SIZE_* constants.

Note that screen dimensions can be incorrect due to device inaccuracies and platform limitations.

Other notable differences from Version 2
----------------------------------------

* There is no default browser indicator on Android.
* Add-ons include a *blocklistState* attribute, as returned by AddonManager.
* Searches are now version 4, and are hierarchical: how the search was started
  (bartext, barkeyword, barsuggest), and then counts per provider.

Version 2
=========

Version 2 is the same as version 1 with the exception that it has an additional
top-level field, *geckoAppInfo*, which contains basic application info.

geckoAppInfo
------------

This field is an object that is a simple map of string keys and values
describing basic application metadata. It is very similar to the *appinfo*
measurement in the *last* section. The difference is this field is almost
certainly guaranteed to exist whereas the one in the data part of the
payload may be omitted in certain scenarios (such as catastrophic client
error).

Its keys are as follows:

appBuildID
    The build ID/date of the application. e.g. "20130314113542".

version
    The value of nsXREAppData.version. This is the application's version. e.g.
    "21.0.0".

vendor
    The value of nsXREAppData.vendor. Can be empty an empty string. For
    official Mozilla builds, this will be "Mozilla".

name
    The value of nsXREAppData.name. For official Firefox builds, this
    will be "Firefox".

id
    The value of nsXREAppData.ID.

platformVersion
    The version of the Gecko platform (as opposed to the app version). For
    Firefox, this is almost certainly equivalent to the *version* field.

platformBuildID
    The build ID/date of the Gecko platfor (as opposed to the app version).
    This is commonly equivalent to *appBuildID*.

os
    The name of the operating system the application is running on.

xpcomabi
    The binary architecture of the build.

updateChannel
    The name of the channel used for application updates. Official Mozilla
    builds have one of the values {release, beta, aurora, nightly}. Local and
    test builds have *default* as the channel.

Version 1
=========

Top-level Properties
--------------------

The main JSON object contains the following properties:

lastPingDate
    UTC date of the last upload. If this is the first upload from this client,
    this will not be present.

thisPingDate
    UTC date when this payload was constructed.

version
    Integer version of this payload format. Currently only 1 is defined.

clientID
    An identifier that identifies the client that is submitting data.

    This property may not be present in older clients.

    See :ref:`healthreport_identifiers` for more info on identifiers.

clientIDVersion
    Integer version associated with the generation semantics for the
    ``clientID``.

    If the value is ``1``, ``clientID`` is a randomly-generated UUID.

    This property may not be present in older clients.

data
    Object holding data constituting health report.

Data Properties
---------------

The bulk of the health report is contained within the *data* object. This
object has the following keys:

days
   Object mapping UTC days to measurements from that day. Keys are in the
   *YYYY-MM-DD* format. e.g. "2013-03-14"

last
   Object mapping measurement names to their values.


The value of *days* and *last* are objects mapping measurement names to that
measurement's values. The values are always objects. Each object contains
a *_v* property. This property defines the version of this measurement.
Additional non-underscore-prefixed properties are defined by the measurement
itself (see sections below).

Example
-------

Here is an example JSON document for version 1::

    {
      "version": 1,
      "thisPingDate": "2013-03-11",
      "lastPingDate": "2013-03-10",
      "data": {
        "last": {
          "org.mozilla.addons.active": {
            "masspasswordreset@johnathan.nightingale": {
              "userDisabled": false,
              "appDisabled": false,
              "version": "1.05",
              "type": "extension",
              "scope": 1,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "installDay": 14973,
              "updateDay": 15317
            },
            "places-maintenance@bonardo.net": {
              "userDisabled": false,
              "appDisabled": false,
              "version": "1.3",
              "type": "extension",
              "scope": 1,
              "foreignInstall": false,
              "hasBinaryComponents": false,
              "installDay": 15268,
              "updateDay": 15379
            },
            "_v": 1
          },
          "org.mozilla.appInfo.appinfo": {
            "_v": 1,
            "appBuildID": "20130309030841",
            "distributionID": "",
            "distributionVersion": "",
            "hotfixVersion": "",
            "id": "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}",
            "locale": "en-US",
            "name": "Firefox",
            "os": "Darwin",
            "platformBuildID": "20130309030841",
            "platformVersion": "22.0a1",
            "updateChannel": "nightly",
            "vendor": "Mozilla",
            "version": "22.0a1",
            "xpcomabi": "x86_64-gcc3"
          },
          "org.mozilla.profile.age": {
            "_v": 1,
            "profileCreation": 12444
          },
          "org.mozilla.appSessions.current": {
            "_v": 3,
            "startDay": 15773,
            "activeTicks": 522,
            "totalTime": 70858,
            "main": 1245,
            "firstPaint": 2695,
            "sessionRestored": 3436
          },
          "org.mozilla.sysinfo.sysinfo": {
            "_v": 1,
            "cpuCount": 8,
            "memoryMB": 16384,
            "architecture": "x86-64",
            "name": "Darwin",
            "version": "12.2.1"
          }
        },
        "days": {
          "2013-03-11": {
            "org.mozilla.addons.counts": {
              "_v": 1,
              "extension": 15,
              "plugin": 12,
              "theme": 1
            },
            "org.mozilla.places.places": {
              "_v": 1,
              "bookmarks": 757,
              "pages": 104858
            },
            "org.mozilla.appInfo.appinfo": {
              "_v": 1,
              "isDefaultBrowser": 1
            }
          },
          "2013-03-10": {
            "org.mozilla.addons.counts": {
              "_v": 1,
              "extension": 15,
              "plugin": 12,
              "theme": 1
            },
            "org.mozilla.places.places": {
              "_v": 1,
              "bookmarks": 757,
              "pages": 104857
            },
            "org.mozilla.searches.counts": {
              "_v": 1,
              "google.urlbar": 4
            },
            "org.mozilla.appInfo.appinfo": {
              "_v": 1,
              "isDefaultBrowser": 1
            }
          }
        }
      }
    }

Measurements
============

The bulk of payloads consists of measurement data. An individual measurement
is merely a collection of related values e.g. *statistics about the Places
database* or *system information*.

Each measurement has an integer version number attached. When the fields in
a measurement or the semantics of data within that measurement change, the
version number is incremented.

All measurements are defined alphabetically in the sections below.

org.mozilla.addons.addons
-------------------------

This measurement contains information about the currently-installed add-ons.

Version 2
^^^^^^^^^

This version adds the human-readable fields *name* and *description*, both
coming directly from the Addon instance as most properties in version 1.
Also, all plugin details are now in org.mozilla.addons.plugins.

Version 1
^^^^^^^^^

The measurement object is a mapping of add-on IDs to objects containing
add-on metadata.

Each add-on contains the following properties:

* userDisabled
* appDisabled
* version
* type
* scope
* foreignInstall
* hasBinaryComponents
* installDay
* updateDay

With the exception of *installDay* and *updateDay*, all these properties
come direct from the Addon instance. See https://developer.mozilla.org/en-US/docs/Addons/Add-on_Manager/Addon.
*installDay* and *updateDay* are the number of days since UNIX epoch of
the add-ons *installDate* and *updateDate* properties, respectively.

Notes
^^^^^

Add-ons that have opted out of AMO updates via the
*extensions._id_.getAddons.cache.enabled* preference are, since Bug 868306
(Firefox 24), included in the list of submitted add-ons.

Example
^^^^^^^
::

    "org.mozilla.addons.addons": {
      "_v": 2,
      "{d10d0bf8-f5b5-c8b4-a8b2-2b9879e08c5d}": {
        "userDisabled": false,
        "appDisabled": false,
        "name": "Adblock Plus",
        "version": "2.4.1",
        "type": "extension",
        "scope": 1,
        "description": "Ads were yesterday!",
        "foreignInstall": false,
        "hasBinaryComponents": false,
        "installDay": 16093,
        "updateDay": 16093
      },
      "{e4a8a97b-f2ed-450b-b12d-ee082ba24781}": {
        "userDisabled": true,
        "appDisabled": false,
        "name": "Greasemonkey",
        "version": "1.14",
        "type": "extension",
        "scope": 1,
        "description": "A User Script Manager for Firefox",
        "foreignInstall": false,
        "hasBinaryComponents": false,
        "installDay": 16093,
        "updateDay": 16093
      }
    }

org.mozilla.addons.plugins
--------------------------

This measurement contains information about the currently-installed plugins.

Version 1
^^^^^^^^^

The measurement object is a mapping of plugin IDs to objects containing
plugin metadata.

The plugin ID is constructed of the plugins filename, name, version and
description. Every plugin has at least a filename and a name.

Each plugin contains the following properties:

* name
* version
* description
* blocklisted
* disabled
* clicktoplay
* mimeTypes
* updateDay

With the exception of *updateDay* and *mimeTypes*, all these properties come
directly from ``nsIPluginTag`` via ``nsIPluginHost``.
*updateDay* is the number of days since UNIX epoch of the plugins last modified
time.
*mimeTypes* is the list of mimetypes the plugin supports, see
``nsIPluginTag.getMimeTypes()``.

Example
^^^^^^^

::

    "org.mozilla.addons.plugins": {
      "_v": 1,
      "Flash Player.plugin:Shockwave Flash:12.0.0.38:Shockwave Flash 12.0 r0": {
        "mimeTypes": [
          "application/x-shockwave-flash",
          "application/futuresplash"
        ],
        "name": "Shockwave Flash",
        "version": "12.0.0.38",
        "description": "Shockwave Flash 12.0 r0",
        "blocklisted": false,
        "disabled": false,
        "clicktoplay": false
      },
      "Default Browser.plugin:Default Browser Helper:537:Provides information about the default web browser": {
        "mimeTypes": [
          "application/apple-default-browser"
        ],
        "name": "Default Browser Helper",
        "version": "537",
        "description": "Provides information about the default web browser",
        "blocklisted": false,
        "disabled": true,
        "clicktoplay": false
      }
    }

org.mozilla.addons.counts
-------------------------

This measurement contains information about historical add-on counts.

Version 1
^^^^^^^^^

The measurement object consists of counts of different add-on types. The
properties are:

extension
    Integer count of installed extensions.
plugin
    Integer count of installed plugins.
theme
    Integer count of installed themes.
lwtheme
    Integer count of installed lightweigh themes.

Notes
^^^^^

Add-ons opted out of AMO updates are included in the counts. This differs from
the behavior of the active add-ons measurement.

If no add-ons of a particular type are installed, the property for that type
will not be present (as opposed to an explicit property with value of 0).

Example
^^^^^^^

::

    "2013-03-14": {
      "org.mozilla.addons.counts": {
        "_v": 1,
        "extension": 21,
        "plugin": 4,
        "theme": 1
      }
    }



org.mozilla.appInfo.appinfo
---------------------------

This measurement contains basic XUL application and Gecko platform
information. It is reported in the *last* section.

Version 2
^^^^^^^^^

In addition to fields present in version 1, this version has the following
fields appearing in the *days* section:

isBlocklistEnabled
    Whether the blocklist ping is enabled. This is an integer, 0 or 1.
    This does not indicate whether the blocklist ping was sent but merely
    whether the application will try to send the blocklist ping.

isTelemetryEnabled
    Whether Telemetry is enabled. This is an integer, 0 or 1.

Version 1
^^^^^^^^^

The measurement object contains mostly string values describing the
current application and build. The properties are:

* vendor
* name
* id
* version
* appBuildID
* platformVersion
* platformBuildID
* os
* xpcomabi
* updateChannel
* distributionID
* distributionVersion
* hotfixVersion
* locale
* isDefaultBrowser

Notes
^^^^^

All of the properties appear in the *last* section except for
*isDefaultBrowser*, which appears under *days*.

Example
^^^^^^^

This example comes from an official OS X Nightly build::

    "org.mozilla.appInfo.appinfo": {
      "_v": 1,
      "appBuildID": "20130311030946",
      "distributionID": "",
      "distributionVersion": "",
      "hotfixVersion": "",
      "id": "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}",
      "locale": "en-US",
      "name": "Firefox",
      "os": "Darwin",
      "platformBuildID": "20130311030946",
      "platformVersion": "22.0a1",
      "updateChannel": "nightly",
      "vendor": "Mozilla",
      "version": "22.0a1",
      "xpcomabi": "x86_64-gcc3"
    },

org.mozilla.appInfo.update
--------------------------

This measurement contains information about the application update mechanism
in the application.

Version 1
^^^^^^^^^

The following daily values are reported:

enabled
    Whether automatic application update checking is enabled. 1 for yes,
    0 for no.
autoDownload
    Whether automatic download of available updates is enabled.

Notes
^^^^^

This measurement was merged to mozilla-central for JS FHR on 2013-07-15.

Example
^^^^^^^

::

    "2013-07-15": {
      "org.mozilla.appInfo.update": {
        "_v": 1,
        "enabled": 1,
        "autoDownload": 1,
      }
    }

org.mozilla.appInfo.versions
----------------------------

This measurement contains a history of application version numbers.

Version 2
^^^^^^^^^

Version 2 reports more fields than version 1 and is not backwards compatible.
The following fields are present in version 2:

appVersion
    An array of application version strings.
appBuildID
    An array of application build ID strings.
platformVersion
    An array of platform version strings.
platformBuildID
    An array of platform build ID strings.

When the application is upgraded, the new version and/or build IDs are
appended to their appropriate fields.

Version 1
^^^^^^^^^

When the application version (*version* from *org.mozilla.appinfo.appinfo*)
changes, we record the new version on the day the change was seen. The new
versions for a day are recorded in an array under the *version* property.

Notes
^^^^^

If the application isn't upgraded, this measurement will not be present.
This means this measurement will not be present for most days if a user is
on the release channel (since updates are typically released every 6 weeks).
However, users on the Nightly and Aurora channels will likely have a lot
of these entries since those builds are updated every day.

Values for this measurement are collected when performing the daily
collection (typically occurs at upload time). As a result, it's possible
the actual upgrade day may not be attributed to the proper day - the
reported day may lag behind.

The app and platform versions and build IDs should be identical for most
clients. If they are different, we are possibly looking at a *Frankenfox*.

Example
^^^^^^^

::

    "2013-03-27": {
      "org.mozilla.appInfo.versions": {
        "_v": 2,
        "appVersion": [
           "22.0.0"
        ],
        "appBuildID": [
          "20130325031100"
        ],
        "platformVersion": [
          "22.0.0"
        ],
        "platformBuildID": [
          "20130325031100"
        ]
      }
    }

org.mozilla.appSessions.current
-------------------------------

This measurement contains information about the currently running XUL
application's session.

Version 3
^^^^^^^^^

This measurement has the following properties:

startDay
    Integer days since UNIX epoch when this session began.
activeTicks
    Integer count of *ticks* the session was active for. Gecko periodically
    sends out a signal when the session is active. Session activity
    involves keyboard or mouse interaction with the application. Each tick
    represents a window of 5 seconds where there was interaction.
totalTime
    Integer seconds the session has been alive.
main
    Integer milliseconds it took for the Gecko process to start up.
firstPaint
    Integer milliseconds from process start to first paint.
sessionRestored
    Integer milliseconds from process start to session restore.

Example
^^^^^^^

::

    "org.mozilla.appSessions.current": {
      "_v": 3,
      "startDay": 15775,
      "activeTicks": 4282,
      "totalTime": 249422,
      "main": 851,
      "firstPaint": 3271,
      "sessionRestored": 5998
    }

org.mozilla.appSessions.previous
--------------------------------

This measurement contains information about previous XUL application sessions.

Version 3
^^^^^^^^^

This measurement contains per-day lists of all the sessions started on that
day. The following properties may be present:

cleanActiveTicks
    Active ticks of sessions that were properly shut down.
cleanTotalTime
    Total number of seconds for sessions that were properly shut down.
abortedActiveTicks
    Active ticks of sessions that were not properly shut down.
abortedTotalTime
    Total number of seconds for sessions that were not properly shut down.
main
    Time in milliseconds from process start to main process initialization.
firstPaint
    Time in milliseconds from process start to first paint.
sessionRestored
    Time in milliseconds from process start to session restore.

Notes
^^^^^

Sessions are recorded on the date on which they began.

If a session was aborted/crashed, the total time may be less than the actual
total time. This is because we don't always update total time during periods
of inactivity and the abort/crash could occur after a long period of idle,
before we've updated the total time.

The lengths of the arrays for {cleanActiveTicks, cleanTotalTime},
{abortedActiveTicks, abortedTotalTime}, and {main, firstPaint, sessionRestored}
should all be identical.

The length of the clean sessions plus the length of the aborted sessions should
be equal to the length of the {main, firstPaint, sessionRestored} properties.

It is not possible to distinguish the main, firstPaint, and sessionRestored
values from a clean vs aborted session: they are all lumped together.

For sessions spanning multiple UTC days, it's not possible to know which
days the session was active for. It's possible a week long session only
had activity for 2 days and there's no way for us to tell which days.

Example
^^^^^^^

::

    "org.mozilla.appSessions.previous": {
      "_v": 3,
      "cleanActiveTicks": [
        78,
        1785
      ],
      "cleanTotalTime": [
        4472,
        88908
      ],
      "main": [
        32,
        952
      ],
      "firstPaint": [
        2755,
        3497
      ],
      "sessionRestored": [
        5149,
        5520
      ]
    }

org.mozilla.crashes.crashes
---------------------------

This measurement contains a historical record of application crashes.

Version 6
^^^^^^^^^

This version adds tracking for out-of-memory (OOM) crashes in the main process.
An OOM crash will be counted as both main-crash and main-crash-oom.

This measurement will be reported on each day there was a crash or crash
submission. Records may contain the following fields, whose values indicate
the number of crashes, hangs, or submissions that occurred on the given day:

* content-crash
* content-crash-submission-succeeded
* content-crash-submission-failed
* content-hang
* content-hang-submission-succeeded
* content-hang-submission-failed
* gmplugin-crash
* gmplugin-crash-submission-succeeded
* gmplugin-crash-submission-failed
* main-crash
* main-crash-oom
* main-crash-submission-succeeded
* main-crash-submission-failed
* main-hang
* main-hang-submission-succeeded
* main-hang-submission-failed
* plugin-crash
* plugin-crash-submission-succeeded
* plugin-crash-submission-failed
* plugin-hang
* plugin-hang-submission-succeeded
* plugin-hang-submission-failed

Version 5
^^^^^^^^^

This version adds support for Gecko media plugin (GMP) crashes.

This measurement will be reported on each day there was a crash or crash
submission. Records may contain the following fields, whose values indicate
the number of crashes, hangs, or submissions that occurred on the given day:

* content-crash
* content-crash-submission-succeeded
* content-crash-submission-failed
* content-hang
* content-hang-submission-succeeded
* content-hang-submission-failed
* gmplugin-crash
* gmplugin-crash-submission-succeeded
* gmplugin-crash-submission-failed
* main-crash
* main-crash-submission-succeeded
* main-crash-submission-failed
* main-hang
* main-hang-submission-succeeded
* main-hang-submission-failed
* plugin-crash
* plugin-crash-submission-succeeded
* plugin-crash-submission-failed
* plugin-hang
* plugin-hang-submission-succeeded
* plugin-hang-submission-failed

Version 4
^^^^^^^^^

This version follows up from version 3, adding submissions which are now
tracked by the :ref:`crashes_crashmanager`.

This measurement will be reported on each day there was a crash or crash
submission. Records may contain the following fields, whose values indicate
the number of crashes, hangs, or submissions that occurred on the given day:

* main-crash
* main-crash-submission-succeeded
* main-crash-submission-failed
* main-hang
* main-hang-submission-succeeded
* main-hang-submission-failed
* content-crash
* content-crash-submission-succeeded
* content-crash-submission-failed
* content-hang
* content-hang-submission-succeeded
* content-hang-submission-failed
* plugin-crash
* plugin-crash-submission-succeeded
* plugin-crash-submission-failed
* plugin-hang
* plugin-hang-submission-succeeded
* plugin-hang-submission-failed

Version 3
^^^^^^^^^

This version follows up from version 2, building on improvements to
the :ref:`crashes_crashmanager`.

This measurement will be reported on each day there was a
crash. Records may contain the following fields, whose values indicate
the number of crashes or hangs that occurred on the given day:

* main-crash
* main-hang
* content-crash
* content-hang
* plugin-crash
* plugin-hang

Version 2
^^^^^^^^^

The switch to version 2 coincides with the introduction of the
:ref:`crashes_crashmanager`, which provides a more robust source of
crash data.

This measurement will be reported on each day there was a crash. The
following fields may be present in each record:

mainCrash
   The number of main process crashes that occurred on the given day.

Yes, version 2 does not track submissions like version 1. It is very
likely submissions will be re-added later.

Also absent from version 2 are plugin crashes and hangs. These will be
re-added, likely in version 3.

Version 1
^^^^^^^^^

This measurement will be reported on each day there was a crash. The
following properties are reported:

pending
    The number of crash reports that haven't been submitted.
submitted
    The number of crash reports that were submitted.

Notes
^^^^^

Main process crashes are typically submitted immediately after they
occur (by checking a box in the crash reporter, which should appear
automatically after a crash). If the crash reporter submits the crash
successfully, we get a submitted crash. Else, we leave it as pending.

A pending crash does not mean it will eventually be submitted.

Pending crash reports can be submitted post-crash by going to
about:crashes.

If a pending crash is submitted via about:crashes, the submitted count
increments but the pending count does not decrement. This is because FHR
does not know which pending crash was just submitted and therefore it does
not know which day's pending crash to decrement.

Example
^^^^^^^

::

    "org.mozilla.crashes.crashes": {
      "_v": 1,
      "pending": 1,
      "submitted": 2
    },
    "org.mozilla.crashes.crashes": {
      "_v": 2,
      "mainCrash": 2
    }
    "org.mozilla.crashes.crashes": {
      "_v": 4,
      "main-crash": 2,
      "main-crash-submission-succeeded": 1,
      "main-crash-submission-failed": 1,
      "main-hang": 1,
      "plugin-crash": 2
    }

org.mozilla.healthreport.submissions
------------------------------------

This measurement contains a history of FHR's own data submission activity.
It was added in Firefox 23 in early May 2013.

Version 2
^^^^^^^^^

This is the same as version 1 except an additional field has been added.

uploadAlreadyInProgress
   A request for upload was initiated while another upload was in progress.
   This should not occur in well-behaving clients. It (along with a lock
   preventing simultaneous upload) was added to ensure this never occurs.

Version 1
^^^^^^^^^

Daily counts of upload events are recorded.

firstDocumentUploadAttempt
    An attempt was made to upload the client's first document to the server.
    These are uploads where the client is not aware of a previous document ID
    on the server. Unless the client had disabled upload, there should be at
    most one of these in the history of the client.

continuationUploadAttempt
    An attempt was made to upload a document that replaces an existing document
    on the server. Most upload attempts should be attributed to this as opposed
    to *firstDocumentUploadAttempt*.

uploadSuccess
    The upload attempt recorded by *firstDocumentUploadAttempt* or
    *continuationUploadAttempt* was successful.

uploadTransportFailure
    An upload attempt failed due to transport failure (network unavailable,
    etc).

uploadServerFailure
    An upload attempt failed due to a server-reported failure. Ideally these
    are failures reported by the FHR server itself. However, intermediate
    proxies, firewalls, etc may trigger this depending on how things are
    configured.

uploadClientFailure
    An upload attempt failued due to an error/exception in the client.
    This almost certainly points to a bug in the client.

The result for an upload attempt is always attributed to the same day as
the attempt, even if the result occurred on a different day from the attempt.
Therefore, the sum of the result counts should equal the result of the attempt
counts.

org.mozilla.hotfix.update
-------------------------

This measurement contains results from the Firefox update hotfix.

The Firefox update hotfix bypasses the built-in application update mechanism
and installs a modern Firefox.

Version 1
^^^^^^^^^

The fields in this measurement are dynamically created based on which
versions of the update hotfix state file are found on disk.

The general format of the fields is ``<version>.<thing>`` where ``version``
is a hotfix version like ``v20140527`` and ``thing`` is a key from the
hotfix state file, e.g. ``upgradedFrom``. Here are some of the ``things``
that can be defined.

upgradedFrom
    String identifying the Firefox version that the hotfix upgraded from.
    e.g. ``16.0`` or ``17.0.1``.

uninstallReason
    String with enumerated values identifying why the hotfix was uninstalled.
    Value will be ``STILL_INSTALLED`` if the hotfix is still installed.

downloadAttempts
    Integer number of times the hotfix started downloading an installer.
    Download resumes are part of this count.

downloadFailures
    Integer count of times a download supposedly completed but couldn't
    be validated. This likely represents something wrong with the network
    connection. The ratio of this to ``downloadAttempts`` should be low.

installAttempts
    Integer count of times the hotfix attempted to run the installer.
    This should ideally be 1. It should only be greater than 1 if UAC
    elevation was cancelled or not allowed.

installFailures
    Integer count of total installation failures this client experienced.
    Can be 0. ``installAttempts - installFailures`` implies install successes.

notificationsShown
    Integer count of times a notification was displayed to the user that
    they are running an older Firefox.

org.mozilla.places.places
-------------------------

This measurement contains information about the Places database (where Firefox
stores its history and bookmarks).

Version 1
^^^^^^^^^

Daily counts of items in the database are reported in the following properties:

bookmarks
    Integer count of bookmarks present.
pages
    Integer count of pages in the history database.

Example
^^^^^^^

::

    "org.mozilla.places.places": {
      "_v": 1,
      "bookmarks": 388,
      "pages": 94870
    }

org.mozilla.profile.age
-----------------------

This measurement contains information about the current profile's age (and
in version 2, the profile's most recent reset date)

Version 2
^^^^^^^^^

*profileCreation* and *profileReset* properties are present.  Both define
the integer days since UNIX epoch that the current profile was created or
reset accordingly.

Version 1
^^^^^^^^^

A single *profileCreation* property is present. It defines the integer
days since UNIX epoch that the current profile was created.

Notes
^^^^^

It is somewhat difficult to obtain a reliable *profile born date* due to a
number of factors, but since Version 2, improvements have been made - on a
"profile reset" we copy the profileCreation date from the old profile and
record the time of the reset in profileReset.

Example
^^^^^^^

::

    "org.mozilla.profile.age": {
      "_v": 2,
      "profileCreation": 15176
      "profileReset": 15576
    }

org.mozilla.searches.counts
---------------------------

This measurement contains information about searches performed in the
application.

Version 6 (mobile)
^^^^^^^^^^^^^^^^^^

This adds two new search locations: *widget* and *activity*, corresponding to the search widget and search activity respectively.

Version 2
^^^^^^^^^

This behaves like version 1 except we added all search engines that
Mozilla has a partner agreement with. Like version 1, we concatenate
a search engine ID with a search origin.

Another difference with version 2 is we should no longer misattribute
a search to the *other* bucket if the search engine name is localized.

The set of search engine providers is:

* amazon-co-uk
* amazon-de
* amazon-en-GB
* amazon-france
* amazon-it
* amazon-jp
* amazondotcn
* amazondotcom
* amazondotcom-de
* aol-en-GB
* aol-web-search
* bing
* eBay
* eBay-de
* eBay-en-GB
* eBay-es
* eBay-fi
* eBay-france
* eBay-hu
* eBay-in
* eBay-it
* google
* google-jp
* google-ku
* google-maps-zh-TW
* mailru
* mercadolibre-ar
* mercadolibre-cl
* mercadolibre-mx
* seznam-cz
* twitter
* twitter-de
* twitter-ja
* yahoo
* yahoo-NO
* yahoo-answer-zh-TW
* yahoo-ar
* yahoo-bid-zh-TW
* yahoo-br
* yahoo-ch
* yahoo-cl
* yahoo-de
* yahoo-en-GB
* yahoo-es
* yahoo-fi
* yahoo-france
* yahoo-fy-NL
* yahoo-id
* yahoo-in
* yahoo-it
* yahoo-jp
* yahoo-jp-auctions
* yahoo-mx
* yahoo-sv-SE
* yahoo-zh-TW
* yandex
* yandex-ru
* yandex-slovari
* yandex-tr
* yandex.by
* yandex.ru-be

And of course, *other*.

The sources for searches remain:

* abouthome
* contextmenu
* searchbar
* urlbar

The measurement will only be populated with providers and sources that
occurred that day.

If a user switches locales, searches from default providers on the older
locale will still be supported. However, if that same search engine is
added by the user to the new build and is *not* a default search engine
provider, its searches will be attributed to the *other* bucket.

Version 1
^^^^^^^^^

We record counts of performed searches grouped by search engine and search
origin. Only search engines with which Mozilla has a business relationship
are explicitly counted. All other search engines are grouped into an
*other* bucket.

The following search engines are explicitly counted:

* Amazon.com
* Bing
* Google
* Yahoo
* Other

The following search origins are distinguished:

about:home
    Searches initiated from the search text box on about:home.
context menu
    Searches initiated from the context menu (highlight text, right click,
    and select "search for...")
search bar
    Searches initiated from the search bar (the text field next to the
    Awesomebar)
url bar
    Searches initiated from the awesomebar/url bar.

Due to the localization of search engine names, non en-US locales may wrongly
attribute searches to the *other* bucket. This is fixed in version 2.

Example
^^^^^^^

::

    "org.mozilla.searches.counts": {
      "_v": 1,
      "google.searchbar": 3,
      "google.urlbar": 7
    },

org.mozilla.searches.engines
----------------------------

This measurement contains information about search engines.

Version 1
^^^^^^^^^

This version debuted with Firefox 31 on desktop. It contains the
following properties:

default
   Daily string identifier or name of the default search engine provider.

   This field will only be collected if Telemetry is enabled. If
   Telemetry is enabled and then later disabled, this field may
   disappear from future days in the payload.

   The special value ``NONE`` could occur if there is no default search
   engine.

   The special value ``UNDEFINED`` could occur if a default search
   engine exists but its identifier could not be determined.

   This field's contents are
   ``Services.search.defaultEngine.identifier`` (if defined) or
   ``"other-"`` + ``Services.search.defaultEngine.name`` if not.
   In other words, search engines without an ``.identifier``
   are prefixed with ``other-``.

Version 2
^^^^^^^^^

Starting with Firefox 40, there is an additional optional value:

cohort
  Daily cohort string identifier, recorded if the user is part of
  search defaults A/B testing.

org.mozilla.sync.sync
---------------------

This daily measurement contains information about the Sync service.

Values should be recorded for every day FHR measurements occurred.

Version 1
^^^^^^^^^

This version debuted with Firefox 30 on desktop. It contains the following
properties:

enabled
   Daily numeric indicating whether Sync is configured and enabled. 1 if so,
   0 otherwise.

preferredProtocol
   String version of the maximum Sync protocol version the client supports.
   This will be ``1.1`` for for legacy Sync and ``1.5`` for clients that
   speak the Firefox Accounts protocol.

actualProtocol
   The actual Sync protocol version the client is configured to use.

   This will be ``1.1`` if the client is configured with the legacy Sync
   service or if the client only supports ``1.1``.

   It will be ``1.5`` if the client supports ``1.5`` and either a) the
   client is not configured b) the client is using Firefox Accounts Sync.

syncStart
   Count of sync operations performed.

syncSuccess
   Count of sync operations that completed successfully.

syncError
   Count of sync operations that did not complete successfully.

   This is a measure of overall sync success. This does *not* reflect
   recoverable errors (such as record conflict) that can occur during
   sync. This is thus a rough proxy of whether the sync service is
   operating without error.

org.mozilla.sync.devices
------------------------

This daily measurement contains information about the device type composition
for the configured Sync account.

Version 1
^^^^^^^^^

Version 1 was introduced with Firefox 30.

Field names are dynamic according to the client-reported device types from
Sync records. All fields are daily last seen integer values corresponding to
the number of devices of that type.

Common values include:

desktop
   Corresponds to a Firefox desktop client.

mobile
   Corresponds to a Fennec client.

org.mozilla.sync.migration
--------------------------

This daily measurement contains information about sync migration (that is, the
semi-automated process of migrating a legacy sync account to an FxA account.)

Measurements will start being recorded after a migration is offered by the
sync server and stop after migration is complete or the user elects to "unlink"
their sync account.  In other words, it is expected that users with Sync setup
for FxA or with sync unconfigured will not collect data, and that for users
where data is collected, the collection will only be for a relatively short
period.

Version 1
^^^^^^^^^

Version 1 was introduced with Firefox 37 and includes the following properties:

state
   Corresponds to either a STATE_USER_* string or a STATE_INTERNAL_* string in
   FxaMigration.jsm.  This reflects a state where we are waiting for the user,
   or waiting for some internal process to complete on the way to completing
   the migration.

declined
    Corresponds to the number of times the user closed the migration infobar.

unlinked
    Set if the user declined to migrate and instead "unlinked" Sync from the
    browser.

accepted
    Corresponds to the number of times the user explicitly elected to start or
    continue the migration - it counts how often the user clicked on any UI
    created specifically for migration. The "ideal" UX for migration would see
    this at exactly 1, some known edge-cases (eg, browser restart required to
    finish) could expect this to be 2, and anything more means we are doing
    something wrong.

org.mozilla.sysinfo.sysinfo
---------------------------

This measurement contains basic information about the system the application
is running on.

Version 2
^^^^^^^^^

This version debuted with Firefox 29 on desktop.

A single property was introduced.

isWow64
   If present, this property indicates whether the machine supports WoW64.
   This property can be used to identify whether the host machine is 64-bit.

   This property is only present on Windows machines. It is the preferred way
   to identify 32- vs 64-bit support in that environment.

Version 1
^^^^^^^^^

The following properties may be available:

cpuCount
    Integer number of CPUs/cores in the machine.
memoryMB
    Integer megabytes of memory in the machine.
manufacturer
    The manufacturer of the device.
device
    The name of the device (like model number).
hardware
    Unknown.
name
    OS name.
version
    OS version.
architecture
    OS architecture that the application is built for. This is not the
    actual system architecture.

Example
^^^^^^^

::

    "org.mozilla.sysinfo.sysinfo": {
      "_v": 1,
      "cpuCount": 8,
      "memoryMB": 8192,
      "architecture": "x86-64",
      "name": "Darwin",
      "version": "12.2.0"
    }


org.mozilla.translation.translation
-----------------------------------

This daily measurement contains information about the usage of the translation
feature. It is a special telemetry measurement which will only be recorded in
FHR if telemetry is enabled.

Version 1
^^^^^^^^^

Daily counts are reported in the following properties:

translationOpportunityCount
    Integer count of the number of opportunities there were to translate a page.
missedTranslationOpportunityCount
    Integer count of the number of missed opportunities there were to translate a page.
    A missed opportunity is when the page language is not supported by the translation
    provider.
pageTranslatedCount
    Integer count of the number of pages translated.
charactersTranslatedCount
    Integer count of the number of characters translated.
detectedLanguageChangedBefore
    Integer count of the number of times the user manually adjusted the detected
    language before translating.
detectedLanguageChangedAfter
    Integer count of the number of times the user manually adjusted the detected
    language after having first translated the page.
targetLanguageChanged
    Integer count of the number of times the user manually adjusted the target
    language.
deniedTranslationOffer
    Integer count of the number of times the user opted-out offered
    page translation, either by the Not Now button or by the notification's
    close button in the "offer" state.
autoRejectedTranlationOffer
    Integer count of the number of times the user is not offered page
    translation because they had previously clicked "Never translate this
    language" or "Never translate this site".
showOriginalContent
    Integer count of the number of times the user activated the Show Original
    command.

Additional daily counts broken down by language are reported in the following
properties:

translationOpportunityCountsByLanguage
    A mapping from language to count of opportunities to translate that
    language.
missedTranslationOpportunityCountsByLanguage
    A mapping from language to count of missed opportunities to translate that
    language.
pageTranslatedCountsByLanguage
    A mapping from language to the counts of pages translated from that
    language. Each language entry will be an object containing a "total" member
    along with individual counts for each language translated to.

Other properties:

detectLanguageEnabled
    Whether automatic language detection is enabled. This is an integer, 0 or 1.
showTranslationUI
    Whether the translation feature UI will be shown. This is an integer, 0 or 1.

Example
^^^^^^^

::

    "org.mozilla.translation.translation": {
      "_v": 1,
      "detectLanguageEnabled": 1,
      "showTranslationUI": 1,
      "translationOpportunityCount": 134,
      "missedTranslationOpportunityCount": 32,
      "pageTranslatedCount": 6,
      "charactersTranslatedCount": "1126",
      "detectedLanguageChangedBefore": 1,
      "detectedLanguageChangedAfter": 2,
      "targetLanguageChanged": 0,
      "deniedTranslationOffer": 3,
      "autoRejectedTranlationOffer": 1,
      "showOriginalContent": 2,
      "translationOpportunityCountsByLanguage": {
        "fr": 100,
        "es": 34
      },
      "missedTranslationOpportunityCountsByLanguage": {
        "it": 20,
        "nl": 10,
        "fi": 2
      },
      "pageTranslatedCountsByLanguage": {
        "fr": {
          "total": 6,
          "es": 5,
          "en": 1
        }
      }
    }


org.mozilla.experiments.info
----------------------------------

Daily measurement reporting information about the Telemetry Experiments service.

Version 1
^^^^^^^^^

Property:

lastActive
    ID of the final Telemetry Experiment that is active on a given day, if any.


Version 2
^^^^^^^^^

Adds an additional optional property:

lastActiveBranch
    If the experiment uses branches, the branch identifier string.

Example
^^^^^^^

::

    "org.mozilla.experiments.info": {
      "_v": 2,
      "lastActive": "some.experiment.id",
      "lastActiveBranch": "control"
    }

org.mozilla.uitour.treatment
----------------------------

Daily measurement reporting information about treatment tagging done
by the UITour module.

Version 1
^^^^^^^^^

Daily text values in the following properties:

<tag>:
    Array of discrete strings corresponding to calls for setTreatmentTag(tag, value).

Example
^^^^^^^

::

    "org.mozilla.uitour.treatment": {
      "_v": 1,
      "treatment": [
        "optin",
        "optin-DNT"
      ],
      "another-tag": [
        "foobar-value"
      ]
    }

org.mozilla.passwordmgr.passwordmgr
-----------------------------------

Daily measurement reporting information about the Password Manager

Version 1
^^^^^^^^^

Property:

numSavedPasswords
    number of passwords saved in the Password Manager

enabled
    Whether or not the user has disabled the Password Manager in prefernces

Example
^^^^^^^

::

    "org.mozilla.passwordmgr.passwordmgr": {
      "_v": 1,
      "numSavedPasswords": 5,
      "enabled": 0,
    }

Version 2
^^^^^^^^^

More detailed measurements of login forms & their behavior

numNewSavedPasswordsInSession
    Number of passwords saved to the password manager this session.

numSuccessfulFills
    Number of times the password manager filled in password fields for user this session.

numTotalLoginsEncountered
    Number of times a login form was encountered by the user in the session.

Example
^^^^^^^

::
    "org.mozilla.passwordmgr.passwordmgr": {
      "_v": 2,
      "numSavedPasswords": 32,
      "enabled": 1,
      "numNewSavedPasswords": 5,
      "numSuccessfulFills": 11,
      "numTotalLoginsEncountered": 23,
    }