File: optout-ping.rst

package info (click to toggle)
firefox-esr 128.13.0esr-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,230,012 kB
  • sloc: cpp: 7,103,971; javascript: 6,088,450; ansic: 3,653,980; python: 1,212,330; xml: 594,604; asm: 420,652; java: 182,969; sh: 71,124; makefile: 20,747; perl: 13,449; objc: 12,399; yacc: 4,583; cs: 3,846; pascal: 2,973; lex: 1,720; ruby: 1,194; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (33 lines) | stat: -rw-r--r-- 1,039 bytes parent folder | download | duplicates (23) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 

"optout" ping (obsolete)
========================

This ping is generated when a user turns off FHR upload from the Preferences panel, changing the related ``datareporting.healthreport.uploadEnabled`` :doc:`preference <../internals/preferences>`.

This ping contains no client id and no environment data.

Structure:

.. code-block:: js

    {
      version: 4,
      type: "optout",
      ... common ping data
      payload: { }
    }

Expected behaviours
-------------------
The following is a list of expected behaviours for the ``optout`` ping:

- Sending the "optout" ping is best-effort. Telemetry tries to send the ping once and discards it immediately if sending fails.
- The ping might be delayed if ping sending is throttled (e.g. around midnight).
- The ping can be lost if the browser is shutdown before the ping is sent out the "optout" ping is discarded.

Version History
---------------

- Firefox 63:

  - "optout" ping replaced the "deletion" ping (`bug 1445921 <https://bugzilla.mozilla.org/show_bug.cgi?id=1445921>`_).