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

For #21313: Renew metrics for December - never expire updates #21788

Merged

Conversation

eliserichards
Copy link
Contributor

@eliserichards eliserichards commented Oct 7, 2021

For #21313

This PR is for updating metrics that are set to expire in December that should be changed to never expire. These are foundational metrics that we need for the longer term.

  • Approval from product- see doc
  • data review
  • update data review TBDs in PR

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

@eliserichards eliserichards requested review from a team as code owners October 7, 2021 22:44
@eliserichards eliserichards added the pr:work-in-progress PRs that are not ready to be reviewed yet and are actively being worked on label Oct 9, 2021
@eliserichards
Copy link
Contributor Author

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?
  • This data helps us understand the foundational usage of the app. These metrics all exist already (nothing new is being added) but we are changing the expiration date to “never expire”.

  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?
  • This data will help us understand how our app is being used. This is vital for product to be able to see this data without interruptions.

  1. What alternative methods did you consider to answer these questions? Why were they not sufficient?
  • There are no other alternatives.

  1. Can current instrumentation answer these questions?
  • Yes: this change will mitigate the risk of these important metrics expiring.

  1. 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 #
app_opened Category 2 - interaction data #1067 (comment)
search_bar_tapped Category 2 - interaction data #1067 (comment)
entered_url Category 2 - interaction data #1067 (comment)
performed_search Category 2 - interaction data #1067 (comment)
opened_link Category 2 - interaction data #5975
activation.identifier Category 2 - interaction data https://github.com/mozilla-mobile/fenix/issues/pull/1707#issuecomment-486972209
activation.activation_id Category 2 - interaction data #1707 (comment)
addons.has_installed_addons Category 2 - interaction data #8318
addons.has_enabled_addons Category 2 - interaction data #8318
addons.installed_addons: string_list Category 2 - interaction data #8318
  1. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.
  1. How long will this data be collected? Choose one of the following:
  • These metrics will never expire.

  1. What populations will you measure?
  • All channels, all locales, all countries

  1. If this data collection is default on, what is the opt-out mechanism for users?
  • Default Glean SDK opt-out mechanism.

  1. Please provide a general description of how you will analyze this data.
  • Glean and Amplitude.

  1. Where do you intend to share the results of your analysis?
  • Only on Glean, Amplitude, and with mobile teams (no change).

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

@eliserichards eliserichards force-pushed the 21313-renew-metrics-never-expire branch 2 times, most recently from 291b31d to f4f4cb6 Compare October 22, 2021 21:53
@eliserichards eliserichards added needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed and removed pr:work-in-progress PRs that are not ready to be reviewed yet and are actively being worked on labels Oct 22, 2021
@travis79
Copy link
Member

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?


* This data helps us understand the foundational usage of the app. These metrics all exist already (nothing new is being added) but we are changing the expiration date to “never expire”.


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?


* This data will help us understand how our app is being used. This is vital for product to be able to see this data without interruptions.


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


* There are no other alternatives.


1. Can current instrumentation answer these questions?


* Yes: this change will mitigate the risk of these important metrics expiring.


1. 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 #
app_opened Category 2 - interaction data #1067 (comment)
search_bar_tapped Category 2 - interaction data #1067 (comment)
entered_url Category 2 - interaction data #1067 (comment)
performed_search Category 2 - interaction data #1067 (comment)
opened_link Category 2 - interaction data #5975
activation.identifier Category 2 - interaction data https://github.com/mozilla-mobile/fenix/issues/pull/1707#issuecomment-486972209
activation.activation_id Category 2 - interaction data #1707 (comment)
addons.has_installed_addons Category 2 - interaction data #8318
addons.has_enabled_addons Category 2 - interaction data #8318
addons.installed_addons: string_list Category 2 - interaction data #8318

1. Please provide a link to the documentation for this data collection which describes the ultimate data set in a public, complete, and accurate way.


* [dictionary.telemetry.mozilla.org/apps/fenix](https://dictionary.telemetry.mozilla.org/apps/fenix)


1. How long will this data be collected? Choose one of the following:


* These metrics will never expire.


1. What populations will you measure?


* All channels, all locales, all countries


1. If this data collection is default on, what is the opt-out mechanism for users?


* Default Glean SDK opt-out mechanism.


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


* Glean and Amplitude.


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


* Only on Glean, Amplitude, and with mobile teams (no change).


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


* No third-party tools.

Data Review

  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, through the metrics.yaml and the Glean Dictionary

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

Yes, through the "Send Usage Data" preference in the application settings

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

Yes, Elise Richards will monitor the permanent collection of these metrics

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

Category 2, Interaction data

  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

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

Yes

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

No

Result

data-review+

Copy link
Member

@travis79 travis79 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+

@travis79 travis79 removed the needs:data-review PR is awaiting a data review label Oct 23, 2021
@eliserichards eliserichards force-pushed the 21313-renew-metrics-never-expire branch from f4f4cb6 to 464a91e Compare October 25, 2021 20:15
@mergify
Copy link
Contributor

mergify bot commented Oct 25, 2021

This pull request has conflicts when rebasing. Could you fix it @eliserichards? 🙏

@eliserichards eliserichards force-pushed the 21313-renew-metrics-never-expire branch from 464a91e to 8aa2f08 Compare October 26, 2021 20:37
@eliserichards eliserichards added pr:needs-landing-squashed PRs that are ready to land (squashed) [Will be merged by Mergify] and removed needs:review PRs that need to be reviewed labels Oct 26, 2021
@mergify mergify bot merged commit 347f82f into mozilla-mobile:main Oct 26, 2021
@rocketsroger
Copy link
Contributor

@Mergifyio backport releases_v94.0.0

mergify bot pushed a commit that referenced this pull request Nov 4, 2021
* For #21313: Renew metrics for December - never expire updates

* For #21313: data review

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 347f82f)
@mergify
Copy link
Contributor

mergify bot commented Nov 4, 2021

backport releases_v94.0.0

✅ Backports have been created

rocketsroger pushed a commit that referenced this pull request Nov 4, 2021
#22320)

* For #21313: Renew metrics for December - never expire updates

* For #21313: data review

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 347f82f)

Co-authored-by: Elise Richards <erichards@mozilla.com>
pkirakosyan pushed a commit to gexsi/user-agent-android that referenced this pull request Mar 7, 2022
…pdates (mozilla-mobile#21788)

* For mozilla-mobile#21313: Renew metrics for December - never expire updates

* For mozilla-mobile#21313: data review

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr:needs-landing-squashed PRs that are ready to land (squashed) [Will be merged by Mergify]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants