1603539 - Add FxR PC installation telemetry in Gecko

Status: RESOLVED FIXED

(Core :: WebVR, task)

Description

[Daosheng Mu[:daoshengmu]]

Attachment: additional category 1 telemetry

We would like to collect some installation info from users for FxR PC product.

The requirements are as below.

• FXR_FF_INSTALLATION_FROM
  We wanna use this to understand if FF is installed at user's PC already, or they are new installation from our distribution channels.

"kind": "categorical" : "User", "FxR", "HTC", "Valve"

• FXR_ENTRY_METHOD
  We wanna understand how users enter Firefox Reality

"kind": "categorical" : "SysBtn", "Library", "Gaze"

• FXR_IS_FIRST_RUN
  Because we don't have a mechanism to determine if users are first run our FxR (we are intent to use the original profile that users are using.), so we would like to send a ping when users are doing the first run.

"kind": "boolean"

Comment 1

[Daosheng Mu[:daoshengmu]]

Attachment: Bug 1603539 - Part 1: Add Firefox Reality PC installation telemetry.

Comment 2

[Daosheng Mu[:daoshengmu]]

Attachment: Bug 1603539 - Part 2: Sending telemetry via VR shared memory.

Comment 3

[Daosheng Mu[:daoshengmu]]

Request for data collection review form

All questions are mandatory. You must receive review from a data steward peer on your responses to these questions before shipping new data collection.

What questions will you answer with this data?

• Understand if FF is installed at user's PC already, or they are new installation from our distribution channels.
• Understand how users enter Firefox Reality.
• Determine if users are first time to run our FxR.

Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements? Some example responses:

• Establish baselines or measure changes in product or platform quality or performance.
• Help Mozilla understand how users start to use this new product and how they get it.

What alternative methods did you consider to answer these questions? Why were they not sufficient?

• Nope. We don't have any telemetry is related with FxR PC product. We would like to use these data to understand how users launch our product.

Can current instrumentation answer these questions?

• Nope. We didn't have any data be collected before.

List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories found on the Mozilla wiki.
data collection categories on the Mozilla wiki.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.
Measurement Description Data Collection Category Tracking Bug #
FXR_FF_INSTALLATION_FROM category 2 1603539
FXR_ENTRY_METHOD category 2 1603539
FXR_IS_FIRST_RUN category 2 1603539

How long will this data be collected? Choose one of the following:

I want this data to be collected for 6 months initially (potentially renewable).

What populations will you measure?
Users who are interested in WebXR.

Which release channels?
Nightly, beta & release; no filters.

Which countries?
no filters

Which locales?
no filters

Any other filters? Please describe in detail below.
no filters

If this data collection is default on, what is the opt-out mechanism for users?
about:preferences#privacy

Please provide a general description of how you will analyze this data.
We wanna use these data to understand how they get our FxR PC product and how they use FxR PC.

Where do you intend to share the results of your analysis?
Within the team

Is there a third-party tool (i.e. not Telemetry) that you are proposing to use for this data collection? If so:
Nope.

Are you using that on the Mozilla backend? Or going directly to the third-party?
Nope.

Comment 4

[Daosheng Mu[:daoshengmu]]

Please help data review.

Comment 5

[Daosheng Mu[:daoshengmu]]

Try looks good, https://treeherder.mozilla.org/#/jobs?repo=try&revision=adbe608b1190c16f95f3af775424d3a47df7f859. Once data review approved, then we can land.

Comment 6

[Chris H-C :chutten]

Attachment: data review request

PRELIMINARY NOTES:

For future data review requests, please attach the data review as a text attachment to the bug and set the data-review? flag. That interacts more nicely with Data Stewardship's tooling (such as it is) and makes it easier to find approvals in future.

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 files Histograms.json and Scalars.yaml as well as the Probe Dictionary.

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?

No. This collection will expire in Firefox 79.

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

Category 2, Interaction.

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?

Yes. Daosheng Mu is responsible for renewing or removing the collection before it expires in Firefox 79.

---

Result: datareview+

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/75348f5742c6
Part 1: Add Firefox Reality PC installation telemetry. r=chutten
https://hg.mozilla.org/integration/autoland/rev/eb9ff96b66d7
Part 2: Sending telemetry via VR shared memory. r=kip,thomasmo,chutten

Comment 8

[Raul Gurzau (:RaulG)]

Backed out 2 changesets (bug 1603539) for build bustage at VRManager.cpp on a CLOSED TREE.

Backout link: https://hg.mozilla.org/integration/autoland/rev/7c72c59fa3bb1ed838ff786c5a4e28d23dca4621

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception&revision=eb9ff96b66d720295c5bd94a4a4c14a393054f37&selectedJob=282425841

Log link: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=282425841&repo=autoland&lineNumber=41769

Log snippet:

[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - make[4]: Entering directory '/builds/worker/workspace/build/src/obj-firefox/gfx/vr'
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - /builds/worker/fetches/sccache/sccache /builds/worker/fetches/gcc/bin/g++ -std=gnu++17 -o VRManager.o -c -I/builds/worker/workspace/build/src/obj-firefox/dist/stl_wrappers -I/builds/worker/workspace/build/src/obj-firefox/dist/system_wrappers -include /builds/worker/workspace/build/src/config/gcc_hidden.h -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=2 -fstack-protector-strong -DDEBUG=1 -DOS_POSIX=1 -DOS_LINUX=1 -DSTATIC_EXPORTABLE_JS_API -DMOZ_HAS_MOZGLUE -DMOZILLA_INTERNAL_API -DIMPL_LIBXUL -I/builds/worker/workspace/build/src/gfx/vr -I/builds/worker/workspace/build/src/obj-firefox/gfx/vr -I/builds/worker/workspace/build/src/dom/base -I/builds/worker/workspace/build/src/gfx/layers/d3d11 -I/builds/worker/workspace/build/src/gfx/thebes -I/builds/worker/workspace/build/src/obj-firefox/ipc/ipdl/_ipdlheaders -I/builds/worker/workspace/build/src/ipc/chromium/src -I/builds/worker/workspace/build/src/ipc/glue -I/builds/worker/workspace/build/src/obj-firefox/dist/include -I/builds/worker/workspace/build/src/obj-firefox/dist/include/nspr -I/builds/worker/workspace/build/src/obj-firefox/dist/include/nss -fPIC -DMOZILLA_CLIENT -include /builds/worker/workspace/build/src/obj-firefox/mozilla-config.h -Wall -Wempty-body -Wignored-qualifiers -Woverloaded-virtual -Wpointer-arith -Wsign-compare -Wtype-limits -Wunreachable-code -Wwrite-strings -Wno-invalid-offsetof -Wduplicated-cond -Wimplicit-fallthrough -Wno-error=maybe-uninitialized -Wno-error=deprecated-declarations -Wno-error=array-bounds -Wno-error=coverage-mismatch -Wno-error=free-nonheap-object -Wformat -Wformat-overflow=2 -D_GLIBCXX_USE_CXX11_ABI=0 -fno-sized-deallocation -fno-aligned-new -fno-exceptions -fno-strict-aliasing -fno-rtti -ffunction-sections -fdata-sections -fno-exceptions -fno-math-errno -pthread -pipe -g -freorder-blocks -Os -fno-omit-frame-pointer -funwind-tables -Werror -I/builds/worker/workspace/build/src/obj-firefox/dist/include/cairo -I/builds/worker/workspace/build/src/widget/gtk/compat-gtk3 -pthread -I/usr/include/gtk-3.0 -I/usr/include/pango-1.0 -I/usr/include/gio-unix-2.0/ -I/usr/include/atk-1.0 -I/usr/include/cairo -I/usr/include/gdk-pixbuf-2.0 -I/usr/include/freetype2 -I/usr/include/glib-2.0 -I/usr/lib/x86_64-linux-gnu/glib-2.0/include -I/usr/include/pixman-1 -I/usr/include/libpng12 -I/usr/include/gtk-3.0/unix-print -MD -MP -MF .deps/VRManager.o.pp /builds/worker/workspace/build/src/gfx/vr/VRManager.cpp
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - In file included from /builds/worker/workspace/build/src/obj-firefox/dist/include/nsDebug.h:14:0,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - from /builds/worker/workspace/build/src/obj-firefox/dist/include/nsISupportsUtils.h:13,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - from /builds/worker/workspace/build/src/obj-firefox/dist/include/nsISupports.h:79,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - from /builds/worker/workspace/build/src/obj-firefox/dist/include/nsIObserver.h:10,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - from /builds/worker/workspace/build/src/gfx/vr/VRManager.h:10,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - from /builds/worker/workspace/build/src/gfx/vr/VRManager.cpp:7:
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - /builds/worker/workspace/build/src/gfx/vr/VRManager.cpp: In member function 'void mozilla::gfx::VRManager::ProcessTelemetryEvent()':
[task 2019-12-23T19:39:24.579Z] 19:39:24 ERROR - /builds/worker/workspace/build/src/gfx/vr/VRManager.cpp:451:49: error: comparison of constant '1' with boolean expression is always true [-Werror=bool-compare]
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - MOZ_ASSERT(telemetryState.firstRunValue <= 0x01,
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - ^
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - /builds/worker/workspace/build/src/obj-firefox/dist/include/mozilla/Assertions.h:445:58: note: in definition of macro 'MOZ_VALIDATE_ASSERT_CONDITION_TYPE'
[task 2019-12-23T19:39:24.579Z] 19:39:24 INFO - mozilla::detail::AssertionConditionType<decltype(x)>::isValid,
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - ^
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - /builds/worker/workspace/build/src/obj-firefox/dist/include/mozilla/Assertions.h:482:31: note: in expansion of macro 'MOZ_ASSERT_HELPER2'
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - #define MOZ_ASSERT_GLUE(a, b) a b
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - ^
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - /builds/worker/workspace/build/src/obj-firefox/dist/include/mozilla/Assertions.h:490:5: note: in expansion of macro 'MOZ_ASSERT_GLUE'
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - MOZ_ASSERT_GLUE(
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - ^~~~~~~~~~~~~~~
[task 2019-12-23T19:39:24.580Z] 19:39:24 INFO - /builds/worker/workspace/build/src/gfx/vr/VRManager.cpp:451:9: note: in expansion of macro 'MOZ_ASSERT'
[task 2019-12-23T19:39:24.581Z] 19:39:24 INFO - MOZ_ASSERT(telemetryState.firstRunValue <= 0x01,

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/8dc1a23fa7bb
Part 1: Add Firefox Reality PC installation telemetry. r=chutten
https://hg.mozilla.org/integration/autoland/rev/7c54aff52b6f
Part 2: Sending telemetry via VR shared memory. r=kip,thomasmo,chutten

Comment 10

[Cristina Coroiu [:ccoroiu]]

https://hg.mozilla.org/mozilla-central/rev/8dc1a23fa7bb
https://hg.mozilla.org/mozilla-central/rev/7c54aff52b6f

Comment 11

[Daosheng Mu[:daoshengmu]]

Clear my ni.