1815906 - Improve history library telemetry

Status: VERIFIED FIXED

(Firefox :: Firefox View, task, P1)

Description

[Sarah Clements [:sclements]]

We want to add the same probes that were added to the sidebar (in bug 801290 and bug 1815706) to the library where possible if they don't already exist (focusing on history for now):

1. how many times the library was opened per session.
2. how many times searches were performed in the history search input.
3. Cumulative number of searches performed before selecting a link.
4. Total number of history entries clicked or opened per session.

Comment 1

[Kelly Cochrane [:kcochrane]]

For numbers 3 and 5, what do you mean by "search filters"? I don't see anywhere in the Library window to apply search filters.

Comment 2

[Sarah Clements [:sclements]]

(In reply to Kelly Cochrane [:kcochrane] from comment #1)

For numbers 3 and 5, what do you mean by "search filters"? I don't see anywhere in the Library window to apply search filters.

Sorry, I did a copy/paste job from the sidebar telemetry. If its not applicable, ignore it :) I'll edit the first comment.

Comment 3

[Kelly Cochrane [:kcochrane]]

Attachment: Bug 1815906 - Add telemetry for History in Library window r=mkaply,mak

Comment 4

[Kelly Cochrane [:kcochrane]]

Based on this telemetry audit, it appears we already have ways to track when the Library itself was opened. Given that, I'm going to add telemetry for numbers 2-4 in the ticket description.

Comment 5

[Kelly Cochrane [:kcochrane]]

(In reply to Kelly Cochrane [:kcochrane] from comment #4)

Based on this telemetry audit, it appears we already have ways to track when the Library itself was opened. Given that, I'm going to add telemetry for numbers 2-4 in the ticket description.

Okay, after having another look, the telemetry audit doesn't include anything about when the Library window is opened, so I'm adding a scalar for that as well.

Comment 6

[Kelly Cochrane [:kcochrane]]

Attachment: Firefox Data Collection Request - History in Library Telemetry.txt

Comment 7

[Chris H-C :chutten]

Comment on attachment 9318455 [details]
Firefox Data Collection Request - History in Library Telemetry.txt

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.

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

Yes. This collection can be controlled through Firefox's Preferences.

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

Yes, Kelly Cochrane is responsible.

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

Category 2, Interaction.

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 the data collection use a third-party collection tool?

No.

---

Result: datareview+

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/18efff6f7c3c
Add telemetry for History in Library window r=mak

Comment 9

[Cristina Horotan [:chorotan]]

https://hg.mozilla.org/mozilla-central/rev/18efff6f7c3c

Comment 10

[Kelly Cochrane [:kcochrane]]

Comment on attachment 9317447 [details]
Bug 1815906 - Add telemetry for History in Library window r=mkaply,mak

Beta/Release Uplift Approval Request

• User impact if declined: Telemetry for History in the Library will not be recorded prior to adding History to Firefox View.
• Is this code covered by automated tests?: Yes
• Has the fix been verified in Nightly?: No
• Needs manual test from QE?: Yes
• If yes, steps to reproduce: Open Library using either the application toolbar, the navigation toolbar button, or the main menu and then History > Manage History
  • Once in the Library, we've added keyed scalars for:
    • library.opened - Records a scalar that indicates how many times the Library window was opened in the context of History. It will not be recorded if opened in the context of bookmarks/downloads.
    • library.link - Records a scalar that indicates how many History links are opened from the Library window
    • library.search - Records a scalar that indicates how many times a user makes a History-specific search within the Library
    • PLACES_LIBRARY_CUMULATIVE_HISTORY_SEARCHES - Records a histogram that indicates how many times a user has made a History-specifc search in the Library window before opening a History link in the Libary
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Relatively small change that adds telemetry probes to Library window. New telemetry is covered by automated tests.
• String changes made/needed: N/A
• Is Android affected?: No

Comment 11

[Donal Meehan [:dmeehan]]

Comment on attachment 9317447 [details]
Bug 1815906 - Add telemetry for History in Library window r=mkaply,mak

Approved for 111.0b5

Comment 12

[Donal Meehan [:dmeehan]]

https://hg.mozilla.org/releases/mozilla-beta/rev/b007def98f0c

Comment 13

[Donal Meehan [:dmeehan]]

Backed out changeset for causing Bug 1818547.
Beta Backout link

Comment 14

[Alexandru Trif, Desktop QA [:atrif]]

Hello! Verified fixed with Firefox 112.0a1 (2023-02-27) on Windows 10x64, macOS 12 and Ubuntu 20.04. Verified that:

• library.opened - is correctly incremented when the library is opened from: App Menu > History > Manage History, Library button> History > Manage History, Menu bar > History > Manage History, CTRL+ SHIFT+ H.
• library.link - is correctly incremented when a link is opened from the library window > History
• library.search - is correctly updated when performing searches inside Library > History
• PLACES_LIBRARY_CUMULATIVE_HISTORY_SEARCHES > records a Histogram event which shows how many searches are performed before a History link is opened from the Library.

Leaving these notes here for visibility:

• the telemetry is not updated when the link is opened using the context menu. Applies to bug 1815706 as well. I talked with Kelly on slack about this issue and this will be fixed in bug 1817251.
• the nr. of searches telemetry is updated multiple times when slowly typing in the Search history bar. Kelly is aware of this issue as well.

Thank you!