1607621 - Data Collection Review Request: application-services Places Manager quality metrics

Status: RESOLVED FIXED

(Firefox :: Sync, task)

Description

[Lougenia Bailey]

Attachment: data-review-request.md

+++ This bug was initially created as a clone of Bug #1597895 +++

The application-services Places Manager is a re-usable component for storing and syncing saved bookmarks and browser history, currently used in the Fenix and Firefox Reality:

https://github.com/mozilla/application-services/tree/master/components/places

Since this is a new component underlying an important piece of browser functionality, we'd like to gather some basic quality and performance metrics so we can be confident it is working correctly. A skeleton of the metrics-gathering code (including the proposed Glean metrics.yaml file) is being developed here:

https://github.com/mozilla/application-services/pull/2431

This bug is to track review of the proposed telemetry collection, and I'll attach the review request template presently...

Comment 1

[Alessio Placitelli [:Dexter]]

Lougenia, I noticed that you set data-review+ instead of requesting a data-review to a Data Steward as outlined here. Was this intentional?

Comment 2

[Lougenia Bailey]

(In reply to Alessio Placitelli [:Dexter] from comment #1)

Lougenia, I noticed that you set data-review+ instead of requesting a data-review to a Data Steward as outlined here. Was this intentional?

Alessio, sadly that was not intentional. Ticket has been updated--my apologies.

Comment 3

[Chris H-C :chutten]

Comment on attachment 9119272 [details]
data-review-request.md

Will places use glean_parser's automatic documentation output to generate human-readable documentation for the data collections? 

(( public-facing documentation is one of the criteria [I need](https://github.com/mozilla/data-review/blob/master/review.md) to proceed with data collection review ))

Comment 4

[Lougenia Bailey]

(In reply to Chris H-C :chutten from comment #3)

Comment on attachment 9119272 [details]
data-review-request.md

Will places use glean_parser's automatic documentation output to generate
human-readable documentation for the data collections?

(( public-facing documentation is one of the criteria I
need to
proceed with data collection review ))

Yes, we'll be using glean_parser to generate the places metrics documentation. We're actually considering adding the parser to our CI build process so that changes to the metrics.yaml file are automatically generated. Is that a sufficient answer or is more required to satisfy that condition?

Comment 5

[Alessio Placitelli [:Dexter]]

(In reply to Lougenia Bailey from comment #4)

(In reply to Chris H-C :chutten from comment #3)

Comment on attachment 9119272 [details]
data-review-request.md

Will places use glean_parser's automatic documentation output to generate
human-readable documentation for the data collections?

(( public-facing documentation is one of the criteria I
need to
proceed with data collection review ))

Yes, we'll be using glean_parser to generate the places metrics documentation. We're actually considering adding the parser to our CI build process so that changes to the metrics.yaml file are automatically generated. Is that a sufficient answer or is more required to satisfy that condition?

Hey Lougenia, sorry if I chime in here :-) I think you're already integrating it (otherwise you wouldn't be able to use the Glean SDK!). The docs are available in your PR here.

Comment 6

[Lougenia Bailey]

(In reply to Alessio Placitelli [:Dexter] from comment #5)

(In reply to Lougenia Bailey from comment #4)

(In reply to Chris H-C :chutten from comment #3)

Comment on attachment 9119272 [details]
data-review-request.md

Will places use glean_parser's automatic documentation output to generate
human-readable documentation for the data collections?

(( public-facing documentation is one of the criteria I
need to
proceed with data collection review ))

Yes, we'll be using glean_parser to generate the places metrics documentation. We're actually considering adding the parser to our CI build process so that changes to the metrics.yaml file are automatically generated. Is that a sufficient answer or is more required to satisfy that condition?

Hey Lougenia, sorry if I chime in here :-) I think you're already integrating it (otherwise you wouldn't be able to use the Glean SDK!). The docs are available in your PR here.

I was answered assuming the existence of the generated docs was known but by making that assumption and answering the way I did I may have confused the matter. Long story short, I appreciate the clarification.

Comment 7

[Chris H-C :chutten]

Comment on attachment 9119272 [details]
data-review-request.md

Ack I'm sorry, I missed the docs in the PR. Must've scrolled past them, that's my error. I'll get to the data review promptly.

Comment 8

[Chris H-C :chutten]

Comment on attachment 9119272 [details]
data-review-request.md

DATA COLLECTION REVIEW RESPONSE:

    Is there or will there be documentation that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes. This collection is collected via the Glean SDK so is documented in its definitions file [metrics.yaml](https://github.com/mozilla/application-services/blob/master/components/places/android/metrics.yaml) and in the autodocs [metrics.md](https://github.com/mozilla/application-services/blob/master/docs/metrics/places/metrics.md).

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

Yes. This collection can be controlled through the embedding application's Preferences. (for example, Fenix has the control in its Settings UI)

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

No. This collection will expire in builds built on or after 2020-07-01.

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

Category 1, Technical. (The request says Category 2, but that's saved more for things that are measuring user interaction. These counts of db operations and their timings are Category 1)

    Is the data collection request for default-on or default-off?

Default on for all channels.

    Does the instrumentation include the addition of any new identifiers?

No.

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

Yes.

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

Yes. Lougenia Bailey is responsible for renewing or removing the collection before it expires in 2020-07-01.

---
Result: datareview+

Comment 9

[Ryan Kelly [:rfkelly]]

This has data-review+ and the corresponding changes have landed in github, so I'm going to close out the bug. Thanks all!