trisquel-icecat/icecat/toolkit/components/telemetry/docs/index.rst

31 lines
1.3 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

=========
Telemetry
=========
Telemetry is a feature that allows data collection.
This is being used to collect performance metrics and other information about how IceCat 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 IceCat Desktop
and `Glean <https://docs.telemetry.mozilla.org/concepts/glean/glean.html>`__ which is
Mozillas newer telemetry framework and used in all GNU 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, `IceCat on Glean (FOG) <../glean/index.html>`__
(the IceCat 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 IceCat Telemetry (GIFFT) <../glean/user/gifft.html>`__.
*Note:* Mozilla's `data collection policy <https://wiki.mozilla.org/IceCat/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