1463104 - Instrument inspection of object expansion in the Web Console with event telemetry

Status: RESOLVED FIXED

(DevTools :: Console, enhancement, P2)

Comment 1

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

Attachment: data-review.txt

Events.yaml:
devtools.main:
  object_expanded:
    objects: ["webconsole"],
    bug_numbers: [1463104]
    notification_emails: ["[e-mail]", "[e-mail]"]
    record_in_processes: ["main"]
    description: User has expanded an object in the web console.
    release_channel_collection: opt-out
    expiry_version: never

Usage:
this.telemetry.recordEvent("devtools.main", "object_expanded", "webconsole");

Comment 2

[:Harald Kirschner :digitarald]

Per discussion, put on hold until we figure out a low impact way for counting.

Comment 3

[:Harald Kirschner :digitarald]

ni Nicolas for scoping into 63

Comment 4

[Nicolas Chevobbe [:nchevobbe]]

Should this event logged only when object is expanded from the console ?
Since the ObjectInspector can be used in multiple components, we may either pass a very specific function to the components (like, logWebconsoleObjectExpandTelemetryEvent), or log in every panel and pass a prop to indicate which panel is using the ObjectInspector.

Also. should we log only expand ? Or should we also log collapsing ?

Comment 5

[:Harald Kirschner :digitarald]

> Should this event logged only when object is expanded from the console ?

Alternatively, reps get their own event category but we'd still want to know in which panels got expanded. So keeping in console for now should work fine (expanding in Debugger is not as critical as debugger has a lot more interactions).

> Also. should we log only expand ? Or should we also log collapsing ?

Expanding only is fine for a start.

Comment 6

[Nicolas Chevobbe [:nchevobbe]]

Attachment: Bug 1463104 - Instrument inspection of object expansion in the Web Console with event telemetry; .

This only adds the event in Events.yaml,
the actual work will happen in Github.

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

Comment 7

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

Comment on attachment 8995877 [details]
Bug 1463104 - Instrument inspection of object expansion in the Web Console with event telemetry; .

https://reviewboard.mozilla.org/r/260206/#review267620

r+ with the issue addressed.

::: toolkit/components/telemetry/Events.yaml:657
(Diff revision 1)
>      release_channel_collection: opt-out
>      expiry_version: never
>      extra_keys:
>        session_id: The start time of the session in milliseconds since epoch (Unix Timestamp) e.g. 1396381378123.
> +  object_expanded:
> +    objects: ["webconsole"],

You need to delete the comma or Firefox won't build.

Comment 8

[Nicolas Chevobbe [:nchevobbe]]

Comment on attachment 8995877 [details]
Bug 1463104 - Instrument inspection of object expansion in the Web Console with event telemetry; .

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

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/faa747d92f22
Instrument inspection of object expansion in the Web Console with event telemetry; r=miker.

Comment 10

[Daniel Varga [:dvarga]]

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

Comment 11

[Chris H-C :chutten]

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

This appears to have landed without Data Collection Review. I'll go ahead and reinstate the r?francois on the data review request.

Comment 12

[Nicolas Chevobbe [:nchevobbe]]

Ooops, my bad, I didn't check :/

Comment 13

[François Marier [:francois]]

Comment on attachment 8979210 [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, in 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.