# 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/.

# This file is for Internal FOG Use Only.
# Please don't add anything here unless you have the permission of a
# Telemetry Module Peer.

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Toolkit :: Telemetry'

fog:
  initializations:
    type: timing_distribution
    time_unit: nanosecond
    description: |
      Time the FOG initializations take.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1662123
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797619
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1662123#c3
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1797619
    data_sensitivity:
      - technical
    notification_emails:
      - chumphreys@mozilla.com
      - glean-team@mozilla.com
    expires: never

  failed_idle_registration:
    type: boolean
    lifetime: application
    description: |
      True if we failed to register with the idle service. Absent otherwise.
      Means IPC probably isn't working well.
      Child-process data will likely be absent, or incomplete.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739#c5
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  inits_during_shutdown:
    type: counter
    lifetime: ping
    description: |
      Counts the number of times init had to be called during shutdown.
      Should never have a value for any session long enough to grow idle.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1839433
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1839433
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never
    send_in_pings:
      - temp-fog-initial-state
      - metrics

  max_pings_per_minute:
    type: quantity
    unit: int
    description: |
      Value of the configurable rate limit, in pings per minute, for Glean pings as set at init.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834792
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1834792
    data_sensitivity:
      - technical
    notification_emails:
      - pmcmanis@mozilla.com
      - glean-team@mozilla.com
    expires: never

  data_directory_info:
    type: object
    description: |
      Information about the data directories and files used by FOG.

      Structure is an array of objects, each containing the following properties:
      - `dir_name`: The name of the directory. This is the subdirectory name relative to the
        FOG data directory and should only include "db", "events", and "pending_pings".
      - `dir_exists`: Whether the directory exists. This should only be false on the first
        run of FOG, or if the directory was deleted.
      - `dir_created`: The creation time of the directory, in seconds since the unix epoch. If
        the directory does not exist, this will be `null` and if the time cannot be determined,
        it will default to `0`.
      - `dir_modified`: The last modification time of the directory, in seconds since the unix
        epoch. If the directory does not exist, this will be `null` and if the time cannot be
        determined, it will default to `0`.
      - `file_count`: The number of files in the directory. If the directory does not exist,
        this will be `0`.
      - `files`: An array of objects, each containing:
        - `file_name`: The name of the file. Could be `data.safe.bin`, `events.safe.bin`, or
          A uuid representing the doc-id of a pending ping.
        - `file_created`: The creation time of the file, in seconds since the epoch. If the
          file does not exist, this will be `null` and if the time cannot be determined, it
          will default to `0`.
        - `file_modified`: The last modification time of the file, in seconds since the epoch.
          If the file does not exist, this will be `null` and if the time cannot be determined,
          it will default to `0`.
        - `file_size`: The size of the file in bytes. This can be just about any size but a
          `0` value indicates the file is empty.
    notification_emails:
      - glean-team@mozilla.org
      - tlong@mozilla.com
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979075
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1979075
    data_sensitivity:
      - technical
    expires: 150
    send_in_pings:
      - temp-fog-initial-state
      - metrics
    structure:
      type: array
      items:
        type: object
        properties:
          dir_name:
            type: string
          dir_exists:
            type: boolean
          dir_created:
            type: number
          dir_modified:
            type: number
          file_count:
            type: number
          files:
            type: array
            items:
              type: object
              properties:
                file_name:
                  type: string
                file_created:
                  type: number
                file_modified:
                  type: number
                file_size:
                  type: number

  subdir_err:
    type: labeled_boolean
    description: |
      Which data subdirectories suffered an err between is_dir and read_dir
      while reporting fog.data_diretory_info.
      (Potentially because they were removed in the interim).
    labels: &data_subdir_labels
      - db
      - events
      - pending_pings
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  subdir_entry_err:
    type: labeled_counter
    description: |
      How many dir entries per data subdirectory errored while reporting fog.data_diretory_info.
      (Potentially because they were removed between `read_dir` and the iteration).
    labels: *data_subdir_labels
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  subdir_entry_metadata_err:
    type: labeled_counter
    description: |
      How many dir entries per data subdirectory errored while retrieving their metadata
      while reporting fog.data_diretory_info.
    labels: *data_subdir_labels
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1985911
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

fog.ipc:
  replay_failures:
    type: counter
    description: |
      The number of times the ipc buffer failed to be replayed in the
      parent process.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1664461
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1664461
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  buffer_sizes:
    type: memory_distribution
    memory_unit: byte
    description: |
      The number and size of the IPC buffers being received over FOG IPC.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739#c5
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  flush_durations:
    type: timing_distribution
    time_unit: microsecond
    description: |
      The length of time between asking the child processes for their
      IPC buffers and all of them being received by the parent.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1694739#c5
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  flush_failures:
    type: counter
    description: |
      The number of times we failed to flush all non-parent-process data,
      throwing even partial results into the trash.
      If this number is high, we might consider writing custom `MozPromise`-
      handling code instead of using `MozPromise::All`.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1729026
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1729026
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never

  shutdown_registration_failures:
    type: counter
    description: |
      The number of times we tried to register shutdown flush routines for
      content child processes, and failed (probably because there was no main
      thread).
      As a result there may be data loss from content child processes.
      Large or rising number of clients experiencing this indicates we should
      perhaps refactor content child shutdown in FOG to try harder to register
      flush operations.
      Will likely be obsoleted by bug 1641989.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766977
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1766977
    data_sensitivity:
      - technical
    notification_emails:
      - chutten@mozilla.com
      - glean-team@mozilla.com
    expires: never