1567607 - add telemetry data for DoH usage

Status: RESOLVED FIXED

(Core :: Networking, enhancement, P1)

Description

[Nhi Nguyen (:nhi)]

add new telemetry data for DoH rollout

:tdsmith, please add a comment here if you need new probes to be implemented. (we have pref network.trr.mode for whether DoH is enabled or not)

Comment 1

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

I normally shouldn't own telemetry implementations, but I agree that exposing network.trr.mode to telemetry is what we need to do, it should be a one-line change, and I know how to do it, so I'm happy to take this.

Comment 2

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

Attachment: Bug 1567607 - Expose network.trr.mode to telemetry

Add the network.trr.mode pref, which reflects whether DNS over HTTPS is enabled or not, to the telemetry environment.

Comment 3

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

Attachment: Data collection review

Comment 4

[Teon Brooks [:teon]]

Comment on attachment 9079491 [details]
Data collection review

I just have a question about the documentation, do preferences in the telemetry environment get added to one of the definitions files? if so, does this fall under Scalar or a different file?

Comment 5

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

(In reply to Teon Brooks [:teon] from comment #4)

I just have a question about the documentation, do preferences in the
telemetry environment get added to one of the definitions files?

Hi Teon,

Thanks for the question! They do not.

The fact that userPrefs are collected is described here: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/environment.html#userprefs

There is no explicit documentation for most of the collected preferences, short of being listed in TelemetryEnvironment.jsm.

bug 1330856 exists to capture userPreference collection in a separate metadata file, which would facilitate the documentation plumbing. (I just opened bug 1567948 this morning to capture the need and then discovered the older bug.)

Some recent bugs with data-review for this mechanism include bug 1558856, bug 1514031, and bug 1485156.

Comment 6

[Teon Brooks [:teon]]

Comment on attachment 9079491 [details]
Data collection review

:tdsmith, thanks for the clarification

DATA COLLECTION REVIEW RESPONSE:

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

Yes. This collection is Telemetry so is documented in its definitions file [TelemetryEnvironment.jsm](https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/app/TelemetryEnvironment.jsm). 
There is [bug 1330856](https://bugzilla.mozilla.org/show_bug.cgi?id=1330856) that aims to make an explicit environment user pref yaml for ease of documentation.

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

Yes. This collection is Telemetry so can be controlled through Firefox's Preferences.

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

Yes, :tdsmith is responsible.

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

Category 1, Technical.

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

Default on for all channels.

    Does the instrumentation include the addition of any new identifiers?

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?

No. This collection is permanent.

---
Result: datareview

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e892c0929352
Expose network.trr.mode to telemetry r=janerik

Comment 8

[Noemi Erli[:noemi_erli]]

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

Comment 9

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

Comment on attachment 9079487 [details]
Bug 1567607 - Expose network.trr.mode to telemetry

Beta/Release Uplift Approval Request

• User impact if declined: No direct impact. We're hoping to deliver DNS over HTTPS to some audiences during the 69 cycle and this patch, which collects the value of the pref that controls TRR state, will help us understand how users are engaging with TRR.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Not risky; adds a pref to a list of prefs to report in the telemetry environment.
• String changes made/needed:

Comment 10

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9079487 [details]
Bug 1567607 - Expose network.trr.mode to telemetry

Adds a Telemetry probe for the network.trr.mode pref. Approved for 69.0b8.

Comment 11

[Stefan Hindli [:stefan_hindli]]

https://hg.mozilla.org/releases/mozilla-beta/rev/9fc885879ec5

Comment 12

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/telemetry-batch-view/pull/548