1847855 - Add additional fields to the Glean urlbar events

Status: VERIFIED FIXED

(Firefox :: Address Bar, task, P1)

Comment 1

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1847855: Take telemetry of the prefs that enable/disable part of QuickSuggest features

Comment 2

[Daisuke Akatsuka (:daisuke)]

Attachment: Bug 1847855: Take telemetry of default search engine and selected position

Depends on D185773

Comment 3

[Daisuke Akatsuka (:daisuke)]

Attachment: data-review-request-for-bug1847855.md

Comment 4

[Daisuke Akatsuka (:daisuke)]

Attachment: data-review-request-for-bug1847855.md

Please let me update the data-review file because some telemetry names were changed.

Comment 5

[Daisuke Akatsuka (:daisuke)]

Attachment: data-review-request-for-bug1847855.md

Sorry, please let me update the content of data-review again since the one variable name was changed.

Comment 6

[Travis Long [:travis_]]

Comment on attachment 9348504 [details]
data-review-request-for-bug1847855.md

Permanent collections require an individual contributor to take on the responsibility of checking on this data from time to time to ensure it is necessary and useful.

This is noted in the instructions for question 7 in the data-collection template:

7. How long will this data be collected? Choose one of the following:

• This is scoped to a time-limited experiment/project until date MM-DD-YYYY.

• I want this data to be collected for 6 months initially (potentially renewable).

• I want to permanently monitor this data. (put someone’s name here)

Can you please state who that individual contributor would be and I will be able to complete my review, thanks!

Comment 7

[Megan McCorquodale]

Comment on attachment 9348504 [details]
data-review-request-for-bug1847855.md

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?
   Yes, this will be documented in the Glean dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off?
   Yes, users can opt out of telemetry collection.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?
   This will be monitored by the search team.

4. 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 Data.

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

6. Does the instrumentation include the addition of any new identifiers?
   No new identifiers.

7. Is the data collection covered by the existing Firefox privacy notice?
   Yes.

8. Does the data collection use a third-party collection tool?
   No.

---

data-review +

Comment 8

[Travis Long [:travis_]]

The individual contributors who will monitor this over time will be Drew Willcox And Dave Zeber

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/91c127fef1ca
Take telemetry of the prefs that enable/disable part of QuickSuggest features r=adw
https://hg.mozilla.org/integration/autoland/rev/200aa08042f1
Take telemetry of default search engine and selected position r=adw

Comment 10

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/91c127fef1ca
https://hg.mozilla.org/mozilla-central/rev/200aa08042f1

Comment 11

[Marco Bonardo [:mak]]

Some telemetry names have been changed in Bug 1849726, due to technical restrictions:
pref_quicksuggest_data_collection => pref_suggest_data_collection
pref_quicksuggest_nonsponsored => pref_suggest_nonsponsored
pref_quicksuggest_sponsored => pref_suggest_sponsored

Comment 12

[Adrian Florinescu [:aflorinescu]]

Is there any documentation in regards to these changes that QA can use for reference?

Comment 13

[Stephanie Cunnane [:scunnane]]

Adrian, Daisuke is the better person to ask about the docs.

Comment 14

[Daisuke Akatsuka (:daisuke)]

Hi Adrian! I'm sorry for my delay. I explain here.

Telemetry for preference:

• pref_suggest_data_collection
  • Is recorded the browser.urlbar.quicksuggest.dataCollection.enabled value at initializing and when the pref is changed.
• pref_suggest_nonsponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.nonsponsored value at initializing and when the pref is changed.
• pref_suggest_sponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.sponsored value at initializing and when the pref is changed.

Additional value to abandonment, engagement, and impression event:

• search_engine_default_id
  • The telemetry id of the search engine. Reflects search.engine.default.engine_id.

Additional value to engagement event:

• selected_position
  • The 1-based index of the result the user selected. If user searched without selection, 0 will be recorded.

Comment 15

[Adrian Florinescu [:aflorinescu]]

Thanks for the info Daisuke.
We've tested the above with the following questions:

Telemetry for preference:

• pref_suggest_data_collection
  • Is recorded the browser.urlbar.quicksuggest.dataCollection.enabled value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

• pref_suggest_nonsponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.nonsponsored value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

• pref_suggest_sponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.sponsored value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

Additionally, we also see urlbar.pref_suggest_topsites, I'd guess this enters the same category as above.

Additional value to engagement event:

• selected_position
  • The 1-based index of the result the user selected. If user searched without selection, 0 will be recorded.

I'm not sure how the value 0 can be triggered here: how can you search without a selection?

Comment 16

[Daisuke Akatsuka (:daisuke)]

Hello!

(In reply to Adrian Florinescu [:aflorinescu] from comment #15)

We've tested the above with the following questions:

Telemetry for preference:

• pref_suggest_data_collection
  • Is recorded the browser.urlbar.quicksuggest.dataCollection.enabled value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

• pref_suggest_nonsponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.nonsponsored value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

• pref_suggest_sponsored
  • Is recorded the browser.urlbar.suggest.quicksuggest.sponsored value at initializing and when the pref is changed.

Seems to be recorded into all events, not only at initialization/pref change. recorded glean_debug

Additionally, we also see urlbar.pref_suggest_topsites, I'd guess this enters the same category as above.

Ah, yes, urlbar.pref_suggest_topsites is handled as same as other pref changes above.

And, regarding the inclusion of metrics in events.
I don't know much about this area, but it seems that when data is pinged, metrics is also included.
https://mozilla.github.io/glean/book/user/pings/index.html#payload-structure

Additional value to engagement event:

• selected_position
  • The 1-based index of the result the user selected. If user searched without selection, 0 will be recorded.

I'm not sure how the value 0 can be triggered here: how can you search without a selection?

Yes, if user opens a page without showing urlbar result, 0 is recorded.
For example, if user does paste and go on the urlbar, the value will be 0.
STR:

1. Copy http://example.com to clipboard.
2. Open context menu on urlbar
3. Select Paste and Go

Comment 17

[Adrian Florinescu [:aflorinescu]]

Thanks Daisuke for the clarification. Indeed that's how you generate the 0 value. And with the additional explanation, this bug is verified on Windows 10, Mac 13, Ubuntu 22 with Firefox 118.0b5, Firefox 119.0a1 (2023-09-07).