diff options
Diffstat (limited to 'toolkit/components/telemetry/docs/index.rst')
| -rw-r--r-- | toolkit/components/telemetry/docs/index.rst | 25 |
1 files changed, 25 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..5d30c5e923 --- /dev/null +++ b/toolkit/components/telemetry/docs/index.rst @@ -0,0 +1,25 @@ +.. _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 |