summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--toolkit/components/telemetry/docs/index.rst26
1 files changed, 26 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..57e2af376e
--- /dev/null
+++ b/toolkit/components/telemetry/docs/index.rst
@@ -0,0 +1,26 @@
+.. _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:
+
+* :doc:`data collection <collection/index>`, e.g. in histograms and scalars
+* assembling :doc:`concepts/pings` with the general information and the data payload
+* sending them to the server and local ping retention
+
+*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