MR2 Telemetry: Homescreen view count #22377

MozillaNoah · 2021-11-08T22:24:34Z

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:

click on Show All Checks,
click Details next to "Taskcluster (pull_request)" after it appears and then finishes with a green checkmark,
click on the "Fenix - assemble" task, then click "Run Artifacts".
the APK links should be on the left side of the screen, named for each CPU architecture

MozillaNoah · 2021-11-08T22:26:22Z

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.

What questions will you answer with this data?

How many times does the user view the homescreen?

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

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

There are no other alternatives.

Can current instrumentation answer these questions?

This new probe does have a bit of overlap with two existing probes:
- https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/start_on_home_enter_home_screen
- https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed

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 many total times has the user seen the homescreen?	Category 2 - interaction data	#22146

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

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

One year (ending on November 1st, 2022), with the option to renew at that point.

What populations will you measure?

All channels, all locales, all countries

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

Default Glean SDK opt-out mechanism.

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

Glean and Amplitude.

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

 Only on Glean, Amplitude, and with mobile teams.

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

No third-party tools.

MozillaNoah · 2021-11-08T22:28:21Z

This new probe does have a bit of overlap with two existing probes:
https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/start_on_home_enter_home_screen
https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed

We may want to revisit the original probes come renewal time.

jonalmeida

This new probe does have a bit of overlap with two existing probes: https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/start_on_home_enter_home_screen https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed

We may want to revisit the original probes come renewal time.

Please put this under "What alternative methods did you consider to answer these questions? Why were they not sufficient?"

I was looking at this from an eng perspective and I can't see how this probe would give any new data that differs from home_screen_displayed.

We should ask product/data why this new probe is needed probably.

jonalmeida · 2021-11-09T00:24:11Z

app/src/main/java/org/mozilla/fenix/HomeActivity.kt

@@ -230,7 +230,7 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
        }

        if (!shouldStartOnHome() &&
-            shouldNavigateBrowserFragmentOnCouldStart(savedInstanceState)


Good catch.

MozillaNoah · 2021-11-09T16:50:27Z

This new probe does have a bit of overlap with two existing probes: https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/start_on_home_enter_home_screen https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed
We may want to revisit the original probes come renewal time.

Please put this under "What alternative methods did you consider to answer these questions? Why were they not sufficient?"

I was looking at this from an eng perspective and I can't see how this probe would give any new data that differs from home_screen_displayed.

We should ask product/data why this new probe is needed probably.

Yeah, I was thinking the same thing but wanted to get the code out first since it was a pretty minor addition. I'll reach out to Kimmy and comment back when I have an update.

Thanks!

MozillaNoah · 2021-11-10T22:15:14Z

Reached out to Kimmy:

i think the intended difference here was the start_on_home.enter_home_screen counts when the user is directed to the home screen after 4 hours or more of being away, while the home_screen_displayed one counts all the different ways the home screen can be viewed (including start_on_home.enter_home_screen.
...
so i think we wanted a total home screen view count, and the start on home one contributes to that overall count
...
...for this situation we'd just like one aggregate measure of home screen views

Confirmed we need this new probe for running a particular report.

CC: @jonalmeida @rocketsroger

rocketsroger · 2021-11-11T03:06:50Z

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 many times does the user view the homescreen?


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


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?


* This new probe does have a bit of overlap with two existing probes:
  
  * https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/start_on_home_enter_home_screen
  * [https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed     ](https://dictionary.telemetry.mozilla.org/apps/fenix/metrics/home_screen_home_screen_displayed%E2%80%A8)


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 #
How many total times has the user seen the homescreen? Category 2 - interaction data #22146

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.


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


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


* One year (ending on November 1st, 2022), 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.

Data Review

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

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

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 2022-11-01

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

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

default-on

Does the instrumentation include the addition of any new identifiers?

No

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

Yes

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

No

Result

data-review+

rocketsroger · 2021-11-11T03:07:35Z

app/src/main/java/org/mozilla/fenix/home/HomeFragment.kt

@@ -480,7 +480,10 @@ class HomeFragment : Fragment() {
        val profilerStartTime = requireComponents.core.engine.profiler?.getProfilerTime()

        super.onViewCreated(view, savedInstanceState)
-        context?.metrics?.track(Event.HomeScreenDisplayed)
+        context?.metrics?.apply {
+            track(Event.HomeScreenDisplayed)


Should we remove this then? since we will now have a counter?

I wouldn't think so since the event should be, in theory, used to follow a sequence of user interactions, whereas the counter will be used for some quantitative calculations and comparisons.

* For mozilla-mobile#22146 - Added counter for home screen views * For mozilla-mobile#22146 - Added PR number to metrics Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

For #22146 - Added counter for home screen views

f9152cd

MozillaNoah added Feature:HomeScreen Feature:Telemetry needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed labels Nov 8, 2021

MozillaNoah requested review from a team as code owners November 8, 2021 22:24

For #22146 - Added PR number to metrics

d5a70dc

Merge branch 'main' into homescreen-views-telemetry

7aa38c9

jonalmeida reviewed Nov 9, 2021

View reviewed changes

rocketsroger reviewed Nov 11, 2021

View reviewed changes

eliserichards removed the needs:data-review PR is awaiting a data review label Nov 15, 2021

rocketsroger approved these changes Nov 16, 2021

View reviewed changes

Merge branch 'main' into homescreen-views-telemetry

4cc5605

MozillaNoah added the pr:needs-landing-squashed PRs that are ready to land (squashed) [Will be merged by Mergify] label Nov 16, 2021

MozillaNoah closed this Nov 16, 2021

MozillaNoah reopened this Nov 16, 2021

Merge branch 'main' into homescreen-views-telemetry

f229ffb

mergify bot merged commit dde9160 into mozilla-mobile:main Nov 16, 2021

gabrielluong mentioned this pull request Aug 22, 2022

For #26582 - Renew telemetry expiring in 107 #26583

Closed

4 tasks

rocketsroger mentioned this pull request Aug 17, 2023

Bug 1849184 - Renew Fenix telemetry probes expiring in v120 mozilla-mobile/firefox-android#3319

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MR2 Telemetry: Homescreen view count #22377

MR2 Telemetry: Homescreen view count #22377

MozillaNoah commented Nov 8, 2021

MozillaNoah commented Nov 8, 2021 •

edited

Loading

MozillaNoah commented Nov 8, 2021 •

edited

Loading

jonalmeida left a comment

jonalmeida Nov 9, 2021

MozillaNoah commented Nov 9, 2021

MozillaNoah commented Nov 10, 2021

rocketsroger commented Nov 11, 2021

Request for data collection review form

rocketsroger Nov 11, 2021

MozillaNoah Nov 11, 2021

MR2 Telemetry: Homescreen view count #22377

MR2 Telemetry: Homescreen view count #22377

Conversation

MozillaNoah commented Nov 8, 2021

Pull Request checklist

To download an APK when reviewing a PR:

MozillaNoah commented Nov 8, 2021 • edited Loading

Request for data collection review form

MozillaNoah commented Nov 8, 2021 • edited Loading

jonalmeida left a comment

Choose a reason for hiding this comment

jonalmeida Nov 9, 2021

Choose a reason for hiding this comment

MozillaNoah commented Nov 9, 2021

MozillaNoah commented Nov 10, 2021

rocketsroger commented Nov 11, 2021

Request for data collection review form

Data Review

Result

rocketsroger Nov 11, 2021

Choose a reason for hiding this comment

MozillaNoah Nov 11, 2021

Choose a reason for hiding this comment

MozillaNoah commented Nov 8, 2021 •

edited

Loading

MozillaNoah commented Nov 8, 2021 •

edited

Loading