diff options
Diffstat (limited to 'toolkit/components/telemetry/docs/index.rst')
| -rw-r--r-- | toolkit/components/telemetry/docs/index.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/docs/index.rst b/toolkit/components/telemetry/docs/index.rst new file mode 100644 index 0000000000..2c587fd3d4 --- /dev/null +++ b/toolkit/components/telemetry/docs/index.rst @@ -0,0 +1,31 @@ +========= +Telemetry +========= + +Telemetry is a feature that allows data collection. +This is being used to collect performance metrics and other information about how Firefox performs in the wild, e.g. update events or session lengths. + +There are two main ways of gathering data, Desktop Telemetry - documented here - which is used in Firefox Desktop +and `Glean <https://docs.telemetry.mozilla.org/concepts/glean/glean.html>`__ which is +Mozilla’s newer telemetry framework and used in all Mozilla projects needing data collection. +Information which is gathered is called a probe in Desktop Telemetry or a metric in Glean. +The data is being sent in so-called pings. When pings cannot be sent immediately, caching is implemented as well. + +In many cases, `Firefox on Glean (FOG) <../glean/index.html>`__ +(the Firefox Desktop integration of Glean) is to be preferred over Telemetry. +If your data would benefit from being in Telemetry as well as Glean, +please consult the documentation for the +`Glean Interface For Firefox Telemetry (GIFFT) <../glean/user/gifft.html>`__. + +*Note:* Mozilla's `data collection policy <https://wiki.mozilla.org/Firefox/Data_Collection>`_ documents the process and requirements that are applied here. + +.. toctree:: + :maxdepth: 5 + :titlesonly: + + start/index + concepts/index + collection/index + data/index + internals/index + obsolete/index |