Closed Bug 1790655 Opened 2 years ago Closed 2 years ago

Include total screens in message_id telemetry

Categories

(Firefox :: Messaging System, task, P1)

task

Tracking

()

VERIFIED FIXED
106 Branch
Iteration:
106.2 - Sept 5 - Sept 16
Tracking Status
firefox106 --- verified

People

(Reporter: Mardak, Assigned: aminomancer)

References

(Blocks 1 open bug)

Details

Attachments

(1 file)

Bug 1719707 added screen order, and mr-onboarding has a lot more screens now, so it'll be more useful to help differentiate what sets of screens users can see, e.g., do users drop off differently if they see a progress bar with 4 steps vs 8 steps.

https://searchfox.org/mozilla-central/rev/b94f0c157227dadd3ecf119ce271035c52ed237b/browser/components/newtab/content-src/aboutwelcome/components/MultiStageAboutWelcome.jsx#24-27

Maybe the message ids could be something like "ID_1_OF_8_SCREEN" or even just "ID_1_8_SCREEN" ?

I think with these branching onboarding conditions, the ideal situation would be that each possible flow is assigned an ID (that we can lookup in documentation to understand the sequence) and then that ID is sent with each event. That would help us know precisely how many people started each version.

The "1 of 8" convention would work so long as either (1) every version is of a different length or (2) there are different versions of the same length, but these can otherwise be distinguished by the ID of the first screen. I think this happens to be the case for current onboarding (though I will need to double check this now that the privacy segmentation screen has been removed).

Hmmmmmmmm… would something like this _${screens.map(({id}) => id.split("_")[1][0]).join("")} work for about:welcome?

MR_WELCOME_DEFAULT_0_AW_PIN_FIREFOX_PICG
MR_WELCOME_DEFAULT_1_AW_IMPORT_SETTINGS_PICG
MR_WELCOME_DEFAULT_2_AW_CHOOSE_COLORWAY_PICG
MR_WELCOME_DEFAULT_3_AW_GRATITUDE_PICG
MR_WELCOME_DEFAULT_0_AW_PIN_FIREFOX_PLSICMG
MR_WELCOME_DEFAULT_1_AW_LANGUAGE_MISMATCH_PLSICMG
MR_WELCOME_DEFAULT_2_AW_SET_DEFAULT_PLSICMG
MR_WELCOME_DEFAULT_3_AW_IMPORT_SETTINGS_PLSICMG
MR_WELCOME_DEFAULT_4_AW_CHOOSE_COLORWAY_PLSICMG
MR_WELCOME_DEFAULT_5_AW_MOBILE_DOWNLOAD_PLSICMG
MR_WELCOME_DEFAULT_6_AW_GRATITUDE_PLSICMG

And upgrade spotlight examples:

FX_MR_106_UPGRADE_0_UPGRADE_GET_STARTED_GCG
FX_MR_106_UPGRADE_1_UPGRADE_COLORWAY_GCG
FX_MR_106_UPGRADE_2_UPGRADE_GRATITUDE_GCG
FX_MR_106_UPGRADE_0_UPGRADE_PIN_FIREFOX_PSICMG
FX_MR_106_UPGRADE_1_UPGRADE_SET_DEFAULT_PSICMG
FX_MR_106_UPGRADE_2_UPGRADE_IMPORT_SETTINGS_PSICMG
FX_MR_106_UPGRADE_3_UPGRADE_COLORWAY_PSICMG
FX_MR_106_UPGRADE_4_UPGRADE_MOBILE_DOWNLOAD_PSICMG
FX_MR_106_UPGRADE_5_UPGRADE_GRATITUDE_PSICMG
Iteration: --- → 106.2 - Sept 5 - Sept 16
Flags: needinfo?(loines)
Priority: -- → P1
Summary: Include total number of screens in message_id telemetry → Include total screens in message_id telemetry

I suppose potentially after "M" for MOBILE_DOWNLOAD, there could be another "P" for PIN_PRIVATE_WINDOW and not anymore for 106 another "P" for PRIVACY_SEGMENTATION that could be renamed DATA_RECOMMENDATION for "D" … ? We do have potentially duplicate "G"s for GET_STARTED and GRATITUDE but at least right now, GRATITUDE is always shown and at the end.

Yes! I think this would work. Given that we know what the possible orders are, this seems like it would be unambiguous.

Flags: needinfo?(loines)

[Tracking Requested - why for this release]:
Fix needed for MR 106 telemetry

Add a list of screen initials to the message ID strings sent with
AboutWelcomeTelemetry impression pings. Each screen's message ID will
include a string representing the screen ID of each screen in the
message, in addition to information about the screen itself (for
example, PLSICMG represents AW_PIN_FIREFOX, AW_LANGUAGE_MISMATCH,
etc). This will support, for example, comparisons of user engagement
between messages with many screens versus messages with few screens.
Also change the screen ID for one screen that was adjacent to another
screen with the same initial, in order to disambiguate them (since both
screens can potentially be removed, currently).

Assignee: nobody → shughes
Status: NEW → ASSIGNED
Pushed by shughes@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/3eb39354c54c
Include screen list in AboutWelcome telemetry ping message IDs. r=Mardak
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → 106 Branch

I‘ve verified this task using the latest Firefox Nightly 106.0a1 de build (Build ID: 20220918214503) on Windows 10 x64, macOS 12.5.1, and Linux Mint 20.2 x64.

  • The “IMPRESSION” telemetry pings of the about:welcome are updated with new mesage-ids.
  • I can confirm the followings:
  • If the Firefox browser is not pinned to taskbar and it is not set as default, the following mesage_ids are displayed.

a. For new users:
- MR_WELCOME_DEFAULT_0_AW_PIN_FIREFOX_PLSICMG
- MR_WELCOME_DEFAULT_1_AW_LANGUAGE_MISMATCH_PLSICMG
- MR_WELCOME_DEFAULT_2_AW_SET_DEFAULT_PLSICMG
- MR_WELCOME_DEFAULT_3_AW_IMPORT_SETTINGS_PLSICMG
- MR_WELCOME_DEFAULT_4_AW_CHOOSE_COLORWAY_PLSICMG
- MR_WELCOME_DEFAULT_5_AW_MOBILE_DOWNLOAD_PLSICMG
- MR_WELCOME_DEFAULT_6_AW_GRATITUDE_PLSICMG
- The “PSICG” string is displayed if the Language Mismatched and Mobile Cross-Promo screens are not shown.

b. For existing users:
- FX_MR_106_UPGRADE_0_UPGRADE_PIN_FIREFOX_PSICMG
- FX_MR_106_UPGRADE_1_UPGRADE_SET_DEFAULT_PSICMG
- FX_MR_106_UPGRADE_2_UPGRADE_IMPORT_SETTINGS_PSICMG
- FX_MR_106_UPGRADE_3_UPGRADE_COLORWAY_PSICMG
- FX_MR_106_UPGRADE_4_UPGRADE_MOBILE_DOWNLOAD_PSICMG
- FX_MR_106_UPGRADE_5_UPGRADE_GRATITUDE_PSICMG
- The “PSICG” string is displayed if the Mobile Cross-Promo screen is not shown.

  • If the Firefox browser is pinned to taskbar, and it is not set as the default browser.

a. For new users:
- MR_WELCOME_DEFAULT_0_AW_ONLY_DEFAULT_OLICMG
- MR_WELCOME_DEFAULT_1_AW_LANGUAGE_MISMATCH_OLICMG
- MR_WELCOME_DEFAULT_2_AW_IMPORT_SETTINGS_OLICMG
- MR_WELCOME_DEFAULT_3_AW_CHOOSE_COLORWAY_OLICMG
- MR_WELCOME_DEFAULT_4_AW_MOBILE_DOWNLOAD_OLICMG
- MR_WELCOME_DEFAULT_5_AW_GRATITUDE_OLICMG
- The “OICG” string is displayed if the Language Mismatched and Mobile Cross-Promo screens are not shown.

b. For existing users:
- FX_MR_106_UPGRADE_0_UPGRADE_ONLY_DEFAULT_OICMPG
- FX_MR_106_UPGRADE_1_UPGRADE_IMPORT_SETTINGS_OICMPG
- FX_MR_106_UPGRADE_2_UPGRADE_COLORWAY_OICMPG
- FX_MR_106_UPGRADE_3_UPGRADE_MOBILE_DOWNLOAD_OICMPG
- FX_MR_106_UPGRADE_4_UPGRADE_PIN_PRIVATE_WINDOW_OICMPG
- FX_MR_106_UPGRADE_5_UPGRADE_GRATITUDE_OICMPG
- The “OICG” string is displayed if the Pin Private Window and Mobile Cross-Promo screens are not shown.

  • If the Firefox browser is pinned to taskbar and set as default:

a. For new users:
- MR_WELCOME_DEFAULT_0_AW_GET_STARTED_GLICMG
- MR_WELCOME_DEFAULT_1_AW_LANGUAGE_MISMATCH_GLICMG
- MR_WELCOME_DEFAULT_2_AW_IMPORT_SETTINGS_GLICMG
- MR_WELCOME_DEFAULT_3_AW_CHOOSE_COLORWAY_GLICMG
- MR_WELCOME_DEFAULT_4_AW_MOBILE_DOWNLOAD_GLICMG
- MR_WELCOME_DEFAULT_5_AW_GRATITUDE_GLICMG
- The “GICG” string is displayed if the Language Mismatched and Mobile Cross-Promo screens are not shown.

b. For existing users:
- FX_MR_106_UPGRADE_0_UPGRADE_ONLY_DEFAULT_GCMPG
- FX_MR_106_UPGRADE_1_UPGRADE_IMPORT_SETTINGS_GCMPG
- FX_MR_106_UPGRADE_2_UPGRADE_COLORWAY_GCMPG
- FX_MR_106_UPGRADE_3_UPGRADE_MOBILE_DOWNLOAD_GCMPG
- FX_MR_106_UPGRADE_4_UPGRADE_PIN_PRIVATE_WINDOW_GCMPG
- FX_MR_106_UPGRADE_5_UPGRADE_GRATITUDE_GCMPG
- The “GCG” string is displayed if the Pin Private Window and Mobile Cross-Promo screens are not shown.

  • If the Firefox browser is not pinned to taskbar and it set as default:

a. For new users:
- MR_WELCOME_DEFAULT_0_AW_GET_STARTED_PLICMG
- MR_WELCOME_DEFAULT_1_AW_LANGUAGE_MISMATCH_PLICMG
- MR_WELCOME_DEFAULT_2_AW_IMPORT_SETTINGS_PLICMG
- MR_WELCOME_DEFAULT_3_AW_CHOOSE_COLORWAY_PLICMG
- MR_WELCOME_DEFAULT_4_AW_MOBILE_DOWNLOAD_PLICMG
- MR_WELCOME_DEFAULT_5_AW_GRATITUDE_PLICMG
- The “PICG” string is displayed if the Language Mismatched and Mobile Cross-Promo screens are not shown.

b. For existing users:
- FX_MR_106_UPGRADE_0_UPGRADE_PIN_FIREFOX_PCMG
- FX_MR_106_UPGRADE_1_UPGRADE_COLORWAY_PCMG
- FX_MR_106_UPGRADE_2_UPGRADE_MOBILE_DOWNLOAD_PCMG
- FX_MR_106_UPGRADE_3_UPGRADE_GRATITUDE_PCMG
- The “PCG” string is displayed if the Mobile Cross-Promo screen is not shown.

Status: RESOLVED → VERIFIED

Thanks for verifying and including that list, Simona!

Blocks: 1867627
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: