Skip to content
This repository was archived by the owner on Jul 22, 2024. It is now read-only.

Commit 84bc060

Browse files
committed
Issues addressed
1 parent 3d138e8 commit 84bc060

File tree

4 files changed

+53
-10
lines changed

4 files changed

+53
-10
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ Reach out to us with any questions you may have or help you may need, and partic
7676

7777
## Developer Privacy Notice for Data Collection
7878

79-
To help improve the WebVR API and the WebVR Export assets, Mozilla automatically receives technical, interaction, and error data of end users, using [Sentry](https://sentry.io) and [Google Analytics](https://analytics.google.com/analytics/web/). For example, this includes number of times VR device is mounted and worn; number of times VR mode is enabled and time spent; time for webpages to load and time open; and a unique browser identifier.
79+
To help improve the WebVR API and the [Unity WebVR assets](https://assetstore.unity.com/packages/templates/systems/webvr-assets-109152), Mozilla automatically receives [general-usage statistics](./TELEMETRY.md#list-of-collected-data) and error exceptions of end users, using [Sentry](https://sentry.io) and [Google Analytics](https://analytics.google.com/analytics/web/).
8080

81-
Developers can turn off this data collection by [modifying the configuration snippet that comes with the VR template](./docs/customization/disabling-telemetry.md).
81+
Developers can turn off this data collection by [modifying the configuration snippet that comes with the VR template](./docs/customization/disabling-telemetry.md).
8282

8383
End users can turn off this data collection by enabling [`Do-Not-Track`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DNT) in their browsers.
8484

@@ -88,7 +88,6 @@ This project was heavily influenced by early explorations in using Unity to buil
8888

8989
Also, thanks to [@arturitu](https://github.com/arturitu) for creating the [3D-hand models](https://github.com/aframevr/assets/tree/gh-pages/controllers/hands) used for controllers in these examples.
9090

91-
9291
## License
9392

9493
Copyright 2017 - 2018 Mozilla Corporation

TELEMETRY.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Developer Privacy Notice for Data Collection
2+
3+
To help improve the WebVR API and the [Unity WebVR assets](https://assetstore.unity.com/packages/templates/systems/webvr-assets-109152), Mozilla automatically receives general-usage statistics and error exceptions of end users, using [Sentry](https://sentry.io) and [Google Analytics](https://analytics.google.com/analytics/web/).
4+
5+
Developers can turn off this data collection by [modifying the configuration snippet that comes with the VR template](./docs/customization/disabling-telemetry.md).
6+
7+
End users can turn off this data collection by enabling [`Do-Not-Track`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DNT) in their browsers.
8+
9+
## List of Collected Data
10+
11+
- Unique UUID-v4 random identifier (generated according to [IETF RFC4122](http://www.ietf.org/rfc/rfc4122.txt)), persisted in the browser's [`LocalStorage`](https://developer.mozilla.org/en-US/docs/Web/API/Storage/LocalStorage)
12+
- JavaScript error (exception) messages (without file paths)
13+
- Console messages (i.e., error, warning, log, info)
14+
- Respects [Do-Not-Track](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/DNT) (i.e., `DNT: 1` HTTP header and `navigator.doNotTrack === '1'` JavaScript value)
15+
- Dimensions (width × height) of the browser's `screen` and `window`, ratio of the resolution (i.e., `navigator.devicePixelRatio`)
16+
- Release version of the [Unity WebVR Assets](https://github.com/mozilla/unity-webvr-export) package being used (e.g., [`v1.0.1`](https://github.com/mozilla/unity-webvr-export/releases/tag/v1.0.1))
17+
- JavaScript Heap memory used (measured in megabytes)
18+
- [WebXR API](https://immersive-web.github.io/webxr/spec/latest/) support (i.e., `navigator.xr`)
19+
- [WebVR v1.1 API](https://immersive-web.github.io/webvr/spec/1.1/) support (i.e., `navigator.getVRDisplays`)
20+
- [WebVR v1.1 events](https://immersive-web.github.io/webvr/spec/1.1/#interface-window) emitted by the browser (i.e., user-initiated actions and headset events) during a unique page load:
21+
- Number of times and time until VR mode is entered (e.g., user keypress, user click, automatically presented)
22+
- Number of times and time until VR mode is exiting (e.g., user keypress, user click, automatically exited, browser's Back button, browser's navigation to another page, etc.)
23+
- Number of times and time until a VR device is worn/mounted
24+
- Number of times and time until a VR device is taken off/unmounted
25+
- Number of times and time until a VR device has been connected (or detected on page load)
26+
- Number of times and time until a VR device has been disconnected/unplugged
27+
- Number of times and time until a mouse cursor is temporarily disabled for input while "pointerlocked" in VR mode (e.g., for Windows Mixed Reality's desktop flat-pane views)
28+
- Number of times and time until a mouse cursor is temporarily disabled for input while "pointerlocked" in VR mode (e.g., for Windows Mixed Reality's desktop flat-pane views)
29+
- Amount of time the active page took to load and to reach:
30+
- Loading screen
31+
- Splash screen
32+
- Unity game
33+
- Amount of time the active page was open for ("session length")
34+
- Browser's `User-Agent` string (i.e., `navigator.userAgent`)
35+
- [WebGL 1.0 API](https://www.khronos.org/registry/webgl/specs/latest/1.0/) support
36+
- [WebGL 2.0 API](https://www.khronos.org/registry/webgl/specs/latest/2.0/) support
37+
- [Gamepad API](https://w3c.github.io/gamepad/)
38+
- Support of API (i.e., `navigator.getGamepads`)
39+
- Names of connected gamepads (i.e., `Gamepad#id`)
40+
- [Web Audio API](https://webaudio.github.io/web-audio-api/) support (i.e., `AudioContext`)
41+
- [WebAssembly (WASM) API](http://webassembly.org) support (i.e., `WebAssembly`)
42+
- [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) support (i.e., `Worker`)
43+
- [Service Worker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) (i.e., `navigator.serviceWorker`)
44+
- [`requestIdleCallback` API](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) (i.e., `window.requestIdleCallback`)

docs/customization/adding-ga.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Google Analytics is a popular web analytics service that tracks and reports website traffic. It offers insight about your user behaviour and allows you to make informed decisions regarding the evolution of your site.
44

5-
The [VR template](../../Assets/WebGLTemplates/WebVR/index.html) that comes with the [Unity package](https://u3d.as/1476) already includes Analytics as a part of the telemetry library used for [collecting usage data](../data-collection.md) but you'll need to set up a Google Analytics account and get a [tracking Id](https://support.google.com/analytics/answer/7372977) first, before using it.
5+
The [VR template](../../Assets/WebGLTemplates/WebVR/index.html) that comes with the [Unity package](https://u3d.as/1476) already includes Analytics as a part of the telemetry library used for [collecting usage data](../data-collection.md) but you'll need to set up a Google Analytics account and get a [Tracking ID](https://support.google.com/analytics/answer/7372977) first, before using it.
66

77
## Quick set up
88

@@ -42,7 +42,7 @@ ga('create', 'UA-XXXXXX-Y', 'auto');
4242
ga('send', 'pageview');
4343
```
4444

45-
When using Analytics inside the template, use the `create` method of `MozillaReasearch.telemetry.ga` instead of the `create` command. It will return a tracking function which can be used in the same way you would use it in the guide [Sending Data to Google Analytics.](https://developers.google.com/analytics/devguides/collection/analyticsjs/creating-trackers)
45+
When using Analytics inside the template, use the `create` method of `MozillaReasearch.telemetry.ga` instead of the `create` command. It will return a tracking function which can be used in the same way you would use it in the guide [Sending Data to Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/creating-trackers).
4646

4747
```js
4848
var ga = MozillaResearch.telemetry.ga.create('UA-XXXXXX-Y', 'auto');

docs/customization/disabling-telemetry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Disabling telemetry
1+
# Disabling Telemetry
22

3-
The code enabling telemetry data collection is in the VR template that comes with the package. Ensure you've already added [the package from the store](https://u3d.as/1476) to your Unity project and look for the following snippet inside the [`index.html` file](../../Assets/WebGLTemplates/WebVR/index.html) of the template:
3+
The code that enables Mozilla-Research Telemetry collection is in the VR template that comes with the package. Ensure you've already added [the package from the store](https://u3d.as/1476) to your Unity project and look for the following snippet inside the [`index.html` file](../../Assets/WebGLTemplates/WebVR/index.html) of the template:
44

55
```js
66
MozillaResearch.telemetry.start({
@@ -10,9 +10,9 @@ MozillaResearch.telemetry.start({
1010
});
1111
```
1212

13-
By default, collecting number of visits, error logs and some performance measurements is enabled by setting the proper options (`analytics`, `errorLogging` and `performance` respectively) to `true`.
13+
By default, each, number of visits, error logs and some performance measurements are enabled by setting the proper option (`analytics`, `errorLogging` and `performance` respectively) to `true`.
1414

15-
To prevent the template from sending such information, set the corresponding options to `false`:
15+
To prevent the template from sending such information, set the appropiate options to `false`:
1616

1717
```js
1818
MozillaResearch.telemetry.start({
@@ -22,7 +22,7 @@ MozillaResearch.telemetry.start({
2222
});
2323
```
2424

25-
Or remove/comment the line completely:
25+
Or by commenting out these lines, or removing the code completely from the `index.html` file:
2626

2727
```js
2828
/*MozillaResearch.telemetry.start({

0 commit comments

Comments
 (0)