Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

For #1190: Adds telemetry for FxA login #2745

Merged
merged 2 commits into from
May 25, 2019

Conversation

sblatz
Copy link
Contributor

@sblatz sblatz commented May 22, 2019

Pull Request checklist

  • Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Changelog: This PR includes a changelog entry or does not need one
  • Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

@sblatz sblatz requested a review from a team as a code owner May 22, 2019 18:42
@sblatz
Copy link
Contributor Author

sblatz commented May 22, 2019

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.

  1. What questions will you answer with this data?
  • How often users sync in/out via Fenix (in comparison to other devices/apps)
  • If there any issues in the flow, drop off in funnel where/when people try to sync
  1. Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?
  • Sync/Accounts is part of our overall 2019 KPI goals and so we want to have instrumentation in place to understand how much Fenix is contributing to this goal.
  1. What alternative methods did you consider to answer these questions? Why were they not sufficient?
  • N/A (These are baseline metrics)
  1. Can current instrumentation answer these questions?
  • Currently no, as these are some of the first metrics we're recording
  1. List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories on the found on the Mozilla wiki.
  • All data is Category 2.
  1. How long will this data be collected?

Until 04/01/2020 (renewed thereafter)

  1. What populations will you measure?
  • All release, beta, and nightly users with telemetry enabled.
  1. Please provide a general description of how you will analyze this data.
  • Glean / Amplitude
  1. Where do you intend to share the results of your analysis?
  • Only on Glean, Amplitude and with mobile teams.

@@ -187,6 +187,7 @@ class SettingsFragment : PreferenceFragmentCompat(), CoroutineScope, AccountObse

private fun getClickListenerForSignIn(): OnPreferenceClickListener {
return OnPreferenceClickListener {
requireComponents.analytics.metrics.track(Event.SyncOpened)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're tracking this metric twice

app/metrics.yaml Outdated
@@ -732,4 +744,83 @@ error_page:
- https://github.com/mozilla-mobile/fenix/pull/2491#issuecomment-492414486
notification_emails:
- fenix-core@mozilla.com
expires: "2020-03-01"

sync:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we'll want to split this up into a account.auth flow and an account.settings flow. because

opened:
    type: event
    description: >
      A user opened the sync page

This event is really means opened the page to start the sign in flow to firefox account.

@@ -71,6 +76,7 @@ class AccountSettingsFragment : PreferenceFragmentCompat(), CoroutineScope {

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want telemetry when a user lands on this Fragment?

boek
boek previously requested changes May 23, 2019
Copy link
Contributor

@boek boek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of small nits about the structure. + Missing an event

@sblatz sblatz requested a review from boek May 24, 2019 15:28
@sblatz
Copy link
Contributor Author

sblatz commented May 24, 2019

Resolved your concerns, @boek!

Copy link
Contributor

@boek boek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Data Review Form (to be filled by Data Stewards)

  1. Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?
    Yes, in metrics.yaml

  2. Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.
    Yes, Fenix data controls

  3. If the request is for permanent data collection, is there someone who will monitor the data over time?**
    No, @vesta0 will monitor and it has expiry

  4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under? **
    Type 2, interaction sync authentication / account UI

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

  6. Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?
    No

  7. Is the data collection covered by the existing Firefox privacy notice?
    Yes

  8. Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**
    No, has expiry

  9. Does the data collection use a third-party collection tool? If yes, escalate to legal.
    No

@boek boek force-pushed the telemetry-for-FxA-login branch from 33d9254 to 83e30d9 Compare May 25, 2019 00:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants