1459010 - Add UI event telemetry for Downloads

Status: RESOLVED FIXED

(Firefox for iOS :: Telemetry, enhancement, P1)

Description

[Justin D'Arcangelo [:justindarc]]

As part of rolling out the new Downloads feature, we need some telemetry to see how/if it is being used.

Comment 1

[Justin D'Arcangelo [:justindarc]]

Attachment: GitHub Pull Request

Comment 2

[Justin D'Arcangelo [:justindarc]]

NOTE: Actual documentation of the new events can be found in the GitHub PR. We will copy/paste that to the wiki when this lands.

[Request for data collection review form](https://github.com/mozilla/data-review/blob/master/request.md)

1. What questions will you answer with this data?

  - How often are users downloading files?
  - How often are users forcing a file download through the "Download Link" context menu?
  - How often do users cancel downloads?
  - How often do users share downloaded files to external apps?
  - How often do users delete downloaded files within Firefox for iOS?
  - How often do users view downloaded files through the "Downloads" home panel?

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?:

  - We are trying to gauge whether or not users find this functionality useful on iOS to determine whether or not to invest more time in it.

3. What alternative methods did you consider to answer these questions? Why were they not sufficient?

  - There are no alternate ways to determine how popular this feature is and how it is being used.

4. Can current instrumentation answer these questions?

  - No.

5. List all proposed measurements and indicate the category of data collection for each measurement, using the Firefox [data collection categories](https://wiki.mozilla.org/Firefox/Data_Collection) on the 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 #
----------------------------------------------------------------------------------------------------
Tapping Download Link in context menu                    | Category 2               | Bug 1459010
Tapping Download Now button to start download            | Category 2               | Bug 1459010
Tapping "X" to cancel download                           | Category 2               | Bug 1459010
Opening the Downloads panel from the App Menu            | Category 2               | Bug 1459010
Opening the Downloads panel from the Home Panel buttons  | Category 2               | Bug 1459010
Opening the Downloads panel from the Download toast      | Category 2               | Bug 1459010
Deleting a downloaded file from the Downloads panel      | Category 2               | Bug 1459010
Sharing a downloaded file from the Downloads panel       | Category 2               | Bug 1459010
Tapping a downloaded file in the Downloads panel to view | Category 2               | Bug 1459010


6. How long will this data be collected?:

  - I want to permanently monitor this data. (:justindarc)

7. What populations will you measure?

  - The entire Firefox for iOS population (Beta and Release)

8. Please provide a general description of how you will analyze this data.

  - We will determine what percentage and raw total number of our users are downloading files by device type.
  - We will also query percentages and raw total numbers of our users that perform various actions in the Downloads panel.

9. Where do you intend to share the results of your analysis?

  - Through a dashboard on sql.telemetry.mozilla.org

Comment 3

[Chenxia Liu [:liuche]]

Sorry for the delay! Was at a conference, but here is your data review.

Data-review+

> Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes, in Firefox iOS telemetry docs, listed in PR: https://github.com/mozilla-mobile/firefox-ios/pull/3905#pullrequestreview-118134426

> 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, Firefox iOS data controls

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

Yes, :justindarc

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

Type 2, user clicks on UI for downloads related features

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

Default on

> 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, just UI interaction telemetry

> Is the data collection covered by the existing Firefox privacy notice? 

Yes

> Does there need to be a check-in in the future to determine whether to renew the data? (Yes/No)

No, adding telemetry that didn't exist to measure feature usage

Comment 4

[Justin D'Arcangelo [:justindarc]]

Landed on master:

https://github.com/mozilla-mobile/firefox-ios/commit/f3a2f40d8969a8dfdc2ddf169e6cab03eb50a3b1