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

For #800 - Adds metrics for the default search engine #1606

Merged
merged 1 commit into from Apr 15, 2019

Conversation

boek
Copy link
Contributor

@boek boek commented Apr 12, 2019

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
  • Missing roboelectric :(

@boek boek requested a review from a team as a code owner April 12, 2019 20:27
@ghost ghost assigned boek Apr 12, 2019
@ghost ghost added the review label Apr 12, 2019
@boek boek force-pushed the i800_search_provider_telemetry branch from 3bdbb2e to a2482cc Compare April 12, 2019 20:39
@boek
Copy link
Contributor Author

boek commented Apr 12, 2019

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?
  • What the landscape of which search engines users set as their default
  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?
  • We want to make sure that users are using the correct URL and other relevant search engine information
  1. What alternative methods did you consider to answer these questions? Why were they not sufficient?
  • N/A (These are baseline metrics)
  1. Can current instrumentation answer these questions?
  • Currently no, as these are some of the first metrics we're recording
  1. 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 1.
  1. How long will this data be collected?

Until 03/01/2020

  1. What populations will you measure?
  • All release, beta, and nightly users with telemetry enabled.
  1. Please provide a general description of how you will analyze this data.
  • Glean / Amplitude
  1. Where do you intend to share the results of your analysis?
  • Only on Glean, Amplitude and with mobile teams.

@boek boek requested a review from liuche April 12, 2019 20:41
@boek boek added the needs:data-review PR is awaiting a data review label Apr 12, 2019
@boek boek force-pushed the i800_search_provider_telemetry branch from a2482cc to dc23fa1 Compare April 12, 2019 20:50
@boek
Copy link
Contributor Author

boek commented Apr 12, 2019

CI issue will get fixed by #1604

Copy link
Contributor

@liuche liuche 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 available publicly, complete and accurate?
    Yes, metrics.yaml

  2. Is there a control mechanism that allows the user to turn the data collection on and off?
    Yes, Fenix has telemetry controls in-app

  3. If the request is for permanent data collection, is there someone who will monitor the data over time?**
    No, 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, default search engine

  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, sending bundled search engines, no custom ones - will file a bug for when custom search engines get added to update this telemetry.

  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? (Yes/No) (If yes, set a todo reminder or file a bug if appropriate)**
    No, has expiry

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

app/metrics.yaml Outdated Show resolved Hide resolved
app/metrics.yaml Outdated Show resolved Hide resolved
@liuche
Copy link
Contributor

liuche commented Apr 12, 2019

Filed #1607 as a reminder when custom search engines are added that the telemetry needs to be updated.

@boek boek force-pushed the i800_search_provider_telemetry branch from dc23fa1 to 782889b Compare April 12, 2019 21:55
@boek
Copy link
Contributor Author

boek commented Apr 12, 2019

  1. How long will this data be collected?

Until 03/01/2020 09/01/2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs:data-review PR is awaiting a data review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants