summaryrefslogtreecommitdiffstats
path: root/toolkit/components/telemetry/docs/data/coverage-ping.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
commit0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d (patch)
treea31f07c9bcca9d56ce61e9a1ffd30ef350d513aa /toolkit/components/telemetry/docs/data/coverage-ping.rst
parentInitial commit. (diff)
downloadfirefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.tar.xz
firefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.zip
Adding upstream version 115.8.0esr.upstream/115.8.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/telemetry/docs/data/coverage-ping.rst')
-rw-r--r--toolkit/components/telemetry/docs/data/coverage-ping.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/toolkit/components/telemetry/docs/data/coverage-ping.rst b/toolkit/components/telemetry/docs/data/coverage-ping.rst
new file mode 100644
index 0000000000..3db93d9074
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/coverage-ping.rst
@@ -0,0 +1,40 @@
+
+"coverage" ping
+===============
+
+This ping is not enabled by default. When enabled, a ping is generated a total of once per profile, as a diagnostic tool
+to determine whether Telemetry is working for users.
+
+This ping contains no client id and no environment data.
+
+You can find more background information in `this blog post <https://blog.mozilla.org/data/2018/08/20/effectively-measuring-search-in-firefox/>`_.
+
+Structure:
+
+.. code-block:: js
+
+ {
+ "appVersion": "63.0a1",
+ "appUpdateChannel": "nightly",
+ "osName": "Darwin",
+ "osVersion": "17.7.0",
+ "telemetryEnabled": 1
+ }
+
+Expected behaviours
+-------------------
+The following is a list of expected behaviours for the ``coverage`` ping:
+
+- The ping will only be sent once per ping version, per profile.
+- If sending the ping fails, it will be retried on startup.
+- A totally arbitrary UUID is generated on first run on a new profile, to use for filtering duplicates.
+- The ping is sent to a different endpoint not using existing Telemetry.
+- The ping does not honor the Telemetry enabled preference, but provides its own opt-out preference: `toolkit.coverage.opt-out`.
+- The ping is disabled by default. It is intended to be enabled for users on an experimental basis using the preference `toolkit.coverage.enabled`.
+
+Version History
+---------------
+
+- Firefox 64:
+
+ - "coverage" ping shipped (`bug 1492656 <https://bugzilla.mozilla.org/show_bug.cgi?id=1492656>`_).