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

For #11655: add leanplum event for installing an addon #12136

Merged
merged 3 commits into from
Jul 12, 2020

Conversation

jhugman
Copy link
Contributor

@jhugman jhugman commented Jun 30, 2020

Fixes #11655.

This PR adds a metrics Event fired when the user has successfully installed an addon from the addon manager.

It further enables the event to be logged as a LeanPlum event. It is not enabled as a Glean event.

The data-review will occur in this PR.

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.

After merge

  • Milestone: Make sure issues finished by this pull request are added to the milestone of the version currently in development.

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

@jhugman
Copy link
Contributor Author

jhugman commented Jun 30, 2020

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?

To measure how often addons are installed.

  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?

This will drive the CFR/mobile marketing automation, this will aid feature discovery for the users.

  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?
  • No, we are not tracking this for Glean, but we need access to them in Leanplum for mobile marketing automation usage.
  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?

This data will be present as long as the user ID exists in Leanplum. LeanPlum does not support expiry dates for probes, but the mobile engagement/marketing automation teams will track this. @cbonacuse is the first contact here.

  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.
  • Leanplum / Amplitude
  1. Where do you intend to share the results of your analysis?
  • Only on Leanplum, Amplitude and with mobile teams.

@jhugman jhugman added the needs:data-review PR is awaiting a data review label Jun 30, 2020
@jhugman jhugman requested a review from boek June 30, 2020 17:01
Copy link
Contributor

@eliserichards eliserichards left a comment

Choose a reason for hiding this comment

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

This looks great. Ready to merge pending data approval from @boek

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.

I assume this was a copypasta error, but the data request is about tracking protection, not addon usage. Please update the request form! @jhugman

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 in a public, complete, and accurate way?

addon addition is documented in mma.md

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

Yes, Leanplum collection is covered by Fenix data controls

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

We should review Leanplum probes every 6 mo, and @cbonacuse from Mobile Engagement will monitor. @cbonacuse is also looking into how we might get LeanPlum automatic expiry.

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

Type 2, interaction with addons by adding one

  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 (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?

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

Yes, @liuche will schedule an MMA checkin with @cbonacuse for 6mo from now

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

Leanplum, which is approved for this type of collection.

@liuche liuche removed the needs:data-review PR is awaiting a data review label Jul 9, 2020
@jhugman jhugman force-pushed the jhugman/11655-add-lp-events branch from 6fe5039 to 26760a5 Compare July 10, 2020 22:32
@jhugman jhugman force-pushed the jhugman/11655-add-lp-events branch from 26760a5 to c54222a Compare July 10, 2020 22:49
@jhugman jhugman merged commit 9df13ae into master Jul 12, 2020
@jhugman jhugman deleted the jhugman/11655-add-lp-events branch July 12, 2020 22:47
@liuche liuche mentioned this pull request Jul 20, 2020
9 tasks
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.

Add new Leanplum E_Add_Ons_Added Event
3 participants