1819797 - Record telemetry for navigational suggestions

Status: RESOLVED FIXED

(Firefox :: Address Bar, task, P1)

Description

[Drew Willcoxon :adw]

Record telemetry for navigational suggestions.

Comment 1

[Drew Willcoxon :adw]

Attachment: Bug 1819797 - Update telemetry for navigational suggestions and dynamic Wikipedia and add subtypes to quick suggest results.

This adds a bunch of scalars to record navigational suggestions telemetry as
discussed with data science and described in the spec. These scalars are
different from the other Suggest ones because we want to record how nav
suggestions interact with the heuristic result. Unlike the existing scalars, the
keys of these new scalars are the types of heuristics that were shown when a nav
suggestion was or wasn't shown. One of the scalars is updated every time a nav
suggestion is not shown, and of course for most users that will be the vast
majority of the time or all the time, so I put all these scalars behind a Nimbus
variable. We'll set the variable to true in the control and treatment branches
of the nav suggestions experiment.

This patch also makes sure nav suggestions are recorded properly in Glean, as
nav_suggest. I noticed that dynamic Wikipedia results are currently recorded
as suggest_non_sponsor, so I also added a new dynamic_wikipedia Glean type
for them. They're also recorded as urlbar.picked.quicksuggest in the legacy
telemetry, so I also changed it so they're recorded as
urlbar.picked.dynamic_wikipedia.

Currently for dynamic Wikipedia, the non-sponsored scalars are also incremented,
and I discussed with data science whether they and the sponsored scalars should
be incremented for all the new Suggest suggestion types we now have. We agreed
that they should be reserved for the usual partner sponsored and expanded
Wikipedia suggestions, and they should not be used for these new Suggest types,
so this patch also makes that change, and it does not update the non-sponsored
scalars for nav suggestions either.

The other major change this makes is to add a new subtype property to quick
suggest result payloads. I think we need a clear, simple way to distinguish
between all these various Suggest suggestion types that doesn't depend on
examining different payload properties depending on the type.

Comment 2

[Drew Willcoxon :adw]

Attachment: request.md

Data review request for several Glean and legacy telemetry changes

Comment 3

[Elise Richards]

Comment on attachment 9321693 [details]
request.md

Data Review Form

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, through the metrics.yaml, Events.yaml, and Scalars.yaml files, as well as the Glean Dictionary and the Probe Dictionary.

2. Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.

   • Yes, through the normal telemetry opt-out for data-collection opt-out checkbox in Firefox Settings.

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

   • Yes, this a permanent collection. It will be monitored by Drew Willcoxon <[e-mail]> and [e-mail].

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 (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

   • No

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

   • Yes

8. Does the data collection use a third-party collection tool? If yes, escalate to legal.

   • No

Result

data-review+

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3179b109bcf2
Update telemetry for navigational suggestions and dynamic Wikipedia and add subtypes to quick suggest results. r=daleharvey

Comment 5

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/3179b109bcf2