1736739 - Collect telemetry on menu and toolbar usage

Status: RESOLVED FIXED

(Thunderbird :: General, enhancement)

Description

[Geoff Lankow (:darktrojan)]

We should collect info on what parts of the UI are most used. Firefox does this by capturing command events for the entire window and recording them in scalars (BrowserUsageTelemetry.jsm). I think we can copy this approach.

Comment 1

[Magnus Melin [:mkmelin]]

If we didn't have so much inline handlers, that is ;)
Getting rid of those is of course good in itself.

Comment 2

[Geoff Lankow (:darktrojan)]

Attachment: Bug 1736739 - Collect telemetry on menu and toolbar usage. r=mkmelin

This is a very-cut-down version of Firefox's BrowserUsageTelemetry.jsm to collect data on interactions with the UI.
It listens for all "click" and "command" events in the main window and message window and tries to record each against the most relevant identifier.
There will unavoidably be some noise from things that experiment add-ons have added but this should be low enough to ignore.

I've divided the UI into four main areas: calendar, chat, messages and the toolbox. In future the compose window, address book and secondary calendar UI would be added.

Comment 3

[Geoff Lankow (:darktrojan)]

Attachment: request.md

Comment 4

[Andrei Hajdukewycz [:sancus]]

Comment on attachment 9248590 [details]
request.md

My bad, shouldn't have let this sit so long. I don't see any issues with this. Glad we are measuring it, seems like an excellent use of Telemetry!

Data Review Form:

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?

Yes, in the scalar definition file.

2. Is there a control mechanism that allows the user to turn the data collection on and off?

Yes, using standard Telemetry preferences.

3. If the request is for permanent data collection, is there someone who will monitor the data over time?

Yes, Geoff Lankow(darktrojan).

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 for all channels.

6. Does the instrumentation include the addition of any new identifiers?

No.

7. Is the data collection covered by the existing Thunderbird privacy notice?

Yes.

8. Does the data collection use a third-party collection tool? If yes, escalate to legal.

No.

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/75890401dbe5
Collect telemetry on menu and toolbar usage. r=mkmelin

Comment 6

[Geoff Lankow (:darktrojan)]

Wanted on 91, this patch might need some work before uplifting there though.

Comment 7

[Geoff Lankow (:darktrojan)]

Comment on attachment 9248589 [details]
Bug 1736739 - Collect telemetry on menu and toolbar usage. r=mkmelin

[Approval Request Comment]
Regression caused by (bug #):
User impact if declined: none, just telemetry
Testing completed (on c-c, etc.): landed a week ago
Risk to taking this patch (and alternatives if risky): low

Comment 8

[Wayne Mery (:wsmwk)]

Comment on attachment 9248589 [details]
Bug 1736739 - Collect telemetry on menu and toolbar usage. r=mkmelin

[Triage Comment]
Approved for beta

Comment 9

[Rob Lemley [:rjl]]

Thunderbird 95.0b4:
https://hg.mozilla.org/releases/comm-beta/rev/3dfeedf92f9f

Comment 10

[Geoff Lankow (:darktrojan)]

Comment on attachment 9248589 [details]
Bug 1736739 - Collect telemetry on menu and toolbar usage. r=mkmelin

[Approval Request Comment]
Regression caused by (bug #):
User impact if declined: none, just telemetry
Testing completed (on c-c, etc.): in 95 beta 4
Risk to taking this patch (and alternatives if risky): low

I assume this is all working properly and we're getting some data we expect. Sancus?

Comment 11

[Wayne Mery (:wsmwk)]

Comment on attachment 9248589 [details]
Bug 1736739 - Collect telemetry on menu and toolbar usage. r=mkmelin

[Triage Comment]
Approved for esr91

Comment 12

[Rob Lemley [:rjl]]

Thunderbird 91.4.0:
https://hg.mozilla.org/releases/comm-esr91/rev/767aa716a3b8

Comment 13

[Andrei Hajdukewycz [:sancus]]

(In reply to Geoff Lankow (:darktrojan) from comment #10)

I assume this is all working properly and we're getting some data we expect. Sancus?

Yes and I've passed some of it along, more to come when I have time to dig into Telemetry again. :)