Closed Bug 1761059 Opened 2 months ago Closed 1 month ago

Implement telemetry for Suggest suggestion blocking

Categories

(Firefox :: Address Bar, task, P1)

task
Points:
3

Tracking

()

VERIFIED FIXED
101 Branch
Tracking Status
firefox101 --- verified

People

(Reporter: adw, Assigned: adw)

References

Details

Attachments

(3 files)

We need to implement telemetry for Suggest suggestion blocking.

This does several things:

  • Add new scalars for blocked suggestions
  • Record the impression custom telemetry ping when a suggestion is blocked
  • Remove the code that gets the index of the quick suggest result when the
    engagement telemetry is recorded. We can replace all that with simply
    result.rowIndex, but we need to store the result we last added in a property
    to do that, so I replaced _addedResultInLastQuery with
    _resultFromLastQuery
  • Modify the urlbar engagement telemetry event code by adding the following
    selType values: "quicksuggest", "block". We can use the selType in the
    quick suggest engagement telemetry code to determine whether the block button
    or the main part of the row was clicked.

Depends on D143246

Attachment #9271411 - Attachment description: Bug 1761059 - Implement telemetry for Suggest suggestion blocking. → Bug 1761059 - Add telemetry scalars for Suggest suggestion blocking.

This adds a new "engagement" telemetry event for quick suggest results. The
event's object can be the following values:

  • "block": The user dismissed ("blocked") the suggestion.
  • "click": The user picked the suggestion.
  • "help": The user picked the suggestion's help button.
  • "impression_only": The user picked some other row.

For this particular bug, we're interested in recording blocks, but there's no
reason not to generalize that idea into an engagement event like this that
records all types of interactions.

Depends on D143254

Attachment #9271411 - Attachment description: Bug 1761059 - Add telemetry scalars for Suggest suggestion blocking. → Bug 1761059 - Part 1: Add telemetry scalars for Suggest suggestion blocking.
Attached file data-request.md

Data review request for 1 new telemetry event, 5 new scalars, and a modification to 1 existing event. These are related to Firefox Suggest and the user's ability to dismiss suggestions.

Attachment #9271729 - Flags: data-review?(chutten)

Comment on attachment 9271729 [details]
data-request.md

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.

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, Drew Willcoxon is 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 the data collection use a third-party collection tool?

No.


Result: datareview+

Attachment #9271729 - Flags: data-review?(chutten) → data-review+
Pushed by dwillcoxon@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/519ff244fc8e
Part 1: Add telemetry scalars for Suggest suggestion blocking. r=daisuke
https://hg.mozilla.org/integration/autoland/rev/5b2401b86818
Part 2: Record an engagement telemetry event for quick suggest results. r=daisuke
Blocks: 1764669
Status: ASSIGNED → RESOLVED
Closed: 1 month ago
Resolution: --- → FIXED
Target Milestone: --- → 101 Branch

I have verified this issue on the latest Nightly 101.0a1 build (Build ID: 20220414092955) on Windows 10 x64, macOS 11.6 and Linux Mint 20 x64. In order to test this I have set the "browser.search.region" to "US" and "browser.urlbar.quicksuggest.blockingEnabled" to true.

  • The following events are correctly registered:
    "block": when the suggestion is dismissed.
    "click": when a sponsored/non-sponsored suggestion is clicked.
    "help": the help button is clicked.
    "impression_only": when a result is clicked but not sponsored/non-sponsored one.

  • The following keyed scalar are registered:
    contextservices.quicksuggest#engagement#impression_only - when a result is clicked but not sponsored/non-sponsored one.
    contextservices.quicksuggest#engagement#block - when the suggestion is dismissed.
    contextservices.quicksuggest#engagement#help - the help button is clicked.
    contextservices.quicksuggest#engagement#click - when a sponsored/non-sponsored suggestion is clicked.

I have also verified these telemetries for the Best Match results. In order to do this we have changed the following prefs:
"browser.urlbar.bestMatch.enabled" to "true" and "browser.urlbar.bestMatch.blockingEnabled" to "true".

Status: RESOLVED → VERIFIED
You need to log in before you can comment on or make changes to this bug.