mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-07 03:38:51 +02:00
27a95c0e17
The 'deletion-request' ping, which supercedes the 'optout' ping, notifies the pipeline when a profile opts out of FHR upload. (IOW, when a user on a specific profile unchecks the box in about:preferences#privacy about sharing technical and interaction data with Mozilla). This ping tries its best to reach the pipeline to let them know that we need to delete data associated with the provided clientId. This means it will remain pending on the client even after opt out and it will try to resend if upload is ever re-enabled. Depends on D51709 Differential Revision: https://phabricator.services.mozilla.com/D51710 --HG-- rename : toolkit/components/telemetry/docs/data/optout-ping.rst => toolkit/components/telemetry/docs/obsolete/optout-ping.rst rename : toolkit/components/telemetry/tests/marionette/tests/client/test_optout_ping.py => toolkit/components/telemetry/tests/marionette/tests/client/test_deletion_request_ping.py extra : moz-landing-system : lando
29 lines
1.6 KiB
ReStructuredText
29 lines
1.6 KiB
ReStructuredText
.. _telemetry_pings:
|
|
|
|
=====================
|
|
Telemetry pings
|
|
=====================
|
|
|
|
A *Telemetry ping* is the data that we send to Mozilla's Telemetry servers.
|
|
|
|
The top-level structure is defined by the :doc:`common ping format <../data/common-ping>`. This is a JSON object which contains:
|
|
|
|
* some basic information shared between different ping types
|
|
* the :doc:`environment data <../data/environment>` (optional)
|
|
* the data specific to the *ping type*, the *payload*.
|
|
|
|
Ping types
|
|
==========
|
|
|
|
We send Telemetry with different ping types. The :doc:`main <../data/main-ping>` ping is the ping that contains the bulk of the Telemetry measurements for Firefox. For more specific use-cases, we send other ping types.
|
|
|
|
Pings sent from code that ships with Firefox are listed in the :doc:`data documentation <../data/index>`.
|
|
|
|
Important examples are:
|
|
|
|
* :doc:`main <../data/main-ping>` - contains the information collected by Telemetry (Histograms, Scalars, ...)
|
|
* :doc:`saved-session <../data/main-ping>` - has the same format as a main ping, but it contains the *"classic"* Telemetry payload with measurements covering the whole browser session. This is only a separate type to make storage of saved-session easier server-side. As of Firefox 61 this is sent on Android only.
|
|
* :doc:`crash <../data/crash-ping>` - a ping that is captured and sent after a Firefox process crashes.
|
|
* :doc:`new-profile <../data/new-profile-ping>` - sent on the first run of a new profile.
|
|
* :doc:`update <../data/update-ping>` - sent right after an update is downloaded.
|
|
* :doc:`deletion-request <../data/deletion-request-ping>` - sent when FHR upload is disabled
|