1661304 - Add an API for privileged front-end code to add BHR annotations

Status: RESOLVED FIXED

(Toolkit :: Telemetry, enhancement)

Description

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

See this document for the general approach we're going for and rationale: https://docs.google.com/document/d/11zJ7FEiaP_rFsBRnxdnmhiyKcIVf5vCumTZziqODZVs/edit#

This bug tracks adding the API. I might turn this into a metabug if it turns out this is going to take multiple steps.

Comment 1

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Add an interface for front-end code to annotate background hang reports. r?dthayer!,chutten!

Comment 2

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Hey dthayer, not sure if you'll get a chance to look at this before your PTO, but was hoping for some early feedback on my WIP patch.

I went with a LinkedList to retain the list of Timer objects that are "special" by being ones that cause annotations to be added. Is there any way to improve on this?

Comment 3

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

(Not pictured in this patch - a UserInteractions.yaml definition file, a Python script to convert that into C++ at build time, and code to check the UserInteractionIDs are defined in that yaml file).

Comment 4

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Introduce UserInteractions as things that can be defined statically at build-time. r?chutten!

Depends on D88309

Comment 5

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Add an initial UserInteraction for tab opening. r?Gijs!,data-review=chutten

Depends on D88684

Comment 6

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Data review request.md

Comment 7

[Chris H-C :chutten]

Comment on attachment 9173175 [details]
Data review 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, Mike Conley 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 pre-release channels only.

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 8

[Doug Thayer [:dthayer] (he/him)]

Clearing the needinfo (have more responses in the review itself) - the linked list seems like a reasonable approach to me.

Comment 9

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Make BHR annotations an array of key value pairs when submitted to Telemetry. r?dthayer!

Comment 10

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Add tests for UserInteractions infrastructure. r?chutten!

Depends on D88684

Comment 11

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Adding running() method to UserInteraction. r?chutten!

Depends on D92810

Comment 12

[Mike Conley (:mconley) (:⚙️) (PTO: May 24 - June 2nd)]

Attachment: Bug 1661304 - Allow UserInteractions to clobber one another. r?chutten!,dthayer!

Depends on D93589

Comment 13

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/88b46f9a789e
Make BHR annotations an array of key value pairs when submitted to Telemetry. r=dthayer
https://hg.mozilla.org/integration/autoland/rev/442ce3a64bab
Add an interface for front-end code to annotate background hang reports. r=dthayer,chutten,smaug
https://hg.mozilla.org/integration/autoland/rev/5186bba48ce7
Introduce UserInteractions as things that can be defined statically at build-time. r=chutten
https://hg.mozilla.org/integration/autoland/rev/6f0f76bb873d
Add tests for UserInteractions infrastructure. r=chutten
https://hg.mozilla.org/integration/autoland/rev/e1954838e36f
Adding running() method to UserInteraction. r=chutten
https://hg.mozilla.org/integration/autoland/rev/234f7dd34c95
Allow UserInteractions to clobber one another. r=chutten,dthayer
https://hg.mozilla.org/integration/autoland/rev/10459893968e
Add an initial UserInteraction for tab opening. r=Gijs,data-review=chutten

Comment 14

[Narcis Beleuzu [:NarcisB]]

Backed out for xpcshell failures on test_UserInteraction_annotations.js

Backout link: https://hg.mozilla.org/integration/autoland/rev/c04a62ee4ed93957fa4bfa21288b3c9642edba12
Log link: https://treeherder.mozilla.org/logviewer?job_id=319042629&repo=autoland&lineNumber=3614

Comment 15

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/234c5a1f20cf
Make BHR annotations an array of key value pairs when submitted to Telemetry. r=dthayer
https://hg.mozilla.org/integration/autoland/rev/b0a9d3e280e9
Add an interface for front-end code to annotate background hang reports. r=dthayer,chutten,smaug
https://hg.mozilla.org/integration/autoland/rev/078d7fa25841
Introduce UserInteractions as things that can be defined statically at build-time. r=chutten
https://hg.mozilla.org/integration/autoland/rev/158644b846db
Add tests for UserInteractions infrastructure. r=chutten
https://hg.mozilla.org/integration/autoland/rev/ec504e705660
Adding running() method to UserInteraction. r=chutten
https://hg.mozilla.org/integration/autoland/rev/6dba00426132
Allow UserInteractions to clobber one another. r=chutten,dthayer
https://hg.mozilla.org/integration/autoland/rev/9a6e825d7427
Add an initial UserInteraction for tab opening. r=Gijs,data-review=chutten

Comment 16

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/234c5a1f20cf
https://hg.mozilla.org/mozilla-central/rev/b0a9d3e280e9
https://hg.mozilla.org/mozilla-central/rev/078d7fa25841
https://hg.mozilla.org/mozilla-central/rev/158644b846db
https://hg.mozilla.org/mozilla-central/rev/ec504e705660
https://hg.mozilla.org/mozilla-central/rev/6dba00426132
https://hg.mozilla.org/mozilla-central/rev/9a6e825d7427