1671404 - Add provider name to the address bar engagement telemetry

Status: RESOLVED FIXED

(Firefox :: Address Bar, task, P2)

Description

[Mark Banner (:standard8)]

For experiments it would be useful to have the provider name as part of the address bar engagement telemetry.

The names would be something like "HeuristicFallback", "Autofill", "UnifiedComplete". These are the different names of the different providers that supply the address bar results.

Comment 1

[Mark Banner (:standard8)]

Attachment: Engagment Telemetry Addition Data Review

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1671404 - Add Provider Name to the urlbar engagement telemetry. r?mak!

Comment 3

[Teon Brooks [:teon]]

could you add the key to the urlbar telemetry page under extra? https://firefox-source-docs.mozilla.org/browser/urlbar/telemetry.html#event-telemetry ? is there a list of all the different providers we have so far?

related to this addition, :standard8, i see that with the searchOverride (https://bugzilla.mozilla.org/show_bug.cgi?id=1644442), they're using searchProvider as one of the keys. do you think that it should be provider instead like it is here?

Comment 4

[Teon Brooks [:teon]]

Comment on attachment 9181806 [details]
Engagment Telemetry Addition Data Review

DATA COLLECTION REVIEW RESPONSE:

Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes. This collection is Telemetry so is documented in its definitions file Events.yaml and the Probe Dictionary.

Is there a control mechanism that allows the user to turn the data collection on and off?

Yes. This collection is Telemetry so can be controlled through Firefox's Preferences.

If the request is for permanent data collection, is there someone who will monitor the data over time?

Yes, :standard8 and :teon are responsible.

Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 2, Interaction.

Is the data collection request for default-on or default-off?

Default on for all channels.

Does the instrumentation include the addition of any new identifiers?

No.

Is the data collection covered by the existing Firefox privacy notice?

Yes.

Does there need to be a check-in in the future to determine whether to renew the data?

No. This collection is permanent.

---

Result: datareview+

Comment 5

[Mark Banner (:standard8)]

(In reply to Teon Brooks [:teon] from comment #3)

could you add the key to the urlbar telemetry page under extra? https://firefox-source-docs.mozilla.org/browser/urlbar/telemetry.html#event-telemetry ? is there a list of all the different providers we have so far?

Yes, good point. I can add some examples there as well.

related to this addition, :standard8, i see that with the searchOverride (https://bugzilla.mozilla.org/show_bug.cgi?id=1644442), they're using searchProvider as one of the keys. do you think that it should be provider instead like it is here?

These aren't search providers - these are providers that handle different aspects of the address bar results, e.g. history, autofill, search etc.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/fa95a02b2c90
Add Provider Name to the urlbar engagement telemetry. r=mak

Comment 7

[Sandor Molnar[:smolnar]]

Backed out for causing browser_urlbar_event_telemetry failures

Backout link: https://hg.mozilla.org/integration/autoland/rev/55c26a4f6bdc5d2e5a83f8b83b897730f868cf43

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&collapsedPushes=803163&resultStatus=testfailed%2Cbusted%2Cexception%2Crunning%2Cpending%2Crunnable&revision=ce37b9b99fd622db4506a63761988f84aa809707

Failure log: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=318825154&repo=autoland&lineNumber=10827

INFO - TEST-PASS | browser/components/urlbar/tests/browser/browser_urlbar_event_telemetry.js | Expected key provider must be in actual extra. Actual keys: [elapsed,numChars,numWords,selIndex,selType,provider]. - true == true -
[task 2020-10-16T11:57:39.808Z] 11:57:39 INFO - Buffered messages finished
[task 2020-10-16T11:57:39.809Z] 11:57:39 INFO - TEST-UNEXPECTED-FAIL | browser/components/urlbar/tests/browser/browser_urlbar_event_telemetry.js | extra[provider] must match in event urlbar#engagement#click. - "HeuristicFallback" matches "Autofill" - JS frame :: resource://testing-common/TelemetryTestUtils.jsm :: assertEvents :: line 239
[task 2020-10-16T11:57:39.809Z] 11:57:39 INFO - Stack trace:
[task 2020-10-16T11:57:39.809Z] 11:57:39 INFO - resource://testing-common/TelemetryTestUtils.jsm:assertEvents:239
[task 2020-10-16T11:57:39.809Z] 11:57:39 INFO - chrome://mochitests/content/browser/browser/components/urlbar/tests/browser/browser_urlbar_event_telemetry.js:test:1583
[task 2020-10-16T11:57:39.810Z] 11:57:39 INFO - Running test at index 4
[task 2020-10-16T11:57:39.811Z] 11:57:39 INFO - Type something, click one-off and press enter.
[task 2020-10-16T11:57:39.811Z] 11:57:39 INFO - GECKO(1512) | [Parent 1512, Main Thread] WARNING: '!mOwner', file /builds/worker/checkouts/gecko/dom/events/Event.cpp:704
[task 2020-10-16T11:57:39.812Z] 11:57:39 INFO - Awaiting for the urlbar panel to open
[task 2020-10-16T11:57:39.827Z] 11:57:39 INFO - GECKO(1512) | [Parent 1512, Main Thread] WARNING: 'NS_FAILED(targetPrincipal->GetAsciiOrigin(targetOrigin))', file /builds/worker/checkouts/gecko/toolkit/components/antitracking/AntiTrackingUtils.cpp:347

Comment 8

[Mark Banner (:standard8)]

Found the test was slightly dependant on the tests that run before it. Fixed now.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/08932b37efb3
Add Provider Name to the urlbar engagement telemetry. r=mak

Comment 10

[Dorel Luca [:dluca]]

https://hg.mozilla.org/mozilla-central/rev/08932b37efb3