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

For #5094: Adds telemetry for suggestion toggles #5704

Merged

Conversation

sblatz
Copy link
Contributor

@sblatz sblatz commented Oct 1, 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
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not
  • Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

After merge

  • Milestone: Make sure issues finished by this pull request are added to the milestone of the version currently in development.

To download an APK when reviewing a PR:

  1. click on Show All Checks,
  2. click Details next to "Taskcluster (pull_request)" after it appears and then finishes with a green checkmark,
  3. click on the "Fenix - assemble" task, then click "Run Artifacts".
  4. the APK links should be on the left side of the screen, named for each CPU architecture

@sblatz
Copy link
Contributor Author

sblatz commented Oct 1, 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?
  • Do users want to see suggestions from search provider?
  • Do users want to see suggestions from their clipboard?
  • Do users want to see suggestions from their browsing history?
  • Do users want to see suggestions from their bookmarked sites?
  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?
  • We want to know if users choose to disable various types of awesomebar suggestions so we can improve its usability in future iterations.
  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 there are no events to track these preferences
  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 03/01/2020

  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.

@sblatz sblatz added the needs:data-review PR is awaiting a data review label Oct 1, 2019
@codecov-io
Copy link

codecov-io commented Oct 1, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@097d7c2). Click here to learn what that means.
The diff coverage is 0%.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #5704   +/-   ##
=========================================
  Coverage          ?   14.42%           
  Complexity        ?      323           
=========================================
  Files             ?      256           
  Lines             ?    10534           
  Branches          ?     1536           
=========================================
  Hits              ?     1520           
  Misses            ?     8891           
  Partials          ?      123
Impacted Files Coverage Δ Complexity Δ
...va/org/mozilla/fenix/components/metrics/Metrics.kt 25.35% <0%> (ø) 0 <0> (?)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 097d7c2...3338696. Read the comment docs.

Copy link
Contributor

@liuche liuche 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 in a public, complete, and accurate way?

Yes, in metrics.md generated by Glean from metrics.yaml

  1. Is there a control mechanism that allows the user to turn the data collection on and off?

Yes, from Fenix data settings

  1. If the request is for permanent data collection, is there someone who will monitor the data over time?

No, expires in 3/2020

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

Type 2

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

Default on

  1. 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, collecting preferences states

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

Yes

  1. 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)**

Has expiration

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

No

app/metrics.yaml Outdated
data_reviews:
- https://github.com/mozilla-mobile/fenix/pull/1896
- https://github.com/mozilla-mobile/fenix/pull/TODO
Copy link
Contributor

Choose a reason for hiding this comment

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

(Is the process that you update this after you get data-review, or when you open the PR?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When I do the PR I usually swap the "TODO" my bad for missing this one 😅

@liuche liuche removed the needs:data-review PR is awaiting a data review label Oct 3, 2019
@sblatz sblatz force-pushed the telemetry-for-suggestion-toggles branch from 648fdd7 to 3338696 Compare October 3, 2019 16:35
@sblatz sblatz merged commit e8216e3 into mozilla-mobile:master Oct 3, 2019
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.

3 participants