For #5094: Adds telemetry for show search shortcuts

[sblatz]

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
• 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

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?

• Do users want to see suggestions for search shortcuts (other search engines)

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 users choose to disable various types of awesomebar suggestions so we can improve its usability in future iterations.

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 preference, though we do track other suggestion toggles, so we'd like data on this one as well.

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 03/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.

[sblatz]

Related data review: #5704

[codecov-io]

Codecov Report

Merging #5886 into master will decrease coverage by <.01%.
The diff coverage is 0%.

@@             Coverage Diff              @@
##             master    #5886      +/-   ##
============================================
- Coverage     14.35%   14.35%   -0.01%     
  Complexity      320      320              
============================================
  Files           257      257              
  Lines         10604    10605       +1     
  Branches       1551     1551              
============================================
  Hits           1522     1522              
- Misses         8956     8957       +1     
  Partials        126      126

Impacted Files	Coverage Δ	Complexity Δ
...va/org/mozilla/fenix/components/metrics/Metrics.kt	25.47% <0%> (-0.13%)	0 <0> (ø)

---

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 6ec0d46...929a232. Read the comment docs.

[liuche]

One nit: You should also commit the generated changes to the metrics.md file.

Data Review Form (to be filled by Data Stewards)

Instructions: Data Stewards will review a request for data collection and endorse responses to each question. If the request does not provide answers to questions, reviewers give an r- and point to the questions that can’t be answered.

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, updated metrics.yaml

2. Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.

Yes, fenix data controls

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

Expiry 3/2020

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, UI telemetry

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

Yes, usage data

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

Has expiry

9. Does the data collection use a third-party collection tool? If yes, escalate to legal.

No

[liuche]

r+ but needs to actually commit the generated documentation changes.