Source code
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:
- 'Firefox :: Messaging System'
messaging_system:
event_context_parse_error:
type: counter
lifetime: ping
description: |
How often we failed to parse event_context as JSON.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_reason:
type: string
lifetime: ping
description: |
The event_context's `reason`. Likely something like
"welcome-window-closed" or "app-shut-down",.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_page:
type: string
lifetime: ping
description: |
The event_context's `page`. Almost always "about:welcome".
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_source:
type: string
lifetime: ping
description: |
The event_context's `source`. Likely something like "primary_button".
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_context:
type: text
lifetime: ping
description: |
The stringified JSON of `event_context`.
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_screen_family:
type: text
lifetime: ping
description: |
A string identifier of the message family derived from the message id
(e.g. MR_WELCOME_DEFAULT).
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
- nsauermann@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_screen_id:
type: text
lifetime: ping
description: |
A string identifier of the message screen id
(e.g. AW_MOBILE_DOWNLOAD).
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
- nsauermann@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_screen_initials:
type: text
lifetime: ping
description: |
A string identifier of the message screen initials
(e.g. 'EMAG' for EASY_SETUP, MOBILE_DOWNLOADS, AMO, GRATITUDE).
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
- nsauermann@mozilla.com
expires: never
send_in_pings:
- messaging-system
event_screen_index:
type: quantity
unit: integer
lifetime: ping
description: |
A number identifier of the screen index in a sequence of screens
(e.g. 0 for first message).
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
- nsauermann@mozilla.com
expires: never
send_in_pings:
- messaging-system
message_id:
type: text
lifetime: ping
description: |
A string identifier of the message in Activity Stream Router.
bugs:
data_reviews:
data_sensitivity:
- web_activity
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
event:
type: string
description: >
The type of event. Any user defined string
(e.g. “IMPRESSION”, “CLICK_BUTTON”, "INDEXEDDB_OPEN_FAILED", “SESSION_END”)
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
ping_type:
type: string
description: >
Type of event the ping is capturing.
e.g. "cfr", "onboarding"
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
source:
type: string
description: >
The source of the interaction described by the other metrics.
e.g. "frecent_links", "newtab", "CFR"
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
client_id:
type: uuid
lifetime: ping
description: |
The client_id according to Telemetry.
Might not always have a value due to policy around specific types of
ping being sent. Value may be the canary client id
`c0ffeec0-ffee-c0ff-eec0-ffeec0ffeec0`
in pings near when the data upload pref is disabled (if Telemetry gets
to go first), or between when a client_id has been removed and when it
has been regenerated.
Present only in some circumstances (see
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
locale:
type: string
lifetime: ping
description: >
The locale as supplied to the messaging system by
`Services.locale.appLocaleAsBCP47`.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
browser_session_id:
type: uuid
lifetime: ping
# Disable yamllint for long lines.
# yamllint disable
description: >
The Legacy Telemetry browser "session id".
Identifies a specific period from application start to shutdown.
See [the "main" ping docs](https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/data/main-ping.html)
for details.
# yamllint enable
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
impression_id:
type: uuid
lifetime: ping
description: >
The unique impression identifier for a specific client.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
bucket_id:
type: string
lifetime: ping
description: >
A name shared between multiple messages that may individually be too
targetted.
e.g. a message that gets shown on specific websites or a message asking
about personal information.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
addon_version:
type: string
lifetime: ping
description: >
Used to hold the system addon's version,
now is almost certainly an echo of the app's build id.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- pmcmanis@mozilla.com
- dmosedale@mozilla.com
expires: never
send_in_pings:
- messaging-system
unknown_key_count:
type: counter
description: |
The sum of all unknown keys counted.
Useful for testing.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- chutten@mozilla.com
expires: never
send_in_pings:
- messaging-system
unknown_keys:
type: labeled_counter
description: |
Ping keys supplied to the messaging system for which
we did not have a corresponding metric mapped to how often they attempted
to be recorded.
You may have forgotten to define an appropriate metric in
`browser/components/newtab/metrics.yaml`.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
glean_ping_for_ping_failures:
type: counter
description: |
How often something went awry within
`AboutWelcome.submitGleanPingForPing`, preventing ping submission.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
- chutten@mozilla.com
expires: never
send_in_pings:
- metrics
invalid_nested_data:
type: labeled_counter
description: |
We received a ping with non-scalar data on a field of this name.
If this is existing pre-PingCentre-replacement data, you may need to
augment the logic in
`AboutWelcome.submitGleanPingForPing` like the other `handledKeys`.
If this is for new, post-PingCentre-replacement data, you should
probably prefer a flat structure.
If you're unsure, please ask in
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
- chutten@mozilla.com
expires: never
send_in_pings:
- messaging-system
message_request_time:
type: timing_distribution
description: >
Firefox: Time in ms spent selecting and matching messages to user profile.
This metric was generated to correspond to the Legacy Telemetry
exponential histogram MS_MESSAGE_REQUEST_TIME_MS.
time_unit: millisecond
bugs:
data_reviews:
notification_emails:
- omc@mozilla.com
- dmosedale@mozilla.com
expires: never
telemetry_mirror: MS_MESSAGE_REQUEST_TIME_MS
messaging_system.attribution:
source:
type: string
lifetime: ping
description: |
Attribution's source, possibly derived from the utm parameter of the same
name.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
medium:
type: string
lifetime: ping
description: |
Attribution's medium, possibly derived from the utm parameter of the same
name.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
campaign:
type: string
lifetime: ping
description: |
Attribution's campaign, possibly derived from the utm parameter of the
same name.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
content:
type: string
lifetime: ping
description: |
Attribution's content, possibly derived from the utm parameter of the
same name.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
experiment:
type: string
lifetime: ping
description: |
Attribution's experiment key.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
variation:
type: string
lifetime: ping
description: |
Attribution's variation key.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
ua:
type: string
lifetime: ping
description: |
Attribution's ua key.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
dltoken:
type: string
lifetime: ping
description: |
String representation of the dltoken identifying the particular
installer used to install this Firefox.
Likely a UUID, if present.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
msstoresignedin:
type: string
lifetime: ping
description: |
Either the string "true" or the string "false" to indicate whether the
attributed install came from the Microsoft store and, if so, whether the
user was signed in at the time.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
dlsource:
type: string
lifetime: ping
description: |
Mozilla-specific download "source" name. Could be something like
"mozillaci" to identify that the installer came from
`{archive|ftp}.mozilla.org`.
bugs:
data_reviews:
data_sensitivity:
- interaction
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system
unknown_keys:
type: labeled_counter
description: |
Attribution keys supplied to the messaging system for which
we did not have a corresponding metric, and the count of how
often that happened.
Either add this key to a list of known attribution keys in
`AboutWelcomeTelemetry` to suppress or define an appropriate metric in
`browser/components/newtab/metrics.yaml` to collect.
bugs:
data_reviews:
data_sensitivity:
- technical
notification_emails:
- dmosedale@mozilla.com
- pmcmanis@mozilla.com
expires: never
send_in_pings:
- messaging-system