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

For #1158 - Add search counts #1677

Merged
merged 1 commit into from Apr 17, 2019
Merged

Conversation

boek
Copy link
Contributor

@boek boek commented Apr 16, 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
  • Changelog: This PR includes a changelog entry or does not need one
  • Accessibility: The code in this PR follows accessibility best practices or does not include any user facing features

@boek boek requested a review from a team as a code owner April 16, 2019 23:32
@ghost ghost assigned boek Apr 16, 2019
@ghost ghost added the review label Apr 16, 2019
@boek boek added the needs:data-review PR is awaiting a data review label Apr 16, 2019
@boek boek force-pushed the i1158-search_counts branch 2 times, most recently from d59532d to f5758ce Compare April 16, 2019 23:38
@boek
Copy link
Contributor Author

boek commented Apr 16, 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?
  • How often users use the different search engines bundled with Fenix
  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 be able to measure the search health and have parity with desktop
  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 2.
  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 force-pushed the i1158-search_counts branch 2 times, most recently from 7ef5856 to 302a30e Compare April 16, 2019 23:51
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 data controls

  3. If the request is for permanent data collection, is there someone who will monitor the data over time?**
    Has expiry, fenix-core@ will monitor

  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, and any custom search engines will be sent as custom

  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)**
    Has expiry

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

source:
description: >
A string that tells us how the user performed the search. Possible values are:
* default.action
Copy link
Contributor

Choose a reason for hiding this comment

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

If you're not collecting the search engine name here, does Glean have things like histograms? That seems like it might be more suited to this (but up to you).

@boek boek removed the needs:data-review PR is awaiting a data review label Apr 17, 2019
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.

None yet

3 participants