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

For #1301: Add uri_count to metrics ping #1785

Merged
merged 1 commit into from
Apr 26, 2019

Conversation

colintheshots
Copy link
Contributor

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

@colintheshots colintheshots requested a review from a team as a code owner April 18, 2019 20:33
@ghost ghost assigned colintheshots Apr 18, 2019
@ghost ghost added the review label Apr 18, 2019
@@ -123,6 +123,19 @@ events:
notification_emails:
- fenix-core@mozilla.com
expires: "2020-03-01"
total_uri_count:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wanted to put this under the metrics category, but this bug got in the way:
mozilla-mobile/android-components#2793

@colintheshots
Copy link
Contributor Author

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 many URIs are our users visiting 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?
  • To measure how useful these features are
  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.

description: >
A counter of URIs visited by the user
send_in_pings:
- metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

fly-by: please note that this is not sending data in the baseline ping, but rather in the metrics ping. I'm mentioning this since the PR title refers to the baseline ping. Please keep in mind that these pings, as documented, serve different purposes and have different schedules.

Any specific reason why you want to send this in the baseline ping anyway?

Copy link
Contributor

Choose a reason for hiding this comment

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

@Dexterp37 Yeah, we noticed a couple of inconsistencies in the ticket. We're working on sorting it out!

Copy link
Contributor

Choose a reason for hiding this comment

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

Ya, also @colintheshots to update the PR/issue/commit message of this to not say baseline ping.

app/metrics.yaml Outdated
total_uri_count:
type: counter
description: >
A counter of URIs visited by the user
Copy link
Contributor

Choose a reason for hiding this comment

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

So this is not unique URIs visited, just all URIs?

Copy link
Contributor

Choose a reason for hiding this comment

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

Also specify if this is per-session

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is intended to be per-session, including reloads of the same URL. The intent was that it work similarly to Focus. https://github.com/mozilla-mobile/focus-android/blob/master/docs/Telemetry.md#uri-count

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll add those details to the yaml.

@colintheshots colintheshots changed the title For #1301: Add uri_count to baseline ping For #1301: Add uri_count to metrics ping Apr 25, 2019
@colintheshots
Copy link
Contributor Author

@liuche I updated the YAML.

Copy link
Contributor

@ekager ekager left a comment

Choose a reason for hiding this comment

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

LGTM

  1. Make sure you call subscribeToSessions :)
  2. We should think about where we are subscribing and the possible performance/ startup time hits from referencing engine related stuff (sessionmanager) from oncreate in homeactivity. Maybe we should do a follow up test for this

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

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

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

  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, visits to web pages

  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

  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?
    No, uses Glean SDK

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

5 participants