Revision control
Copy as Markdown
Other Tools
# 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
# Adding a new metric? We have docs for that!
---
$tags:
- 'Thunderbird :: General'
mail:
account_count:
type: labeled_string
description:
Count of how many accounts were set up, keyed by account type.
bugs:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
labels:
- app.update.service.enabled
- browser.cache.disk.smart_size.enabled
- browser.crashReports.unsubmittedCheck.autoSubmit2
- browser.display.use_system_colors
- browser.safebrowsing.enabled
- datareporting.healthreport.uploadEnabled
- general.autoScroll
- general.smoothScroll
- intl.regional_prefs.use_os_locales
- layers.acceleration.disabled
- layout.css.always_underline_links
- ldap_2.autoComplete.useDirectory
- mail.biff.alert.show_preview
- mail.biff.alert.show_sender
- mail.biff.alert.show_subject
- mail.biff.play_sound
- mail.biff.show_alert
- mail.biff.show_tray_icon
- mail.biff.use_system_alert
- mail.chat.enabled
- mail.chat.play_sound
- mail.chat.show_desktop_notifications
- mail.close_message_window.on_delete
- mail.collect_email_address_outgoing
- mail.compose.attachment_reminder
- mail.compose.autosave
- mail.compose.big_attachments.notify
- mail.compose.default_to_paragraph
- mail.dark-reader.enabled
- mail.dark-reader.show-toggle
- mail.delete_matches_sort_order
- mail.display_glyph
- mail.e2ee.auto_disable
- mail.e2ee.auto_enable
- mail.e2ee.notify_on_auto_disable
- mail.enable_autocomplete
- mail.fixed_width_messages
- mail.forward_add_extension
- mail.mdn.report.enabled
- mail.minimizeToTray
- mail.operate_on_msgs_in_collapsed_threads
- mail.phishing.detection.enabled
- mail.prompt_purge_threshold
- mail.purge.ask
- mail.receipt.request_return_receipt_on
- mail.shell.checkDefaultClient
- mail.showCondensedAddresses
- mail.spam.logging.enabled
- mail.spam.manualMark
- mail.spam.markAsReadOnSpam
- mail.spellcheck.inline
- mail.SpellCheckBeforeSend
- mail.thread.conversation.enabled
- mail.threadpane.table.horizontal_scroll
- mail.warn_on_send_accel_key
- mailnews.database.global.indexer.enabled
- mailnews.downloadToTempFile
- mailnews.mark_message_read.auto
- mailnews.mark_message_read.delay
- mailnews.message_display.disable_remote_image
- mailnews.scroll_to_new_message
- mailnews.sendformat.auto_downgrade
- mailnews.start_page.enabled
- messenger.options.getAttentionOnNewMessages
- messenger.status.awayWhenIdle
- messenger.status.reportIdle
- msgcompose.default_colors
- network.cookie.blockFutureCookies
- network.proxy.share_proxy_settings
- network.proxy.socks_remote_dns
- offline.autoDetect
- places.history.enabled
- privacy.clearOnShutdown.cache
- privacy.donottrackheader.enabled
- purple.conversations.im.send_typing
- purple.logging.log_chats
- purple.logging.log_ims
- searchintegration.enable
- signon.autologin.proxy
- widget.gtk.overlay-scrollbars.enabled
preferences_integer:
type: labeled_string
description: Values of integer preferences.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
labels:
- mail.addressDisplayFormat
- mail.biff.alert.preview_length
- mail.pane_config.dynamic
- mail.ui.display.dateformat.default
- mail.ui.display.dateformat.thisweek
- mail.ui.display.dateformat.today
account_preferences:
type: object
description:
Values of basic account preferences.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
structure:
type: array
items:
type: object
properties:
protocol:
type: string
socket_type:
type: number
auth_method:
type: number
store_type:
type: string
login_at_startup:
type: boolean
check_new_mail:
type: boolean
check_time:
type: number
delete_model:
type: number
use_idle:
type: boolean
cleanup_inbox_on_exit:
type: boolean
empty_trash_on_exit:
type: boolean
download_on_biff:
type: boolean
headers_only:
type: boolean
leave_on_server:
type: boolean
delete_by_age_from_server:
type: boolean
num_days_to_leave_on_server:
type: number
notify_max_articles:
type: number
always_authenticate:
type: boolean
mails_read:
type: counter
description: How many emails were read by the user.
bugs:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
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:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
labels:
- Inbox
- Drafts
- Trash
- SentMail
- Templates
- Junk
- Archive
- Queue
- Virtual
- Other
- Total
compact_result:
type: labeled_counter
description: >
Counts the number of folder compactions that happen and how they ended.
bugs:
data_reviews:
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
compact_duration:
type: timing_distribution
time_unit: millisecond
description: >
Counts how long each folder compaction takes.
bugs:
data_reviews:
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
compact_space_recovered:
type: memory_distribution
memory_unit: byte
description: >
Number of bytes recovered by compaction.
bugs:
data_reviews:
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
mbox_read_errors:
type: labeled_counter
description: >
Counts mbox read failures by type.
bugs:
data_reviews:
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
oauth2_authentication:
type: event
description: >
Records each time the OAuth authentication window is displayed,
including the provider's name, the reason for showing the window, and if
the authentication was successful.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
extra_keys:
issuer:
description: >
The name of the authentication issuer. Only issuers listed in
OAuth2Providers.sys.mjs are recorded.
type: string
reason:
description: The reason for showing the authentication window.
type: string
result:
description: If the authentication succeeded or was cancelled.
type: string
import:
type: event
description: >
Records each time about:import is used to import a profile, calendar
entries, or address book entries.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
extra_keys:
importer:
description: >
Which import module was used to import the data. For profiles, this
also includes where the profile was imported from - the other
application's profile files, an arbitrary directory, or zip file.
type: string
types:
description: >
The types of data imported. For profiles, these are the options
selected in the UI. For other data, this is the format of the file
that was imported.
type: string
result:
description: Success or failure.
type: string
notification_enabled_actions:
type: string_list
description:
The enabled actions on the new mail notification, in order.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never
notification_used_actions:
type: labeled_counter
description: >
A count of how many times each new mail notification action is used.
Labels identify the actions, as defined in MailNotificationManager.sys.mjs.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- telemetry-client-dev@thunderbird.net
expires: never