Closed Bug 1661304 Opened 8 months ago Closed 6 months ago

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

Categories

(Toolkit :: Telemetry, enhancement)

enhancement

Tracking

()

RESOLVED FIXED
84 Branch
Tracking Status
firefox84 --- fixed

People

(Reporter: mconley, Assigned: mconley)

References

(Blocks 1 open bug, Regressed 1 open bug)

Details

Attachments

(8 files)

47 bytes, text/x-phabricator-request
Details | Review
47 bytes, text/x-phabricator-request
Details | Review
47 bytes, text/x-phabricator-request
Details | Review
2.85 KB, text/plain
chutten
: data-review+
Details
47 bytes, text/x-phabricator-request
Details | Review
47 bytes, text/x-phabricator-request
Details | Review
47 bytes, text/x-phabricator-request
Details | Review
47 bytes, text/x-phabricator-request
Details | Review

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.

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?

Flags: needinfo?(dothayer)

(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).

Attachment #9173168 - Attachment description: Bug 1661304 - Add an initial UserInteraction for tab opening. r?Gijs! → Bug 1661304 - Add an initial UserInteraction for tab opening. r?Gijs!,data-review=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+

Attachment #9173175 - Flags: data-review?(chutten) → data-review+

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

Flags: needinfo?(dothayer)
Pushed by mconley@mozilla.com:
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
Flags: needinfo?(mconley)
Pushed by mconley@mozilla.com:
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
Regressions: 1672375
Flags: needinfo?(mconley)
You need to log in before you can comment on or make changes to this bug.