toolkit/mozapps/defaultagent/pings.yaml

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 ---
   6 $schema: moz://mozilla.org/schemas/glean/pings/2-0-0
   7
   8 default-agent:
   9   description: >
  10     This opt-out ping is sent from the Default Agent, which is a Windows-only
  11     Firefox Background Task that is registered during Firefox installation with
  12     the Windows scheduled tasks system so that it runs automatically every 24
  13     hours, whether Firefox is running or not.
  14
  15     Opting out of telemetry is handled via the pref value being copied to the
  16     registry so that the Default Agent can read it without needing to work with
  17     profiles. Relevant policies are consulted as well. The agent also has its own
  18     pref, `default-agent.enabled`, which if set to false disables all agent
  19     functionality, including generating this ping.
  20
  21     Each installation of Firefox has its own copy of the agent and its own
  22     scheduled task which shares a common `LastPingSentAt` user registry key with
  23     other installations. Installations race to send a single ping per 24 hour
  24     window per installing user. If multiple operating system-level users are all
  25     using one copy of Firefox, only one scheduled task will have been created and
  26     only one ping will be sent, even though the users might have different
  27     default browser settings. If multiple users have installed Firefox then each
  28     installing user will have a scheduled task and ping.
  29
  30     Additional information for the Default Agent can be found in the
  31     [Default Browser Agent docs](https://firefox-source-docs.mozilla.org/toolkit/mozapps/defaultagent/default-browser-agent/index.html).
  32   include_client_id: false
  33   send_if_empty: false
  34   reasons:
  35     daily_ping: |
  36       The ping was sent as part of the daily scheduled Default Agent run.
  37   bugs:
  38     - https://bugzilla.mozilla.org/show_bug.cgi?id=1838755
  39   data_reviews:
  40     - https://bugzilla.mozilla.org/show_bug.cgi?id=1621293
  41   notification_emails:
  42     - install-update@mozilla.com