1463118 - Instrument inspection of pausing in the Debugger with event telemetry

Status: RESOLVED FIXED

(DevTools :: General, task, P2)

Comment 1

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

Attachment: data-review.txt

Events.yaml:
devtools.main:
  pause:
    objects: ["debugger"],
    bug_numbers: [1463118]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: Debugger has paused in a script due to a breakpoint or exception.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      reason: caught-exception, uncaught-exception, pausing, debugger-statement or breakpoint.
      collapsed_callstacks: Number of collapsed callstacks in the call tree. These are call stacks that are part of external libraries e.g. react, which are collapsed  by default.

Usage:
this.telemetry.recordEvent("devtools.main", "pause", "debugger", null, {
  reason: "debugger-statement",
  collapsed_callstacks: 1
});

Comment 2

[François Marier [:francois]]

Comment on attachment 8979224 [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 3

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

"collapsed_callstacks" is too long a field name so we have had to shorten it to "lib_stacks":

this.telemetry.recordEvent("devtools.main", "pause", "debugger", null, {
  reason: "debugger-statement",
  lib_stacks: 1
});

Comment 4

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

devtools.main:
  pause:
    objects: ["debugger"]
    bug_numbers: [1463118]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: Debugger has paused in a script due to a breakpoint or exception.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      reason: caught-exception, uncaught-exception, pausing, debugger-statement or breakpoint.
      lib_stacks: Number of collapsed callstacks in the call tree. These are call stacks that are part of external libraries e.g. react, which are collapsed  by default.
      session_id: The toolbox session start time e.g. 13963.

Usage:
this.telemetry.recordEvent("devtools.main", "pause", "debugger", null, {
  reason: "debugger-statement",
  lib_stacks: "1",
  "session_id": toolbox.sessionId
});

Comment 5

[:Harald Kirschner :digitarald]

David, what's needed to get this over the finish line?

It would be great to extend the reason property to include the latest set of BP features, aka event, fetch and dom.

Comment 6

[David Walsh :davidwalsh]

Hard to say. I think we have more reasons now, like event breakpoints and DOM mutation. I also don't know how difficult getting "lib_stacks" will be, as pausing and component display are two different things. This hasn't been in the debugger-mvp sprint stuff so I haven't looked at this in ages.

Comment 7

[:Harald Kirschner :digitarald]

David, with Event BPs and DOM BPs shipping now, is there a chance to get this in for 70 so we can start to understand their usage? We did talk about this before. If it is not too invasive, we can also tackle this later and uplift; giving us more time to test-drive it if its risky.

Comment 8

[David Walsh :davidwalsh]

Attachment: Bug 1463118 - Implement telemetry for pausing r=jlast

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ce0bf8048da8
Implement telemetry for pausing r=jlast

Comment 10

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/ce0bf8048da8

Comment 11

[David Walsh :davidwalsh]

Clearing NI, this has landed