1463117 - Instrument inspection of pausing behaviour in the Debugger with event telemetry

Status: NEW

(DevTools :: General, enhancement, P2)

Comment 1

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

Attachment: data-review.txt

Events.yaml:
devtools.main:
  pause_behaviour_changed:
    objects: ["debugger"],
    bug_numbers: [1463117]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: User has changed pausing behaviour in the debugger.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      exceptions: Pause on exceptions is checked.
      caught_exceptions: Pause on caught exceptions is checked.

Usage:
this.telemetry.recordEvent("devtools.main", "pause_behaviour_changed", "debugger", null, {
      exceptions: true
      caught_exceptions: false
});

Comment 2

[François Marier [:francois]]

Comment on attachment 8979218 [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]]

The name was too long so we changed it to "pause_on_exceptions":

this.telemetry.recordEvent("devtools.main", "pause_on_exceptions", "debugger", null, {
      exceptions: true
      caught_exceptions: false
});

Comment 4

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

The name was too long so we changed it to "pause_on_exceptions" and "caught_exceptions" is too long a field name so we need to use "caught_exceptio":

this.telemetry.recordEvent("devtools.main", "pause_on_exceptions", "debugger", null, {
      exceptions: true
      caught_exceptio: false
});

Comment 5

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

Events.yaml:
devtools.main:
  pause_on_exceptions:
    objects: ["debugger"]
    bug_numbers: [1463117]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: User has changed pausing behaviour in the debugger.
    release_channel_collection: opt-out
    expiry_version: never
    extra_keys:
      exceptions: Pause on exceptions is checked.
      caught_exceptio: Pause on caught exceptions is checked.
      session_id: The toolbox session start time e.g. 13963.

Usage:
this.telemetry.recordEvent("devtools.main", "pause_on_exceptions", "debugger", null, {
  "exceptions": true
  "caught_exceptio": false,
  "session_id": toolbox.sessionId
});