Closed Bug 1559136 Opened 4 years ago Closed 4 years ago

Add urlbar event telemetry behind a pref


(Firefox :: Address Bar, task, P1)




Firefox 70
70.2 - Jul 22 - Aug 4
Tracking Status
firefox69 --- fixed
firefox70 --- fixed


(Reporter: mak, Assigned: mak)




(Whiteboard: [sci-exclude])


(3 files)

Measure the time from the first user input to the execution of an action in the urlbar.

Iteration: --- → 69.3 - Jun 10 - 23

Bugbug thinks this bug is a task, but please change it back in case of error.

Type: defect → task

Implementation is blocked on bug 1560585

Depends on: 1560585
Assignee: mak77 → nobody
Summary: Add a time to engagement telemetry probe → Add urlbar event telemetry behind a pref
Assignee: nobody → mak77
Whiteboard: [sci-exclude]
Iteration: 69.3 - Jun 10 - 23 → 70.2 - Jul 22 - Aug 4

On Monday I'll file the data-review.

Attached file

Ryan, please also check the Events.yaml definitions provided in the patch.

In particular, this will generate events like:

The value of these events is the type of initial interaction: "typed", "pasted", "dropped", "topsites"

Ancillary data is: elapsed time, number of characters, selection index, selection type (the last 2 are not defined for abandonments)

Afaict, we generate scalars counting the number of these events, even if recording is disabled. Recording can be enabled flipping the browser.urlbar.eventTelemetry.enabled pref (disabled by default).

Attachment #9079943 - Flags: data-review?(rharter)

Data stewardship programming note: please flag one of the data stewards listed at for data-review; thanks!

Comment on attachment 9079943 [details]

As Tim noted, I am not a data steward so I cannot give data review.
Attachment #9079943 - Flags: data-review?(rharter)
Comment on attachment 9079943 [details]

Chutten and Teon are on PTO for a few days yet, we'd like to solve this sooner, trying with Ben.
Attachment #9079943 - Flags: data-review?(bmiroglio)

Ryan, could you please still check the event covers all of your needs please?

Flags: needinfo?(rharter)
Comment on attachment 9079943 [details]

Ben is out as well. Adding Megan.
Attachment #9079943 - Flags: data-review?(bmiroglio) → data-review?(mmccorquodale)
Comment on attachment 9079943 [details]

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way? 
Data will be documented in the probe dictionary. 
2. Is there a control mechanism that allows the user to turn the data collection on and off? 
Yes, can be turned off in preferences. 
3. If the request is for permanent data collection, is there someone who will monitor the data over time?
Yes, harter and 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?
8. Does there need to be a check-in in the future to determine whether to renew the data? 
9. Does the data collection use a third-party collection tool? 
Data review +
Flags: needinfo?(rharter)
Attachment #9079943 - Flags: data-review?(mmccorquodale) → data-review+
Pushed by
Add urlbar event telemetry behind a pref. r=adw
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 70

Thanks, Mak. Teon's probably the right person to review the telemetry form, but I can take a look as well. I'm having a hard time interpreting the events.yaml file. Can you include some example pings in this bug?

Flags: needinfo?(mak77)

I think the description I made in comment 6 covers it pretty much, it's one of those events, with a value and an extra object. All the values (also in extra) are strings, per event telemetry requirement.
Tomorrow nightly can be used to try recording events, by setting the pref.
If you have an example of another bug where the kind of ping you want to see was generated, I'm happy to look into doing that.

Flags: needinfo?(mak77) → needinfo?(rharter)

I'll also file a bug to add in-tree documentation explaining each value.

Regressions: 1568948

Comment on attachment 9079086 [details]
Bug 1559136 - Add urlbar event telemetry behind a pref. r=adw

Beta/Release Uplift Approval Request

  • User impact if declined: No user impact, we need this measurement for experiments that we plan to run from Firefox 69 on.
  • Is this code covered by automated tests?: Yes
  • Has the fix been verified in Nightly?: No
  • Needs manual test from QE?: No
  • If yes, steps to reproduce: It's not necessary because it's not user-facing
  • List of other uplifts needed: None
  • Risk to taking this patch: Low
  • Why is the change risky/not risky? (and alternatives if risky): Event recording is behind a pref, disabled by default. The added methods are no-op when the pref is disabled and they are built to never throw. It will have no impact at all until we enable it for specific experiments population.
  • String changes made/needed:
Attachment #9079086 - Flags: approval-mozilla-beta?

This needs a rebased patch for Beta.

Flags: needinfo?(mak77)
Attached patch Beta patchSplinter Review
Flags: needinfo?(mak77)
Blocks: 1570434
Attachment #9079086 - Flags: approval-mozilla-beta?
Comment on attachment 9081572 [details] [diff] [review]
Beta patch

Needed to gather Telemetry on experiments slated to run in Fx69. Approved for 69.0b10.
Attachment #9081572 - Flags: approval-mozilla-beta+

I'll move the discussion with data-science to a new bug.

Flags: needinfo?(rharter)
Blocks: 1570683
Blocks: 1571144
Blocks: 1575038
Blocks: 1576246
See Also: → 1576277
You need to log in before you can comment on or make changes to this bug.