For #10465: Add telemetry for voice search

[sblatz]

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.

After merge

• Milestone: Make sure issues finished by this pull request are added to the milestone of the version currently in development.

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

[sblatz]

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 do users interact with voice search?
   -How often do users disable/enable the voice search option in settings?

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?

• We want to know if voice search is useful to users.

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

• N/A (These are baseline metrics)

4. Can current instrumentation answer these questions?

• Currently there are no events to track this event, as the feature is brand new.

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

6. How long will this data be collected?

Until 09/01/2020

7. What populations will you measure?

• All release, beta, and nightly users with telemetry enabled.

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

• Glean / Amplitude

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

• Only on Glean, Amplitude and with mobile teams.

[codecov-commenter]

Codecov Report

Merging #10785 into master will decrease coverage by 0.00%.
The diff coverage is 0.00%.

@@             Coverage Diff              @@
##             master   #10785      +/-   ##
============================================
- Coverage     19.17%   19.16%   -0.01%     
  Complexity      600      600              
============================================
  Files           360      360              
  Lines         14845    14850       +5     
  Branches       2014     2015       +1     
============================================
  Hits           2846     2846              
- Misses        11739    11744       +5     
  Partials        260      260              

Impacted Files	Coverage Δ	Complexity Δ
...la/fenix/components/metrics/GleanMetricsService.kt	8.68% <0.00%> (-0.05%)	3.00 <0.00> (ø)
...va/org/mozilla/fenix/components/metrics/Metrics.kt	19.38% <0.00%> (-0.13%)	0.00 <0.00> (ø)
...in/java/org/mozilla/fenix/search/SearchFragment.kt	0.00% <0.00%> (ø)	0.00 <0.00> (ø)

---

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 535e020...8f77ce8. Read the comment docs.

[liuche]

Pending addressing comments (mainly the documentation one)

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, included in metrics.md

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

Yes, Fenix data controls

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

Expires in 6mo

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?

yes

8. Does there need to be a check-in in the future to determine whether to renew the data?

Has expiry

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

no

[liuche]

Hey @sblatz, do you think these pref states should be moved to the metrics ping? These are different, someone actively toggling a pref vs what the value of the pref is - do we care how often a pref is toggled, versus how many people have it enabled/disabled?

[sblatz]

Unclear. My understanding was that @vesta0 wanted to know when users went in to settings to disable it.

@vesta0 would you prefer this be sent in the baseline ping? e.g. "user has voice search disabled, has open links in private tab enabled, etc.)?

I agree this seems more useful but I think we also wanted to know if people were aware they could even change these settings.

[sblatz]

As we discussed, let's merge this as is for now. Sounds like there may be some more clean up data science and I need to do on these to get better data from them, but that's a larger project!

[liuche]

Does this not get updated in the metrics.md? I don't see a change in that file included in this PR.

[sblatz]

Think I just need to do a rebuild of the project to generate. Let's see what Vesta responds to the other comment :)