1198164 - [Metrics] FTU ping should include info on whether User opt-in for metrics

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Stability, defect)

Description

[Ravi Dandu]

During the FTU process, User can chooses to opt-out of Metric collection. The FTU ping should contain this info of whether User opt-out out of Metric collection. This helps better estimation of monthly active users.

Comment 1

[Merwin]

Ravi,

When you say opt-out of metric collection, you mean turn off the app usage ping, correct?  Can you make sure that you and Jonas, as the Data Stewards, sign off on this addition to the FTU ping?  

Marshall

Comment 2

[Ravi Dandu]

Marshall, Yes, this is on the agenda for next data stewards meeting.

Comment 3

[Tamara Hills [:thills]]

Dominik/Ravi,

Since it looks like we are going with Option 7 in Bug 1181295, how is something like this for the additional flag in the payload:

{
 .
 .
 .
 "metricsLevel: "none|basic|advanced"
 .
 .
 .
}

Comment 4

[:Dominik Strohmeier [:dstrohmeier]]

Looks good to me. Just to understand: metricsLevel: none would be that no data is shared, i.e. full opt-out, correct?

Comment 5

[Ravi Dandu]

Tamara, metricsLevel: "none|basic|enhanced" (enhanced instead of advanced).

"none" is no data is collected. i.e full opt-out.

Comment 6

[Tamara Hills [:thills]]

Dominik/Dave,

Is this modification to FTU format ok?  I added the metricsLevel there.  I think it will be good to start tracking this.  Values will be as per Ravi's Comment 5.

{
  "ver": 1,
  "info": {
    "screenHeight": 569,
    "screenWidth": 320,
    "devicePixelRatio": 1.5,
    "preinstalled": {
      "https:\/\/marketplace.firefox.com\/packaged.webapp": "Marketplace",
      ....
    },
    "activationTime": 1453937770044,
    "metricsLevel": "Enhanced",
    "deviceinfo.os": "2.6.0.0-prerelease",
    "deviceinfo.software": "Boot2Gecko 2.6.0.0-prerelease",
    "deviceinfo.product_model": "flame",
    "deviceinfo.firmware_revision": "",
    "deviceinfo.hardware": "qcom",
    "network": {
      "operator": "T-Mobile",
      "mnc": "260",
      "mcc": "310"
    },
    "icc": {
      "mnc": "260",
      "mcc": "310",
      "spn": null
    },
    "pingID": "EC22E144",
    "pingTime": 1453938072329,
    "locale": "en-US",
    "reason": "ftu",
    "appName": "FirefoxOS",
    "appUpdateChannel": "default",
    "appBuildID": "20160119113430",
    "appVersion": "46.0a1"
  }
}

Comment 7

[:Dominik Strohmeier [:dstrohmeier]]

Hi Tamara,
looks ok to me. That this will be a good enough way to track this and to get an idea about the general opt-in/activation ratio.

Comment 8

[GitHub Autolander Bot]

Attachment: [gaia] tamarahills:bugfix/1198164-Include-metricsLevel-in-FtuPing > mozilla-b2g:master

Comment 9

[Tamara Hills [:thills]]

Attachment: PR for 1198164

Hi Sam,

I'm wondering if you can take a look at my WIP changes to ftu_launcher.js.  Essentially, we want to capture the user's input on the metricsLevel and send it along with the Ftu ping.  They can either choose "none", "Basic", or "Enhanced".  This is the last step in the FTU.  However, the packet needs to be kicked off after the user has made the choice.

I don't see any bad implications to kicking the ensurePing function to the "finish" step, but wanted to check if you think there can be something i'm overlooking here.  From my testing, it appears there is no way to get out of the FTE without executing the "finish" function.

Thanks,
-tamara

Comment 10

[Sam Foster [:sfoster] (he/him)]

finish() is also called by this.service.request('FtuLauncher:skip'), i.e. every startup. Which I think is not what you want? If you want to ensure you get called only on first time use, after the user had made choices in the FTU UI, it looks like the close() method is a better place - which is called specifically when the FTU app has terminated.

Comment 11

[Tamara Hills [:thills]]

Thanks Sam.  That makes sense.

Comment 12

[Tamara Hills [:thills]]

Comment on attachment 8713210 [details] [review]
[gaia] tamarahills:bugfix/1198164-Include-metricsLevel-in-FtuPing > mozilla-b2g:master

Hi Russ,

Would you mind feedbacking this for me?  

Thanks,
-tamara

Comment 13

[Russ Nicoletti [:russn]]

Comment on attachment 8713210 [details] [review]
[gaia] tamarahills:bugfix/1198164-Include-metricsLevel-in-FtuPing > mozilla-b2g:master

lgtm, one nit.

Comment 14

[Tamara Hills [:thills]]

Comment on attachment 8713210 [details] [review]
[gaia] tamarahills:bugfix/1198164-Include-metricsLevel-in-FtuPing > mozilla-b2g:master

Hi Marshall,

This patch includes an element in the FtuPing to include what metricsLevel the user chose during the FTE.  They can choose None|Basic|Enhanced.
Thanks,
-tamara

Comment 15

[Marshall Culpepper [:marshall_law]]

Comment on attachment 8713210 [details] [review]
[gaia] tamarahills:bugfix/1198164-Include-metricsLevel-in-FtuPing > mozilla-b2g:master

Looks good, I just had a question about the naming of the constant in the pull request.

Comment 16

[Tamara Hills [:thills]]

Gij11 and Gij18 appear to be broken for a while, so I'll go ahead and merge.  I addressed Russ' and Marshall's suggestions.

https://treeherder.mozilla.org/#/jobs?repo=gaia&revision=6a3d65dad6155059bb52aab8548ba12cbe701aef&selectedJob=3489625

Thanks,
-tamara

Comment 17

[Tamara Hills [:thills]]

https://github.com/mozilla-b2g/gaia/commit/5be802ab00de3b93f4a5986b8573ca66ef475359