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

For #23526 - Add telemetry for Contile interactions #23541

Merged
merged 2 commits into from
Feb 8, 2022
Merged

For #23526 - Add telemetry for Contile interactions #23541

merged 2 commits into from
Feb 8, 2022

Conversation

MozillaNoah
Copy link
Contributor

Closes #23526

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

@MozillaNoah MozillaNoah added needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed labels Feb 2, 2022
@MozillaNoah MozillaNoah requested review from a team as code owners February 2, 2022 22:06
@MozillaNoah
Copy link
Contributor Author

MozillaNoah commented Feb 2, 2022

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 are users that see the contile clicking on it?
  • How often are users opening a contile (directly, new private tab)?
  • What's the ratio of users dismissing a contile to clicking on it?
  • What percent of DAU have contile turned off?
  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 will help us understand usage patterns around the Contile feature
  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?
  • No
  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 #
User clicks on a Contile Category 2 - interaction data #23526
User long presses a Contile Category 2 - interaction data #23526
User opens a Contile link in a private tab via the long press context menu Category 2 - interaction data #23526
User opens Settings via the long press context menu Category 2 - interaction data #23526
User opens “Sponsors & your privacy” via the long press context menu Category 2 - interaction data #23526
User disables/enables the Contile feature Category 2 - interaction data #23526
  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:
  • One year (ending on February 1st, 2023), with the option to renew at that point.

  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.

  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.

@gabrielluong
Copy link
Member

We typically use the present for the commit message (s/Added/Add)

@gabrielluong
Copy link
Member

Wondering if we also had any telemetry requirement with the turning on/off the feature in the Homepage settings.

@MozillaNoah
Copy link
Contributor Author

MozillaNoah commented Feb 2, 2022

Wondering if we also had any telemetry requirement with the turning on/off the feature in the Homepage settings.

We do, and it's actually already been reporting since the original implementation story via the preference change listener CustomizeHomeMetricsUpdater

@gabrielluong gabrielluong changed the title For #23526 - Added telemetry for Contile interactions For #23526 - Add telemetry for Contile interactions Feb 4, 2022
@rocketsroger
Copy link
Contributor

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 are users that see the contile clicking on it?

* How often are users opening a contile (directly, new private tab)?

* What's the ratio of users dismissing a contile to clicking on it?

* What percent of DAU have contile turned off?


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 will help us understand usage patterns around the Contile feature


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


* There are no other alternatives.


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 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 #
User clicks on a Contile Category 2 - interaction data #23526
User long presses a Contile Category 2 - interaction data #23526
User opens a Contile link in a private tab via the long press context menu Category 2 - interaction data #23526
User opens Settings via the long press context menu Category 2 - interaction data #23526
User opens “Sponsors & your privacy” via the long press context menu Category 2 - interaction data #23526
User disables/enables the Contile feature Category 2 - interaction data #23526

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.


* [https://dictionary.telemetry.mozilla.org/apps/fenix
  ](https://dictionary.telemetry.mozilla.org/apps/fenix%E2%80%A8)


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


* One year (ending on February 1st, 2023), with the option to renew at that point.


8. What populations will you measure?


* All channels, all locales, all countries


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


* Default Glean SDK opt-out mechanism.


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


* Glean and 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 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 file 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?

N/A, collection set to end or be renewed by 2023-02-01

  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?

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+

@rocketsroger rocketsroger removed the needs:data-review PR is awaiting a data review label Feb 4, 2022
@rocketsroger rocketsroger removed the needs:review PRs that need to be reviewed label Feb 4, 2022
@gabrielluong gabrielluong added the pr:approved PR that has been approved label Feb 7, 2022
@rocketsroger rocketsroger reopened this Feb 7, 2022
@MozillaNoah MozillaNoah closed this Feb 7, 2022
@MozillaNoah MozillaNoah reopened this Feb 7, 2022
@MozillaNoah MozillaNoah closed this Feb 8, 2022
@MozillaNoah MozillaNoah reopened this Feb 8, 2022
@MozillaNoah MozillaNoah added the pr:needs-landing PRs that are ready to land [Will be merged by Mergify] label Feb 8, 2022
@mergify mergify bot merged commit c0942ea into mozilla-mobile:main Feb 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr:approved PR that has been approved pr:needs-landing PRs that are ready to land [Will be merged by Mergify]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contile Telemetry
3 participants