releases-comm-central/mail/metrics.yaml

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

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

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

mail:
  account_count:
    type: labeled_string
    description:
      Count of how many accounts were set up, keyed by account type.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615981
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1903006
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  failed_email_account_setup:
    type: labeled_counter
    description:
       How many times email accounts setup failed, keyed by account config source.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615987
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1644311
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1903006
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  successful_email_account_setup:
    type: labeled_counter
    description:
      How many times email accounts setup succeeded, keyed by account config source.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615987
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1644311
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1903006
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  websearch_usage:
    type: labeled_counter
    description:
      How many times search the web was used, keyed by search engine name.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1584889
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1903006
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  ui_interaction:
    type: event
    description:
      Records a count of interactions with various UI widgets.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1736739
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868480
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1736739
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1868480
    data_sensitivity:
      - interaction
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    extra_keys:
      id:
        description: Telemetry id of the widget interacted with.
        type: string
      source:
        description: >
          The source of the interaction, e.g. "addressbook", "calendar",
          "chat", "keyboard", "message_compose", "message_display",
          "toolbox"          
        type: string

  ui_configuration_folder_tree_modes:
    type: string_list
    description:
      Configuration of the folder tree; which modes are shown.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775#c3
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  ui_configuration_pane_visibility:
    type: labeled_boolean
    description:
      Configuration of the folder and message panes. Whether they are
      set to be shown or not.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775#c3
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    labels:
      - folderPane
      - messagePane

  ui_configuration_message_header:
    type: labeled_string
    description: >
      Configuration of the message header display. Customization state;
      expected values are "true" or "false".
      For buttonStyle values are "default", "only-icons", "only-text".      
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775#c3
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    labels:
      - showAvatar
      - showBigAvatar
      - showFullAddress
      - hideLabels
      - subjectLarge
      - buttonStyle

  preferences_boolean:
    type: labeled_boolean
    description: Values of boolean preferences.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1757993
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1757993#c6
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  preferences_integer:
    type: labeled_string
    description: Values of integer preferences.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775#c3
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  mails_read:
    type: counter
    description: How many emails were read by the user.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615990
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1903006
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  mails_read_secure:
    type: event
    description: >
      How many times different kinds of secure emails are read
      (for the first time), keyed by type.
      TODO: should fold this and mails_read into one      
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615994
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615994#c22
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    extra_keys:
      security:
        description: Security technology, if any. "OpenPGP", "S/MIME" or "".
        type: string
      is_signed:
        description: Whether the email was digitally signed.
        type: boolean
      is_encrypted:
        description: Whether the email was encrypted.
        type: boolean

  folder_opened:
    type: labeled_counter
    description: >
      How many times folders of each type are opened.      
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1800775#c3
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    labels:
      - Inbox
      - Drafts
      - Trash
      - SentMail
      - Templates
      - Junk
      - Archive
      - Queue
      - Virtual
      - Other

  oauth2_provider_count:
    type: labeled_string
    description: >
      A count of incoming mail accounts using OAuth2 for authentication, keyed
      by OAuth2 issuer.      
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1799726
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1799726#c6
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never

  folder_total_messages:
    type: labeled_string
    description: How many messages each type of folder has.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615983
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615983#c7
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    labels:
      - Inbox
      - Drafts
      - Trash
      - SentMail
      - Templates
      - Junk
      - Archive
      - Queue
      - Virtual
      - Other
      - Total

  folder_size_on_disk:
    type: labeled_string
    description: How many bytes each type of folder takes on disk.
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615983
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1899602
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1615983#c7
    data_sensitivity:
      - technical
    notification_emails:
      - telemetry-client-dev@thunderbird.net
    expires: never
    labels:
      - Inbox
      - Drafts
      - Trash
      - SentMail
      - Templates
      - Junk
      - Archive
      - Queue
      - Virtual
      - Other
      - Total