1641396 - Add telemetry for the the about:logins menu items

Status: VERIFIED FIXED

(Firefox :: about:logins, enhancement, P2)

Description

[Matthew N. [:MattN]]

pwmgr:
  mgmt_menu_item_used:
    description: >
      These events record interactions in the about:logins menu.
    objects: [
      "import_from_browser",
      "export",
      "preferences",
    ]
    bug_numbers:
      - <this bug #>
    expiry_version: never
    notification_emails: ["[e-mail]", "[e-mail]"]
    release_channel_collection: opt-out
    products:
      - "firefox"
    record_in_processes: [content]

Add that around https://searchfox.org/mozilla-central/rev/bc3600def806859c31b2c7ac06e3d69271052a89/toolkit/components/telemetry/Events.yaml#660

I didn't bother with the web link one since we already have website analytics for those.

Then use the API:

import { recordTelemetryEvent } from "../aboutLoginsUtils.js";
recordTelemetryEvent({ object: "import_from_browser", method: "mgmt_menu_item_used" });

We will need a data review using the process at https://wiki.mozilla.org/index.php?title=Firefox/Data_Collection&mobileaction=toggle_view_desktop#Requesting_Data_Collection

Comment 1

[Andrei Petcu]

I added this in this review https://phabricator.services.mozilla.com/D75716

Comment 2

[Andrei Petcu]

Attachment: Bug 1641396 - Add telemetry for the the about:logins menu items

Depends on D75716

Comment 3

[Matthew N. [:MattN]]

Attachment: Request for data collection review form

Comment 4

[Andrei Petcu]

Attachment: Bug 1641396 Add telemetry for the the about:logins menu items

Depends on D77376

Comment 5

[Andrei Petcu]

Attachment: Bug 1641396 Add telemetry for the the about:logins menu items

Comment 6

[Tim Smith (inactive) 👨‍🔬 [:tdsmith]]

Comment on attachment 9152915 [details]
Request for data collection review form

1) Is there or will there be **documentation** that describes the schema for the ultimate data set in a public, complete, and accurate way?

Yes, in Events.yaml.

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

Yes, the Firefox telemetry opt out.

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

Yes, MattN.

4) Using the **[category system of data types](https://wiki.mozilla.org/Firefox/Data_Collection)** on the Mozilla wiki, what collection type of data do the requested measurements fall under?

Category 2, interaction data.

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?

n/a, permanent collection

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

No.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/5c4bc410f427
Add telemetry for the the about:logins menu items r=MattN

Comment 8

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/5c4bc410f427

Comment 9

[Simona Rosu [:srosu], Ecosystem QA, PTO until July 7th - NI to: [e-mail]]

I have verified this issue using the latest Firefox Nightly 79.0a1 (Build ID: 20200603214922) on Windows 10 x64, Ubuntu 18.04, Mac 10.14.6, Windows 7 x64.

• The following telemetry events are successfully registered:
  • The {method: mgmt_menu_item_used; object: “export”} event is registered after clicking the “Export logins…” option from the menu.
  • The {method: “mgmt_menu_item_used”; object: “import_from_browser”} event is registered after clicking the “Import from Another Browser..” option from the menu. (not available on Linux)
  • The {method: “mgmt_menu_item_used”; object: “export_complete”} event is registered after finishing exporting the logins into a CSV file.
  • The {method: “mgmt_menu_item_used”; object: “preferences”} event is registered after clicking the “Options” option from the menu.