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

Closes #18068: Use AwesomeBarFacts for AwesomeBar Telemetry #18090

Merged
merged 1 commit into from
Mar 8, 2021

Conversation

rocketsroger
Copy link
Contributor

@rocketsroger rocketsroger commented Feb 19, 2021

Fixes #18068

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:

  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

@rocketsroger rocketsroger added needs:data-review PR is awaiting a data review needs:review PRs that need to be reviewed labels Feb 19, 2021
@rocketsroger rocketsroger requested review from a team as code owners February 19, 2021 19:01
@rocketsroger
Copy link
Contributor Author

Request for data collection review

  1. What questions will you answer with this data?
    More understanding of user behaviour so we can refine suggestions that are shown in the Awesomebar.
  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 allows for a better Awesomebar suggestions.
  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 current instrumentation can answer this question.
  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 #
Awesomebar bookmark suggestion clicked category 2 - interaction data #18068
Awesomebar clipboard suggestion clicked category 2 - interaction data #18068
Awesomebar history suggestion clicked category 2 - interaction data #18068
Awesomebar search action clicked category 2 - interaction data #18068
Awesomebar search suggestion clicked category 2 - interaction data #18068
Awesomebar opened tab suggestion clicked category 2 - interaction data #18068
  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://github.com/mozilla-mobile/fenix/blob/master/docs/metrics.md
  2. How long will this data be collected? Choose one of the following:

    This is scoped to a time-limited experiment/project until date 08-01-2021.
  3. What populations will you measure?

    No filters - all locales, channels, etc.
  4. If this data collection is default on, what is the opt-out mechanism for users?

    Default Glean SDK opt-out mechanism.
  5. Please provide a general description of how you will analyze this data.

    Glean / Amplitude
  6. Where do you intend to share the results of your analysis?

    Only on Glean, Amplitude and with mobile teams.
  7. 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.

@mergify
Copy link
Contributor

mergify bot commented Mar 2, 2021

This pull request has conflicts when rebasing. Could you fix it @rocketsroger? 🙏

@travis79
Copy link
Member

travis79 commented Mar 8, 2021

Request for data collection review

1. What questions will you answer with this data?
   More understanding of user behaviour so we can refine suggestions that are shown in the Awesomebar.

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 allows for a better Awesomebar suggestions.

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 current instrumentation can answer this question.

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 #
Awesomebar bookmark suggestion clicked category 2 - interaction data #18068
Awesomebar clipboard suggestion clicked category 2 - interaction data #18068
Awesomebar history suggestion clicked category 2 - interaction data #18068
Awesomebar search action clicked category 2 - interaction data #18068
Awesomebar search suggestion clicked category 2 - interaction data #18068
Awesomebar opened tab suggestion clicked category 2 - interaction data #18068

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://github.com/mozilla-mobile/fenix/blob/master/docs/metrics.md](https://github.com/mozilla-mobile/fenix/blob/master/docs/metrics.md?rgh-link-date=2021-02-19T19%3A27%3A38Z)

2. How long will this data be collected? Choose one of the following:
   
   This is scoped to a time-limited experiment/project until date 08-01-2021.

3. What populations will you measure?
   
   No filters - all locales, channels, etc.

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

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

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

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

Data Review

  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, via the metrics.md and other Glean tools.

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

Yes

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

Not applicable, the collection is set to end 2021-08-01.

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

Category 2, User Interaction

  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?

No

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

Yes

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

No, unless the owner decides to extend beyond 2021-08-01

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

No

Result:

data-review+

@travis79 travis79 removed the needs:data-review PR is awaiting a data review label Mar 8, 2021
Copy link
Contributor

@jonalmeida jonalmeida left a comment

Choose a reason for hiding this comment

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

@@ -85,4 +86,31 @@ class GleanMetricsServiceTest {
assertEquals(1, events[0].extra!!.size)
assertEquals("APP_ICON", events[0].extra!!["source"])
}

@Test
fun `awesomebar events is correctly recorded`() {
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: awesomebar events are correctly recorded

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oops. I'll fix that when I resolve the conflicts. thanks for catching it.

@rocketsroger rocketsroger merged commit 2322cbd into mozilla-mobile:master Mar 8, 2021
@rocketsroger rocketsroger deleted the FB_18068 branch March 8, 2021 21:35
@rocketsroger rocketsroger removed the needs:review PRs that need to be reviewed label Mar 8, 2021
@rocketsroger rocketsroger added this to the 88 milestone Mar 8, 2021
@gabrielluong gabrielluong removed this from the 88 milestone Mar 9, 2021
pkirakosyan pushed a commit to gexsi/user-agent-android that referenced this pull request Aug 5, 2021
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.

Use AwesomeBarFacts for AwesomeBar Telemetry
5 participants