1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml

Status: RESOLVED FIXED

(Firefox :: Settings UI, enhancement, P3)

Description

[Fischer [:Fischer]]

Attachment: Telemetry_dashboard_FX_PREFERENCES_OPENED_VIA.png

From the Telemetry_dashboard_FX_PREFERENCES_OPENED_VIA.png, we can find over 50% origins that open about:preferences belong to "other" category. This is an interesting topic. Now in the code base there are 2 places (at least can find till now) which don't express its `origin` when calling `openPreferences`. We should track these places' origins. 

The 2 places are
1. https://searchfox.org/mozilla-central/rev/b24e6342d744c5a83fab5c15972e11eeb69d68e6/browser/tools/mozscreenshots/mozscreenshots/extension/configurations/Preferences.jsm#70

2. https://searchfox.org/mozilla-central/rev/b24e6342d744c5a83fab5c15972e11eeb69d68e6/browser/base/content/urlbarBindings.xml#1649

Comment 1

[Fischer [:Fischer]]

Attachment: search-suggestions-change-settings.png

Comment 2

[Fischer [:Fischer]]

(In reply to Fischer [:Fischer] from comment #0)
> Created attachment 8939742 [details]
> Telemetry_dashboard_FX_PREFERENCES_OPENED_VIA.png
> 
> From the Telemetry_dashboard_FX_PREFERENCES_OPENED_VIA.png, we can find over
> 50% origins that open about:preferences belong to "other" category. This is
> an interesting topic. Now in the code base there are 2 places (at least can
> find till now) which don't express its `origin` when calling
> `openPreferences`. We should track these places' origins. 
> 
> The 2 places are
> 1. https://searchfox.org/mozilla-central/rev/b24e6342d744c5a83fab5c15972e11eeb69d68e6/browser/tools/mozscreenshots/mozscreenshots/extension/configurations/Preferences.jsm#70
> 
> 2. https://searchfox.org/mozilla-central/rev/b24e6342d744c5a83fab5c15972e11eeb69d68e6/browser/base/content/urlbarBindings.xml#1649

The #2 is the "change preferences" on the right side of the search-tip bar, see attachment 8939744 [details] search-suggestions-change-settings.png

Comment 3

[Fischer [:Fischer]]

Attachment: Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

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

Comment 4

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8939760 [details]
Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

https://reviewboard.mozilla.org/r/210064/#review215892

::: toolkit/components/telemetry/Histograms.json:6557
(Diff revision 1)
>      "record_in_processes": ["main", "content"],
>      "bug_numbers": [1330315, 1420062],
>      "alert_emails": ["[e-mail]"],
>      "expires_in_version": "63",
>      "kind": "categorical",
> -    "labels": ["aboutHome", "aboutTelemetry", "browserMedia", "commandLine", "commandLineLegacy", "ContainersCommand", "contentSearch", "dataReporting", "doorhanger", "devDisconnectedAlert", "experimentsOpenPref", "fxa", "fxaSignedin", "fxaError", "offlineApps", "prefserviceDefaults", "preferencesButton", "paneSync", "storagePressure", "translationInfobar", "UITour", "menubar", "notifOpenSettings", "other", "autofillFooter", "autofillDoorhanger"],
> +    "labels": ["aboutHome", "aboutTelemetry", "browserMedia", "commandLine", "commandLineLegacy", "ContainersCommand", "contentSearch", "dataReporting", "doorhanger", "devDisconnectedAlert", "experimentsOpenPref", "fxa", "fxaSignedin", "fxaError", "offlineApps", "prefserviceDefaults", "preferencesButton", "paneSync", "storagePressure", "translationInfobar", "UITour", "menubar", "notifOpenSettings", "other", "autofillFooter", "autofillDoorhanger", "mozscreenshots", "searchSuggestionChangeSettings"],

Adding new labels here causes bug 1403994 which makes querying the previous data show a large "spill".

Frank, is there anything we can do if we want to add new categories but not hit bug 1403994?

Comment 5

[Frank Bertsch [:frank]]

(In reply to Jared Wein [:jaws] (please needinfo? me) from comment #4)
> 
> Frank, is there anything we can do if we want to add new categories but not
> hit bug 1403994?

Unfortunately no. The workaround is to look at before and after the change separately, since then there won't be any confusion about non-spill vs. spill buckets (e.g. if you add a new bucket on build 20180110xxx, look at <20180110 and >=20180110 separately in the measurement view).

Comment 6

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8939760 [details]
Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

https://reviewboard.mozilla.org/r/210064/#review216832

Comment 7

[Jared Wein [:jaws] (please needinfo? me)]

Comment on attachment 8939760 [details]
Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

liuche, can you do a data-review for the telemetry histogram change?

Comment 8

[Fischer [:Fischer]]

Attachment: 1427973_data_review

Comment 9

[Fischer [:Fischer]]

(In reply to Jared Wein [:jaws] (please needinfo? me) from comment #7)
> Comment on attachment 8939760 [details]
> Bug 1427973 - Should track the origins of `openPreferences` from
> mozscreenshots and urlbarBindings.xml,
> 
> liuche, can you do a data-review for the telemetry histogram change?

Sorry, forgot to send data-review request. Will send one right away.

Comment 10

[Fischer [:Fischer]]

Comment on attachment 8940928 [details]
1427973_data_review

Hi Chenxia,
Would you help on this data review? 

We basically want to record 2 more traffic origins, the mozscreenshot tool and the "change settings" link on the searh tip bar, which open to about:preferences

Thank you

Comment 11

[Chenxia Liu [:liuche]]

Comment on attachment 8940928 [details]
1427973_data_review

data-review r+, adds instrumentation for additional entry points to about:preferences. Adds labels to categorical histogram, and is still under 50 labels.

https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#changing-a-histogram

---
> Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate? (see here, here, and here for examples). Refer to the appendix for "documentation" if more detail about documentation standards is needed.

Yes, in Histograms.js

> Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.

Yes, Firefox data collection controls

> Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under? **

Type 2, interaction data

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

Default on

> 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

> Is the data collection covered by the existing Firefox privacy notice?

Yes

> Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**

Probe will expire in 63

Comment 12

[Chenxia Liu [:liuche]]

Comment on attachment 8939760 [details]
Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

data-review+ from me

Comment 13

[Fischer [:Fischer]]

My try[1] failed because
```
[task 2018-01-10T10:57:47.108Z] 10:57:47     INFO -  Label values for "FX_PREFERENCES_OPENED_VIA" exceed length limit of 20: searchSuggestionChangeSettings
[task 2018-01-10T10:57:47.108Z] 10:57:47     INFO -  Some errors occurred
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  Exception KeyError: KeyError(140276814350080,) in <module 'threading' from '/usr/lib/python2.7/threading.pyc'> ignored
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  backend.mk:23: recipe for target 'TelemetryHistogramData.inc' failed
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  gmake[4]: *** [TelemetryHistogramData.inc] Error 1
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  gmake[4]: Leaving directory '/builds/worker/workspace/build/src/obj-firefox/toolkit/components/telemetry'
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  /builds/worker/workspace/build/src/config/recurse.mk:100: recipe for target 'toolkit/components/telemetry/export' failed
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  gmake[3]: *** [toolkit/components/telemetry/export] Error 2
[task 2018-01-10T10:57:47.109Z] 10:57:47     INFO -  gmake[3]: *** Waiting for unfinished jobs....
[task 2018-01-10T10:57:47.647Z] 10:57:47     INFO -  gmake[4]: Entering directory '/builds/worker/workspace/build/src/obj-firefox/netwerk/dns'
```

The "searchSuggestionChangeSettings" category name is too long. Have to change to another one.

[1] https://treeherder.mozilla.org/#/jobs?repo=try&revision=b18afe85d007cfb9838508c84fc1dda2d93e2d82

Comment 14

[Fischer [:Fischer]]

Comment on attachment 8939760 [details]
Bug 1427973 - Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml,

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

Comment 15

[Fischer [:Fischer]]

(In reply to Fischer [:Fischer] from comment #14)
> Comment on attachment 8939760 [details]
> Bug 1427973 - Should track the origins of `openPreferences` from
> mozscreenshots and urlbarBindings.xml,
> 
> Review request updated; see interdiff:
> https://reviewboard.mozilla.org/r/210064/diff/1-2/
Try looks good.
https://treeherder.mozilla.org/#/jobs?repo=try&revision=620f4dd0fe7fcae9fb97edf1368538382e7cf558&selectedJob=155542370

Comment 16

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/d9340e521bc0
Should track the origins of `openPreferences` from mozscreenshots and urlbarBindings.xml, r=jaws

Comment 17

[Noemi Erli[:noemi_erli]]

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