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

For #11578 - Add telemetry for how many times we download something #16730

Merged
merged 1 commit into from
Dec 15, 2020
Merged

For #11578 - Add telemetry for how many times we download something #16730

merged 1 commit into from
Dec 15, 2020

Conversation

Mugurell
Copy link
Contributor

Pull Request checklist

  • Tests: This PR includes thorough tests.
  • Screenshots: No screenshots. No visual changes.
  • Accessibility: The code in this PR follows does not include any a11y user facing features.

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

@Mugurell Mugurell requested review from a team as code owners November 24, 2020 16:23
@Mugurell
Copy link
Contributor Author

Mugurell commented Nov 24, 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 often is the download feature used.

2) Why does Mozilla need to answer these questions? Are there benefits for users? Do we need this information to address product or business requirements?
This is important for appropriately prioritizing enhancing the download experience in relation to other features.

3) What alternative methods did you consider to answer these questions? Why were they not sufficient?
Theere is already telemetry for download notifications but there are other features inside the app that would leverage the download feature without notifications.
This is the only way to know when any download is started.

4) Can current instrumentation answer these questions?
No. See the above.

5) List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox data collection categories found on the Mozilla wiki.

Note that the data steward reviewing your request will characterize your data collection based on the highest (and most sensitive) category.

Measurement Description Data Collection Category Tracking Bug #
Count started downloads Category 2 https://github.com//issues/11578

6) Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
This collection is documented in the metrics.md document document included in the project - https://github.com/mozilla-mobile/fenix/blob/master/docs/metrics.md

7) How long will this data be collected? Choose one of the following:
One year, until 2021-04-01.
Pending renewal.

8) What populations will you measure?
All release channels and locales.

9) If this data collection is default on, what is the opt-out mechanism for users?
Users can opt of of data collection by disabling Usage and technical data from Settings -> Data collection.

10) Please provide a general description of how you will analyze this data.
Glean / Amplitude

11) Where do you intend to share the results of your analysis?
Only on Glean, Amplitude and with mobile teams.

12) Is there a third-party tool (i.e. not Telemetry) that you are proposing to use for this data collection?
No.

@Mugurell Mugurell added needs:data-review PR is awaiting a data review pr:do-not-land labels Nov 24, 2020
@codecov-io
Copy link

Codecov Report

Merging #16730 (17777f8) into master (bb2df4c) will decrease coverage by 0.78%.
The diff coverage is 40.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #16730      +/-   ##
============================================
- Coverage     30.90%   30.11%   -0.79%     
+ Complexity     1240     1207      -33     
============================================
  Files           454      454              
  Lines         18496    18599     +103     
  Branches       2577     2566      -11     
============================================
- Hits           5716     5601     -115     
- Misses        12321    12556     +235     
+ Partials        459      442      -17     
Impacted Files Coverage Δ Complexity Δ
...la/fenix/components/metrics/GleanMetricsService.kt 12.42% <0.00%> (-0.34%) 5.00 <0.00> (ø)
...main/java/org/mozilla/fenix/TelemetryMiddleware.kt 79.41% <50.00%> (-1.84%) 18.00 <0.00> (+1.00) ⬇️
...java/org/mozilla/fenix/components/metrics/Event.kt 34.21% <100.00%> (+0.21%) 0.00 <0.00> (ø)
...main/java/org/mozilla/fenix/components/Services.kt 0.00% <0.00%> (-69.24%) 0.00% <0.00%> (-1.00%)
...lla/fenix/components/toolbar/DefaultToolbarMenu.kt 0.00% <0.00%> (-42.74%) 0.00% <0.00%> (-3.00%)
...zilla/fenix/browser/OpenInAppOnboardingObserver.kt 0.00% <0.00%> (-30.44%) 0.00% <0.00%> (-8.00%)
...in/java/org/mozilla/fenix/AppRequestInterceptor.kt 65.62% <0.00%> (-27.40%) 6.00% <0.00%> (-8.00%)
...g/mozilla/fenix/addons/AddonsManagementFragment.kt 0.00% <0.00%> (-6.85%) 0.00% <0.00%> (-7.00%)
...lla/fenix/customtabs/ExternalAppBrowserActivity.kt 33.33% <0.00%> (-5.56%) 4.00% <0.00%> (-5.00%)
app/src/main/java/org/mozilla/fenix/Config.kt 47.82% <0.00%> (-4.35%) 2.00% <0.00%> (ø%)
... and 53 more

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 bb2df4c...7a24273. Read the comment docs.

@Mugurell Mugurell added needs:review PRs that need to be reviewed and removed pr:do-not-land labels Dec 11, 2020
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 in a public, complete, and accurate way?
    Yes, metrics.yaml and metrics.md

  2. Is there a control mechanism that allows the user to turn the data collection on and off?
    Yes, Fenix data collection settings.

  3. If the request is for permanent data collection, is there someone who will monitor the data over time?
    No, Fenix team will monitor

  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

  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?
    Has expiry

  9. Does the data collection use a third-party collection tool?
    No

@Mugurell Mugurell merged commit d5b33ae into mozilla-mobile:master Dec 15, 2020
@Mugurell Mugurell deleted the 11578AddDownloadTelemetry branch December 15, 2020 06:39
pkirakosyan pushed a commit to gexsi/user-agent-android that referenced this pull request Aug 4, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants