1456984 - Instrument inspection of shortcut combination used for toolbox opening with event telemetry

Status: RESOLVED FIXED

(DevTools :: General, enhancement, P2)

Description

[:Harald Kirschner :digitarald]

Devtools has arguably accumulated too many shortcuts over time. This would be useful data for the many discussions we have on which shortcuts are useful and which can be given up (and in the future maybe offer customization).

Format TBD, input welcome

Comment 1

[:Harald Kirschner :digitarald]

Mike for input on sizing this up; does devtools have this information available already to report?

I would be very interested to get this into 61 as part of M1 depending on hard it is and assuming this can be uplifted. Shortcuts are a major part of investigating accidental usage further.

Comment 2

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

(In reply to :Harald Kirschner :digitarald from comment #1)
> Mike for input on sizing this up; does devtools have this information
> available already to report?
> 
> I would be very interested to get this into 61 as part of M1 depending on
> hard it is and assuming this can be uplifted. Shortcuts are a major part of
> investigating accidental usage further.

No we don't but I am sure we could add something to the toolbox that would register all key events that are function keys or contain a modifier e.g. [cmd], [alt] or [ctrl].

Shall we add that to telemetry M2?

Comment 3

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Screenshots would like to take over the Shift + Ctrl + S shortcut, but only if it's not getting much use as a devtools shortcut.

I'd be happy to help with implementation, if developer time is a blocker here.

Comment 4

[:Harald Kirschner :digitarald]

M2 works for this, which is scheduled to land in 62.

Comment 5

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Attachment: data-review.txt

Events.yaml:
devtools.main:
  shortcut_pressed:
    objects: ["firefox", "webconsole", "inspector", "jsdebugger", "styleeditor", "netmonitor", "storage", "other"],
    bug_numbers: [1456984]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: User pressed a key combination involving cmd, alt, ctrl or a function key that interacted with the developer tools.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      valid: Indicates whether the shortcut is valid.
      keys_pressed: The actual key combination used.
      action: open, close, select_eyedropper, inspector etc.

Usage:
this.telemetry.recordEvent("devtools.main", "shortcut_pressed", "firefox", null, {
      valid: true,
      keys_pressed: "shift+f9",
      action: "Open Storage Inspector"
});

Comment 6

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

The following keys are used to open the toolbox:

Toggle Toolbox: accel+alt+I, accel+shift+I, F12
Browser Toolbox: accel+alt+shift+I
Inspector: accel+alt+C, accel+shift+C
Web Console: accel+alt+K, accel+shift+K
Debugger: accel+alt+S, accel+shift+S
Net Monitor: accel+alt+E, accel+shift+E
Style Editor: shift+f7
Performance: shift+f5
Storage: shift+f9
DOM: accel+alt+W, accel+shift+W

Comment 7

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

We already have this:

devtools.main:
  open:
    objects: ["tools"]
    bug_numbers: [1416024]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: User opens devtools toolbox.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      entrypoint: How was the toolbox opened? CommandLine, ContextMenu, DeveloperToolbar, HamburgerMenu, KeyShortcut, SessionRestore or SystemMenu
      first_panel: The name of the first panel opened.
      host: "Toolbox host (positioning): bottom, side, window or other."
      splitconsole: Indicates whether the split console was open.
      width: Toolbox width rounded up to the nearest 50px.

So we would just need to add a shortcut property for the cases where entrypoint === "KeyShortcut".

Comment 8

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Attachment: data-review.txt

Comment 9

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Attachment: data-review.txt

Comment 10

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Services.telemetry.recordEvent("devtools.main", "open", "tools", null, {
  "entrypoint": "KeyShortcut",
  "first_panel": "Inspector",
  "host": "bottom",
  "splitconsole": "false",
  "width": "777",
  "shortcut": "shift+f9"
})

Comment 11

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Attachment: Bug 1456984 - Instrument inspection of shortcut combination used for toolbox opening with event telemetry

Review commit: https://reviewboard.mozilla.org/r/246098/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/246098/

Comment 12

[Mike Ratcliffe [:miker] [:mratcliffe] [:mikeratcliffe]]

Comment on attachment 8979898 [details]
Bug 1456984 - Instrument inspection of shortcut combination used for toolbox opening with event telemetry

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/246098/diff/1-2/

Comment 13

[François Marier [:francois]]

Comment on attachment 8979854 [details]
data-review.txt

1) Is there or will there be **documentation** that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes, Events.yaml.

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

Yes, telemetry setting.

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

Yes, Harald Kirschner.

4) Using the **[category system of data types](https://wiki.mozilla.org/Firefox/Data_Collection)** on the Mozilla wiki, what collection type of data do the requested measurements fall under?  **

Category 2

5) Is the data collection request for default-on or default-off?

Default on, all channels.

6) Does the instrumentation include the addition of **any *new* identifiers** (whether anonymous or otherwise; e.g., username, random IDs, etc.  See the appendix for more details)?

No.

7) Is the data collection covered by the existing Firefox privacy notice?

Yes.

8) Does there need to be a check-in in the future to determine whether to renew the data?

No, permanent.

Comment 14

[Yulia Startsev [:yulia] | Back in Oct.]

Comment on attachment 8979898 [details]
Bug 1456984 - Instrument inspection of shortcut combination used for toolbox opening with event telemetry

https://reviewboard.mozilla.org/r/246098/#review253512

Looks good!

Comment 15

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/10244430b101
Instrument inspection of shortcut combination used for toolbox opening with event telemetry r=yulia

Comment 16

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/10244430b101

Comment 17

[Jared Hirsch [:jhirsch] (he/him) (Needinfo please)]

Hey there - has enough Telemetry data been gathered to reach a conclusion about which keyboard shortcuts to keep and which to discard?

Comment 18

[:Harald Kirschner :digitarald]

Following up in github as this issue isn't about discarding decisions.

Comment 19

[Anatoli Babenia]

How to see the results?