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

For #14565: Add telemetry for top sites #15136

Merged
merged 1 commit into from
Sep 17, 2020

Conversation

sblatz
Copy link
Contributor

@sblatz sblatz commented Sep 16, 2020

Pull Request checklist

  • 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. In addition, it includes a screenshot of a successful accessibility scan to ensure no new defects are added to the product.

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 Sep 16, 2020

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 do users interact with different types of top sites (frecency, pinned, default)?
  • Do users swipe on the carousel (are they aware of paginated top 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?

To measure how useful the different types of top sites are to users. It will help us prioritize top sites features, and help us understand if the carousel for top sites is understood by users or if we should reconsider that UX.

  1. What alternative methods did you consider to answer these questions? Why were they not sufficient?
  • We have events for other types of top sites actions, but none that distinguish between the types of top sites. Nor do we have any events for the carousel itself, which will be really helpful for us.
  1. Can current instrumentation answer these questions?
  • No, see above.
  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?

This data will be present collected until it expires as outlined in the metrics.md file.

  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.
  • Leanplum / Amplitude
  1. Where do you intend to share the results of your analysis?
  • Only on Leanplum, Amplitude and with mobile teams.

@sblatz sblatz requested review from ekager and liuche and removed request for ekager September 16, 2020 14:19
@sblatz sblatz added the needs:data-review PR is awaiting a data review label Sep 16, 2020
@sblatz sblatz force-pushed the frecency-top-sites-telemetry branch 2 times, most recently from 859d142 to 8191cf2 Compare September 16, 2020 14:42
@codecov-commenter
Copy link

codecov-commenter commented Sep 16, 2020

Codecov Report

Merging #15136 into master will decrease coverage by 0.00%.
The diff coverage is 15.38%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #15136      +/-   ##
============================================
- Coverage     29.22%   29.22%   -0.01%     
- Complexity     1161     1164       +3     
============================================
  Files           454      454              
  Lines         18541    18563      +22     
  Branches       2393     2397       +4     
============================================
+ Hits           5419     5425       +6     
- Misses        12745    12762      +17     
+ Partials        377      376       -1     
Impacted Files Coverage Δ Complexity Δ
...la/fenix/components/metrics/GleanMetricsService.kt 11.81% <0.00%> (-0.23%) 4.00 <0.00> (ø)
...ix/home/sessioncontrol/SessionControlInteractor.kt 68.18% <0.00%> (ø) 15.00 <0.00> (ø)
...ssioncontrol/viewholders/TopSitePagerViewHolder.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...java/org/mozilla/fenix/components/metrics/Event.kt 31.71% <16.66%> (-0.30%) 0.00 <0.00> (ø)
...ix/home/sessioncontrol/SessionControlController.kt 85.00% <50.00%> (-1.24%) 0.00 <0.00> (ø)
...trol/viewholders/topsites/TopSiteItemViewHolder.kt 20.83% <50.00%> (+1.68%) 2.00 <0.00> (ø)
...mponents/searchengine/FenixSearchEngineProvider.kt 63.96% <0.00%> (+1.80%) 14.00% <0.00%> (+1.00%)
...in/java/org/mozilla/fenix/settings/SupportUtils.kt 74.50% <0.00%> (+3.92%) 13.00% <0.00%> (+2.00%)

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 f43476c...05f48de. 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, metrics.yaml

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

Yes, fenix telemetry settings

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

No has expiry

  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, interaction with top sites and the carousel

  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, interaction with UI elements

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

No, has expiry

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

No

app/metrics.yaml Outdated Show resolved Hide resolved
app/metrics.yaml Outdated Show resolved Hide resolved
@sblatz sblatz force-pushed the frecency-top-sites-telemetry branch from 8191cf2 to 8839bd1 Compare September 17, 2020 16:09
@sblatz sblatz removed the needs:data-review PR is awaiting a data review label Sep 17, 2020
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.

4 participants