1693393 - Add new telemetry pings for TopSites in Urlbar

Status: VERIFIED FIXED

(Firefox :: Top Sites, enhancement)

Description

[Nan Jiang [:nanj]]

In bug 1688698, we implement the new pings for TopSites in newtab. We will do the same for the TopSites in Urlbar.

Comment 1

[Nan Jiang [:nanj]]

Attachment: Bug 1693393 - add telemetry for sponsored TopSites in Urlbar

Comment 2

[Nan Jiang [:nanj]]

[Tracking Requested - why for this release]:

We need this telemetry for the feature rollout in 87.

Comment 3

[Nan Jiang [:nanj]]

Attachment: data_review_request_contextual_services_topsites_urlbar.md

Hi Teon and Mika,

This one is a follow-up for bug 1688698, they both implement the telemetry for the sponsored TopSites except that this one is for the feature in Urlbar, and the other one is for newtab page. I put them in separate patches to avoid code complexity.

Please let me know if you have any questions.

Thanks!

Comment 4

[Teon Brooks [:teon]]

thanks for the update. this approval falls outside of the data steward's realm for approval (https://wiki.mozilla.org/index.php?title=Data_Collection&mobileaction=toggle_view_desktop). my role now is to participate in the discussion and document the outcome after it's resolved. :mika mentioned that this will fall in line with approval once the Privacy Notice is updated.
I think for good measure, i think a data review form should be filled out again once all the noted steps in https://bugzilla.mozilla.org/show_bug.cgi?id=1688698#c16 are addressed.

Comment 5

[Nan Jiang [:nanj]]

STR for QA:

• Make sure browser.topsites.useRemoteSetting is set to true
• Creat a new boolean pref browser.topsites.experiment.ebay-2020-1 and set it to true
• Enable PingCentre logging browser.ping-centre.log
• Open the browser console to view the PingCentre logs
• Open a newtab page and click on the Urlbar so that it shows a list of TopSites

Test points:

Impression

The impression will be sent with any of the following actions:

• Click any Top Site in the Urlbar
• Click outside of the Urlbar and the TopSites droplist "blurs"

You should be able to see the impression ping in the browser console as follows (note: the context_id will be different):

TELEMETRY PING (contextual-services): {"experiments":{},"locale":"en-US","version":"88.0a1","release_channel":"default","position":1,"tile_id":-1,"advertiser":"amazon","source":"urlbar","context_id":"{61c00d4f-a3a9-8c4f-8b07-d9b3c7214554}"}

Now open "about:telemetry#keyed-scalars-tab", you should see a keyed scalar called contextual.services.topsites.impression, and its name is urlbar_1, and its value is 1 (or whatever impressions you have seen).

Click

The click ping is sent when you click on any of the sponsored Top Site.

You should be able to see the click ping in the browser console as follows (note: the context_id will be different). Note that the impression ping and click ping happen to share the same payload now, you can use the network activity monitor to see that those two pings are sent to different endpoints. (impression to */topsites-impresssion/* and click to */topsites-click/*)

TELEMETRY PING (contextual-services): {"experiments":{},"locale":"en-US","version":"88.0a1","release_channel":"default","position":1,"tile_id":-1,"advertiser":"amazon","source":"urlbar","context_id":"{61c00d4f-a3a9-8c4f-8b07-d9b3c7214554}"}

Now open "about:telemetry#keyed-scalars-tab", you should see a keyed scalar called contextual.services.topsites.click, and its name is urlbar_1, and its value is 1 (or whatever number that you have clicked).

Caveats

• When a sponsored page is already open, and the subsequent clicks on the same sponsored page in the Urlbar will simply take the user to that tab, in this case, we will only report the impressions but not the subsequent clicks because there will be no new page visits to the sponsored page.

Comment 6

[Nan Jiang [:nanj]]

Please disregard the data review request, it will be done collectively in bug 1694693.

Comment 7

[Teon Brooks [:teon]]

Comment on attachment 9204606 [details]
data_review_request_contextual_services_topsites_urlbar.md

for full discussion on the contextual services, please check https://bugzilla.mozilla.org/show_bug.cgi?id=1694693

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/14f22b60e18b
add telemetry for sponsored TopSites in Urlbar r=dao,harry

Comment 9

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/14f22b60e18b

Comment 10

[Cosmin Muntean [:cmuntean], Ecosystem QA]

I have verified this bug on the latest Nightly 88.0a1 build (Build ID: 20210225092306) on Windows 10 x64, macOS 10.15.7 and Linux Mint 20. In order to verify this, I have used the instructions described in comment 5.

• The impression and click pings are correctly displayed in browser console.
• The impression and click keyed scalars are correctly registered in "about:telemetry" page.

Comment 11

[Nan Jiang [:nanj]]

Comment on attachment 9203977 [details]
Bug 1693393 - add telemetry for sponsored TopSites in Urlbar

Beta/Release Uplift Approval Request

• User impact if declined: We need this for the Contextual Services/Sponsored Topsites experiments & rollout in 87.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): This is a telemetry patch, doesn't change the user-facing code.
• String changes made/needed: None

Comment 12

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9203977 [details]
Bug 1693393 - add telemetry for sponsored TopSites in Urlbar

Approved for 87.0b3.

Comment 13

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/e1b2c1e96896

Comment 14

[Cosmin Muntean [:cmuntean], Ecosystem QA]

I have verified this bug on the latest Beta 87.0b3 build (Build ID: 20210225185804) on Windows 10 x64, macOS 10.15.7 and Linux Mint 20.

• The impression and click pings for the Sponsored Top Sites from the urlbar are correctly displayed in browser console.
• The impression and click keyed scalars for the Sponsored Top Sites from the urlbar are correctly registered in "about:telemetry" page.