Add telemetry probes to track usage of the Flexbox Inspector

NEW
Unassigned

Status

enhancement
P2
normal
6 months ago
5 months ago

People

(Reporter: pbro, Unassigned)

Tracking

(Depends on 1 bug)

Firefox Tracking Flags

(Not tracked)

Details

(Reporter)

Description

6 months ago
Before we let the new Flexbox Inspector ride the trains (likely with 65), we need to make sure it has some telemetry probes defined so we can track its usage.

If the selected element is a flex container or item, and if the layout tab is selected and the corresponding container or item accordion is open, then record:
- open count
- active time
like we do for other tools.

If the flexbox highlighter is shown (either from the markup badge, the rule-view or the layout sidebar), then record:
- open count
- active time

I can also think of a few events we might want to track:
- When an item is clicked in the list of items in the flex container sidebar.
- When  an item is clicked in the drop-down list of items in the flex item sidebar.
- When the back arrow is clicked to go back to the flex container sidebar.
- When the color-picker swatch is clicked and a new color is chosen.
(Reporter)

Comment 1

6 months ago
Martin: I took some liberties compared to what was specified in the PRD: https://docs.google.com/document/d/1rqSNguADziEyVELWugJRjpjnNOixNW_zEmj1zoJiSbY/edit
Do you approve of these probes? Are there others we should track? Anything different?
Flags: needinfo?(mbalfanz)
(Reporter)

Comment 2

6 months ago
(In reply to Patrick Brosset <:pbro> from comment #0)
> If the flexbox highlighter is shown (either from the markup badge, the
> rule-view or the layout sidebar), then record:
> - open count
> - active time
This should be recorded per entry point type.
The probes sound very good to me.

I'd like to track the entry point type for the highlighter, esp. to understand if the sidebar toggle is used:
- Layout badge
- Rules view
- Sidebar toggle

Also, if possible I'd like to see if a flex item is a flex container at the same time.
Flags: needinfo?(mbalfanz)
(Reporter)

Updated

6 months ago
Severity: normal → enhancement
Priority: -- → P2
(Reporter)

Comment 4

5 months ago
I'm starting to think about this more. The first step is to model the data we will need for this.
So here's an attempt at this:

- Count the number of times the flex container accordion is open. Do this upon element selection and upon accordion toggle (and only if the layout view is visible).
- Count the number of times the flex item accordion is open. Do this upon element selection and upon accordion toggle (and only if the layout view is visible).
- Count the total number of times a given accordion type is displayed (opened or closed doesn't matter). Do this upon element selection (and only if the layout view is visible). Valid types are container, item, containeritem.
- When an item is clicked in the list of items in the flex container accordion, record an event.
- When an item is clicked in the drop-down list of items in the flex item accordion, record an event.
- When the back arrow is clicked to go back to the flex container accordion, record an event.
- When the color-picker swatch is clicked, record an event
- Count the nb of times the highlighter is activated from the markup-view.
- Count the nb of times the highlighter is activated from the rules-view.
- Count the nb of times the highlighter is activated from the layout-view.
- Measure how long the highlighter is ON for (however it was activated).

Martin: does this sound good to you so far?
Flags: needinfo?(mbalfanz)
>- Count the number of times the flex container accordion is open. Do this upon element selection and upon accordion toggle (and only if the layout view is visible).
>- Count the number of times the flex item accordion is open. Do this upon element selection and upon accordion toggle (and only if the layout view is visible).

If possible, I'd like to only count them if there is relevant content and the layout tab is actually open.  So situations where the panel says "Select a Flex container or item to continue" should be ignored.

Other than that, the list looks good to me!
Flags: needinfo?(mbalfanz)
(Reporter)

Updated

5 months ago
Depends on: 1506874
(Reporter)

Updated

5 months ago
Depends on: 1509070
(Reporter)

Comment 7

5 months ago
It will make it easier for several people to work on this at the same time if we split things in separate bugs.
So I've filed bug 1509070 to do this specific part:

> Count the total number of times a given accordion type is displayed (opened or closed doesn't matter).
> Do this upon element selection (and only if the layout view is visible). Valid types are container, item, containeritem.
(Reporter)

Updated

5 months ago
Depends on: 1509907
(Reporter)

Comment 8

5 months ago
I have also moved the following parts to a separate bug: bug 1509907.

> - Count the nb of times the highlighter is activated from the markup-view.
> - Count the nb of times the highlighter is activated from the rules-view.
> - Count the nb of times the highlighter is activated from the layout-view.
> - Measure how long the highlighter is ON for (however it was activated).
We have landed the minimal telemetry set out for M2. I am removing this meta bug from M2 tracking.
No longer blocks: 1478396
You need to log in before you can comment on or make changes to this bug.