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

Closes #1195: Adds telemetry for quick action sheet #1362

Merged
merged 1 commit into from
Apr 5, 2019

Conversation

sblatz
Copy link
Contributor

@sblatz sblatz commented Apr 3, 2019

Pull Request checklist

  • Quality: This PR builds and passes detekt/ktlint checks (A pre-push hook is recommended)
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Changelog: This PR includes a changelog entry or does not need one
  • Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

No tests as this is just a telemetry change

@sblatz sblatz requested a review from a team as a code owner April 3, 2019 21:35
@ghost ghost assigned sblatz Apr 3, 2019
@ghost ghost added the review label Apr 3, 2019
@sblatz
Copy link
Contributor Author

sblatz commented Apr 3, 2019

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 quick bar is being opened/closed
  • Time between opened and closed (Amplitude)
  • What are the most clicked actions?
  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 these features are
  • To see if the quick action sheet is "discoverable" enough based on its adoption
  1. What alternative methods did you consider to answer these questions? Why were they not sufficient?
  • N/A (These are baseline metrics)
  1. Can current instrumentation answer these questions?
  • Currently no, as these are some of the first metrics we're recording
  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?

Until 03/01/2020

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

@sblatz sblatz requested a review from liuche April 3, 2019 21:39
@liuche liuche requested review from boek and removed request for liuche April 4, 2019 01:33
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.

Do you want to send these events through the Glean SDK? You'll have to wire up the metrics.yaml / GleanMetricsProvider (example here: #1344)

Another nit: We should keep the Components as simple as possible and delegate the actual metrics collection to the component owner through the event bus.

@sblatz sblatz requested a review from boek April 5, 2019 17:20
@sblatz
Copy link
Contributor Author

sblatz commented Apr 5, 2019

@boek Made the changes you requested 😄

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.

Almost there 😁 just one quick update and I think we'll be good to go! If you're interested about the structure of metrics.yaml there is good documentation here on what everything means

app/metrics.yaml Outdated Show resolved Hide resolved
@sblatz sblatz requested a review from boek April 5, 2019 20:10
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 available publicly, complete and accurate?

Yes, inside metrics.yaml

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

Yes, through the telemetry toggle inside settings

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

Expires in 3/1/2020

  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 events are user interaction

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

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

Type 2, interaction with the quick action sheet

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

yes, we will revisit renewing Fenix events next February before the expiration

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

no

@sblatz sblatz merged commit 5fc1e92 into mozilla-mobile:master Apr 5, 2019
@ghost ghost removed the review label Apr 5, 2019
@sblatz sblatz deleted the quick-action-telemetry branch April 26, 2019 20:50
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.

3 participants