Document Data Collection from telemetry services

[cvan]

Parent issue: #165
Related issues:

• submit a Request for Data Collection Review (to Mozilla Data Metrics team) #168 for submitting a Request for Data Collection Review (to Mozilla Data Metrics team)
• add default, opt-out Google Analytics script for collecting generic usage information #169 for adding GA usage data,
• collect default, opt-out basic performance timing data in Google Analytics (as custom GA events) #170 for adding GA perf data,
• Create a Sentry account for catching JavaScript errors #166 for adding Sentry for catching JS errors,
• Add a Help button (with icon and label text) and modal blurb to WebVR Template's on-page UI #167 for building the Help modal

[cvan]

This is not at all the copy/text I want to leave, but we should have three options that more eloquently describe these types of default telemetry we're offering:

1. Automatically submit anonymous errors when encountered (JavaScript errors caught by Sentry via Raven.js)
2. Automatically submit anonymous general usage/visit information (counter for MAU, DAU; via Google Analytics)
3. Automatically submit performance metrics (via Google Analytics)

[cvan]

Documented here: https://github.com/MozillaReality/metrics/#webxr-metrics

[cvan]

Actually, will reopen this to have this documented in the telemetry branch.

[cvan]

Eventually will move this to a separate, remote hosted URL (current work in progress)

I'm waiting until I get final copy from Legal team. This is the text I'd like to add to the README.md for the telemetry branch.

WebXR Metrics

Help improve the WebXR API ecosystem and community by sending usage statistics, performance metrics, and JavaScript errors to the Mozilla Mixed Reality team.

Telemetry Usage

To opt in to telemetry (i.e., collecting usage statistics, performance metrics, and catching errors) it in your WebXR site, simply include this snippet of JavaScript code in your HTML (ideally, immediately before the </head> or before </body>):

Or this:

<script src="lib/telemetry.js"></script>
<script>
// Telemetry for collecting basic usage statistics, handling errors, and performance metrics.
(function () {
  MozillaResearch.telemetry.start({
    analytics: true,
    errorLogging: true,
    performance: true
  });
  MozillaResearch.telemetry.performance.mark('LoaderParsingStart');
</script>

[cvan]

done! thanks, @delapuente (and Mika, and Legal, and Nancy)!

• https://github.com/mozilla/unity-webvr-export/tree/telemetry#developer-privacy-notice-for-data-collection
• https://github.com/mozilla/unity-webvr-export/blob/telemetry/TELEMETRY.md