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

For #16828 - Adds telemetry for open in app banner #17049

Conversation

codrut-topliceanu
Copy link
Contributor

Specifically: Banner displayed, Dismiss action, Go to Settings action.
For #16828

Pull Request checklist

  • Tests: This PR does not include any tests as it is only a minor change.
  • Screenshots: The code in this PR does not include any user facing features.
  • Accessibility: The code in this PR does not include any 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

@codrut-topliceanu
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?

  • How often users see the Open in App banner.
  • How often users dismiss the Open in App banner.
  • How often users tap on "go to settings" from the the Open in App banner.

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?
Measure whether this feature is used by users and how often.

3) What alternative methods did you consider to answer these questions? Why were they not sufficient?
This is the only way.

4) Can current instrumentation answer these questions?
No. We need a new specific event for a specific app feature.

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 #
How often users see the Open in App banner Category 2 https://github.com//issues/16828

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.
This collection is documented in the metrics.md document document included in the project - https://github.com/mozilla-mobile/fenix/blob/master/docs/metrics.md

7) How long will this data be collected? Choose one of the following:
Until 2021-06-01.

8) What populations will you measure?
All release channels and locales.

9) If this data collection is default on, what is the opt-out mechanism for users?
Users can opt of of data collection by disabling Usage and technical data from Settings -> Data collection.

10) Please provide a general description of how you will analyze this data.
Glean / 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.

@codrut-topliceanu codrut-topliceanu marked this pull request as ready for review December 15, 2020 15:32
@codrut-topliceanu codrut-topliceanu added needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed Feature:Telemetry labels Dec 15, 2020
@mergify
Copy link
Contributor

mergify bot commented Dec 16, 2020

This pull request has conflicts when rebasing. Could you fix it @codrut-topliceanu? 🙏

@mergify
Copy link
Contributor

mergify bot commented Dec 17, 2020

This pull request has conflicts when rebasing. Could you fix it @codrut-topliceanu? 🙏

@codrut-topliceanu codrut-topliceanu force-pushed the 16828_telemetry_open_in_app_banner branch 2 times, most recently from 86eba73 to 06b580d Compare December 18, 2020 11:17
@codecov-io
Copy link

Codecov Report

Merging #17049 (030fc02) into master (afc8c26) will decrease coverage by 0.05%.
The diff coverage is 0.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #17049      +/-   ##
============================================
- Coverage     30.81%   30.76%   -0.06%     
- Complexity     1239     1241       +2     
============================================
  Files           455      455              
  Lines         18668    18680      +12     
  Branches       2615     2622       +7     
============================================
- Hits           5753     5747       -6     
- Misses        12453    12470      +17     
- Partials        462      463       +1     
Impacted Files Coverage Δ Complexity Δ
...zilla/fenix/browser/OpenInAppOnboardingObserver.kt 25.92% <0.00%> (-24.08%) 8.00 <0.00> (+2.00) ⬇️
...java/org/mozilla/fenix/components/metrics/Event.kt 33.33% <0.00%> (-0.33%) 0.00 <0.00> (ø)
...la/fenix/components/metrics/GleanMetricsService.kt 12.38% <0.00%> (-0.14%) 5.00 <0.00> (ø)
...g/mozilla/fenix/components/TabCollectionStorage.kt 26.82% <0.00%> (-1.38%) 2.00% <0.00%> (ø%)
.../java/org/mozilla/fenix/browser/BrowserFragment.kt 1.97% <0.00%> (-0.68%) 1.00% <0.00%> (ø%)
...a/org/mozilla/fenix/library/LibraryPageFragment.kt 5.88% <0.00%> (-0.37%) 1.00% <0.00%> (ø%)
...c/main/java/org/mozilla/fenix/home/HomeFragment.kt 0.00% <0.00%> (ø) 0.00% <0.00%> (ø%)
...ava/org/mozilla/fenix/tabtray/TabTrayController.kt 73.91% <0.00%> (ø) 0.00% <0.00%> (ø%)
...a/org/mozilla/fenix/search/SearchDialogFragment.kt 0.00% <0.00%> (ø) 0.00% <0.00%> (ø%)
... and 3 more

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 afc8c26...06b580d. Read the comment docs.

@codrut-topliceanu
Copy link
Contributor Author

@boek Hey, would you mind taking a look at this? 🙏

@mergify
Copy link
Contributor

mergify bot commented Jan 4, 2021

This pull request has conflicts when rebasing. Could you fix it @codrut-topliceanu? 🙏

@codrut-topliceanu
Copy link
Contributor Author

@kglazko Could you help with a data review please ? 🥺

Copy link
Contributor

@eliserichards eliserichards left a comment

Choose a reason for hiding this comment

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

One small change 😄

app/metrics.yaml Outdated Show resolved Hide resolved
app/metrics.yaml Outdated Show resolved Hide resolved
app/metrics.yaml Outdated Show resolved Hide resolved
@eliserichards eliserichards added pr:needs-changes PRs that need some changes/fixes before they can land and removed needs:review PRs that need to be reviewed labels Jan 25, 2021
codrut.topliceanu added 2 commits January 26, 2021 15:01
Specifically: Banner displayed, Dismiss action, Go to Settings action.
@codrut-topliceanu codrut-topliceanu removed the pr:needs-changes PRs that need some changes/fixes before they can land label Jan 27, 2021
Copy link
Contributor

@eliserichards eliserichards left a comment

Choose a reason for hiding this comment

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

Fantastic! Once we get a data review approval this will be ready to merge! 😄

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 in a public, complete, and accurate way?
    Yes, metrics.yaml and metrics.md

  2. Is there a control mechanism that allows the user to turn the data collection on and off?
    Yes, data collection settings

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

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

  5. Is the data collection request for default-on or default-off?
    Default on

  6. 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

  7. Is the data collection covered by the existing Firefox privacy notice? If unsure: escalate to legal if:
    Yes

  8. Does there need to be a check-in in the future to determine whether to renew the data?
    Fenix team will check-in at expiry

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

@codrut-topliceanu codrut-topliceanu merged commit e188185 into mozilla-mobile:master Jan 29, 2021
@codrut-topliceanu codrut-topliceanu removed the needs:data-review PR is awaiting a data review label Jan 29, 2021
pkirakosyan pushed a commit to gexsi/user-agent-android that referenced this pull request Aug 4, 2021
…illa-mobile#17049)

* For mozilla-mobile#16828 - Adds telemetry for open in app banner

Specifically: Banner displayed, Dismiss action, Go to Settings action.
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.

None yet

5 participants