gecko-dev/toolkit/components/telemetry/docs/index.rst
Georg Fritzsche 012b559669 Bug 1277810 - Part 1 - Restructure Telemetry client documentation. r=dexter, f=chutten
--HG--
rename : toolkit/components/telemetry/docs/scalars.rst => toolkit/components/telemetry/docs/collection/scalars.rst
rename : toolkit/components/telemetry/docs/crashes.rst => toolkit/components/telemetry/docs/concepts/crashes.rst
rename : toolkit/components/telemetry/docs/pings.rst => toolkit/components/telemetry/docs/concepts/pings.rst
rename : toolkit/components/telemetry/docs/common-ping.rst => toolkit/components/telemetry/docs/data/common-ping.rst
rename : toolkit/components/telemetry/docs/core-ping.rst => toolkit/components/telemetry/docs/data/core-ping.rst
rename : toolkit/components/telemetry/docs/crash-ping.rst => toolkit/components/telemetry/docs/data/crash-ping.rst
rename : toolkit/components/telemetry/docs/deletion-ping.rst => toolkit/components/telemetry/docs/data/deletion-ping.rst
rename : toolkit/components/telemetry/docs/environment.rst => toolkit/components/telemetry/docs/data/environment.rst
rename : toolkit/components/telemetry/docs/heartbeat-ping.rst => toolkit/components/telemetry/docs/data/heartbeat-ping.rst
rename : toolkit/components/telemetry/docs/main-ping.rst => toolkit/components/telemetry/docs/data/main-ping.rst
rename : toolkit/components/telemetry/docs/sync-ping.rst => toolkit/components/telemetry/docs/data/sync-ping.rst
rename : toolkit/components/telemetry/docs/uitour-ping.rst => toolkit/components/telemetry/docs/data/uitour-ping.rst
rename : toolkit/components/telemetry/docs/preferences.rst => toolkit/components/telemetry/docs/internals/preferences.rst
2016-08-09 13:52:27 +02:00

25 lines
846 B
ReStructuredText

.. _telemetry:
=========
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.
Client-side, this consists of:
* data collection in `Histograms <https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe>`_, :doc:`collection/scalars` and other data structures
* assembling :doc:`concepts/pings` with the general information and the data payload
* sending them to the server and local ping retention
*Note:* the `data collection policy <https://wiki.mozilla.org/Firefox/Data_Collection>`_ documents the process and requirements that are applied here.
.. toctree::
:maxdepth: 5
:titlesonly:
concepts/index
collection/index
data/index
internals/index
fhr/index