# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

---
$schema: moz://mozilla.org/schemas/glean/pings/2-0-0

sync:
  description: |
    This is an aggregated format that contains information about each sync that
    occurred during a timeframe.
    It is submitted every 12 hours, and on browser shutdown,
    but only if the syncs property would not be empty.

    Each item in the `syncs` property is generated after a sync is completed,
    for both successful and failed syncs,
    and contains measurements pertaining to sync performance and error
    information.
  reasons:
    shutdown: |
      Ping submitted due to app shutdown.
    schedule: |
      12h have elapsed since the previous ping.
    idchange: |
      The ID of the user or device has changed.
      Probably means a user signed out, or a different user has logged in.
  include_client_id: false
  send_if_empty: false
  bugs:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812
  data_reviews:
    - https://bugzilla.mozilla.org/show_bug.cgi?id=1963812
  notification_emails:
    - sync-dev@mozilla.com
