Add telemetry to count node selections in the Inspector
Categories
(DevTools :: Inspector, task, P1)
Tracking
(firefox68 fixed, firefox69 fixed)
People
(Reporter: rcaliman, Assigned: rcaliman)
References
(Blocks 1 open bug)
Details
Attachments
(2 files)
|
47 bytes,
text/x-phabricator-request
|
jcristau
:
approval-mozilla-beta+
|
Details | Review |
|
2.09 KB,
text/plain
|
bmiroglio
:
data-review+
|
Details |
We already have a probe to count the number of times the Inspector is opened. But this does not tell us if it's accidental usage from pressing a keyboard shortcut (one of many), using the context menu, or if users are just on their way to another panel in DevTools and have opened the Inspector out of habit.
In order to establish a baseline of how often the Inspector is meaningfully used, we need to add more nuance to this simple count.
We consider a user as being engaged when they actively select nodes in the Inspector to, well, inspect them. We believe observing this behavior helps us separate accidental usage (Inspector open) from engaged usage (Inspector open + selecting nodes).
To do this, we want to add a new telemetry probe which counts how many times node selections are made, irrespective of their origin (context menu, element picker, selections in markup view, etc).
Whenever the Inspector is opened, one node selection is made by default. This is how the Inspector's markup view is populated.
When users are actively using the Inspector, they make more selections manually. Therefore, an equal number of Inspector open count and node selection count signals accidental usage. Conversely, a higher number of node selections than Inspector open count, signals intentional usage.
|
||
Updated•5 years ago
|
|
Assignee | |
Comment 1•5 years ago
|
||
Adds a new permanent telemetry probe (scalar) to count the number of times a node selection is made in the Inspector. This count will be correlated with other existing probes (open count, duration open) to establish a more accurate baseline for Inspector usage and correct for accidental usage.
When opening the Inspector via the context menu ("Inspect Element"), the selection is counted twice: once when automatically selecting the <body> to build the dom tree and once more for selecting the actual target node. This side-effect does not pollute our data. We assign a higher weight to the behavior of "Inspect Element" as being intentional usage of the Inspector so the higher node selection count works in our favor.
|
|
Assignee | |
Comment 2•5 years ago
|
||
Hi Chris! May I please have your review of this request to collect data to improve our understanding of the baseline usage of the Inspector in DevTools?
Martin Balfanz (PM) will correlate this data with existing measurements to trim off the accidental usage of the Inspector which skews our baseline.
|
||
Comment 3•5 years ago
|
||
Comment on attachment 9065040 [details]
request-inspector-adau.md
Load-balancing to Ben
|
||
Comment 4•5 years ago
|
||
Comment on attachment 9065040 [details] request-inspector-adau.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. This collection is Telemetry so is documented in its definitions file [Scalars.yaml](https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Scalars.yaml) and the [Probe Dictionary](https://telemetry.mozilla.org/probe-dictionary/). 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, mbalfanz@mozilla.com 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 there need to be a check-in in the future to determine whether to renew the data? No. This collection is permanent. --- Result: datareview r+
Pushed by rcaliman@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/7b90628fa1e7 Add telemetry probe to count number of node selections. r=gl
|
|
Assignee | |
Updated•5 years ago
|
|
||
Comment 6•5 years ago
|
||
| bugherder | ||
|
|
Assignee | |
Comment 7•5 years ago
|
||
Comment on attachment 9065034 [details]
Bug 1550794 - Add telemetry probe to count number of node selections. r=gl
Beta/Release Uplift Approval Request
- User impact if declined: There is no immediate user impact. This patch helps improve tracking of baseline usage of the DevTools Inspector by helping to filter out accidental usage, which we believe to be substantial. This insight contributes to our long term prioritization of work in the Inspector.
Uplifting this gives us a chance to gather corrected data earlier rather than waiting for the patch to ride the trains to release (when we'll actually get to answer the question of how much accidental usage the Inspector really has).
- Is this code covered by automated tests?: No
- Has the fix been verified in Nightly?: Yes
- Needs manual test from QE?: No
- If yes, steps to reproduce:
- List of other uplifts needed: None
- Risk to taking this patch: Low
- Why is the change risky/not risky? (and alternatives if risky): This patch just introduces a simple telemetry probe (scalar) and uses existing functionality to log to it. There is no user-facing functionality.
- String changes made/needed:
|
||
Comment 8•5 years ago
|
||
Comment on attachment 9065034 [details]
Bug 1550794 - Add telemetry probe to count number of node selections. r=gl
inspector telemetry, approved for 68.0b8
|
||
Comment 9•5 years ago
|
||
| bugherder uplift | ||
Description
•