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

For #19915: Add telemetry for the toolbar Home screen button. #19936

Merged
merged 1 commit into from
Jun 14, 2021

Conversation

mcarare
Copy link
Contributor

@mcarare mcarare commented Jun 10, 2021

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
    -> No visual changes.
  • 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.
    -> No 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

@mcarare mcarare force-pushed the 19915 branch 3 times, most recently from 1a91d20 to ea8c72c Compare June 10, 2021 12:05
@codecov-commenter
Copy link

codecov-commenter commented Jun 10, 2021

Codecov Report

Merging #19936 (f888015) into master (bd32346) will decrease coverage by 0.00%.
The diff coverage is 25.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #19936      +/-   ##
============================================
- Coverage     36.79%   36.78%   -0.01%     
+ Complexity     1622     1620       -2     
============================================
  Files           535      535              
  Lines         20961    20961              
  Branches       3117     3118       +1     
============================================
- Hits           7712     7710       -2     
- Misses        12356    12358       +2     
  Partials        893      893              
Impacted Files Coverage Δ
...pp/src/main/java/org/mozilla/fenix/HomeActivity.kt 25.13% <0.00%> (+0.19%) ⬆️
...la/fenix/components/metrics/GleanMetricsService.kt 19.81% <0.00%> (-0.08%) ⬇️
...c/main/java/org/mozilla/fenix/home/HomeFragment.kt 2.42% <ø> (+<0.01%) ⬆️
...ix/home/sessioncontrol/SessionControlController.kt 71.06% <50.00%> (ø)
...java/org/mozilla/fenix/components/metrics/Event.kt 41.32% <100.00%> (+0.16%) ⬆️
...nix/components/toolbar/BrowserToolbarController.kt 91.80% <100.00%> (+0.13%) ⬆️
...java/org/mozilla/fenix/perf/PerformanceInflater.kt 80.00% <0.00%> (-15.00%) ⬇️
...in/java/org/mozilla/fenix/perf/NavGraphProvider.kt 50.00% <0.00%> (-12.50%) ⬇️

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 0c1e712...f888015. Read the comment docs.

@mcarare mcarare added needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed labels Jun 10, 2021
@mcarare mcarare marked this pull request as ready for review June 10, 2021 12:36
@mcarare mcarare requested review from a team as code owners June 10, 2021 12:36
Copy link
Member

@gabrielluong gabrielluong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks fine. @mcarare I am wondering if we also filed a DS request to confirm we want this as an event ping, which I think makes sense here, but I guess we should be sure by checking with DS. You may need to ping #data-help on slack.

@mcarare
Copy link
Contributor Author

mcarare commented Jun 11, 2021

Request for data collection review

  1. What questions will you answer with this data?
    This data will provide statistics regarding the usage of the new home button on the browser toolbar.

  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 give us an understanding of the usability of the button, info we will use for improving the user experience.

  3. What alternative methods did you consider to answer these questions? Why were they not sufficient?
    No alternative is available to answer this question.

  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.

Measurement Description Data Collection Category Tracking Bug #
Home button clicks category 2 - Interaction data #19915
  1. How long will this data be collected? Choose one of the following:
    Data will be collected for 6 months initially (ending on 2021-12-10), with the option to renew at that point.


  2. What populations will you measure?
    No filters - all locales, channels, etc. Currently, the button is visible only in Nightly.

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

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

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

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

@mcarare mcarare removed the needs:review PRs that need to be reviewed label Jun 11, 2021
@tdsmith
Copy link
Contributor

tdsmith commented Jun 14, 2021

data-review+, thanks!

  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, in the probe definition files and the Glean dictionary.

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

Yes, the Firefox telemetry opt-out.

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

n/a

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

Cat 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

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants