blob: e4084e62adb9903f846849a00ce85835e9686128 (
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
|
===============
Data collection
===============
There are different APIs and formats to collect data in Firefox, all suiting different use cases.
In general, we aim to submit data in a common format where possible. This has several advantages; from common code and tooling to sharing analysis know-how.
In cases where this isn't possible and more flexibility is needed, we can submit custom pings or consider adding different data formats to existing pings.
*Note:* Every new data collection must go through a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection>`_.
The current data collection possibilities include:
* :doc:`scalars` allow recording of a single value (string, boolean, a number)
* :doc:`histograms` can efficiently record multiple data points
* ``environment`` data records information about the system and settings a session occurs in
* ``TelemetryLog`` allows collecting ordered event entries (note: this does not have supporting analysis tools)
* :doc:`measuring elapsed time <measuring-time>`
* :doc:`custom pings <custom-pings>`
.. toctree::
:maxdepth: 2
:titlesonly:
:hidden:
:glob:
scalars
histograms
measuring-time
custom-pings
Browser Usage Telemetry
~~~~~~~~~~~~~~~~~~~~~~~
For more information, see :ref:`browserusagetelemetry`.
|