1866437 - Implement Telemetry for the highlighting feature

Status: VERIFIED FIXED

(Firefox :: PDF Viewer, enhancement)

Comment 1

[BMO Github Automation]

Attachment: [mozilla/pdf.js] [Editor] Add some telemetry for the highlight feature (bug 1866437) (#17737)

Comment 2

[Calixte Denizet (:calixte)]

Attachment: data_collection_request.txt

Comment 3

[Travis Long [:travis_]]

Comment on attachment 9387932 [details]
data_collection_request.txt

Data Review

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, through the metrics.yaml file and the Glean Dictionary.

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

Yes, through the data preferences in the application settings.

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

Permanent collection to be monitored by calixte and the pdfjs-team

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

No

Result

data-review+

Comment 4

[Calixte Denizet (:calixte)]

Attachment: Bug 1866437 - Add some telemetry for the highlight feature in pdf.js r=#pdfjs-reviewers

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/42781edfbf79
Add some telemetry for the highlight feature in pdf.js r=pdfjs-reviewers,marco

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1143e3d3f40c
Add some telemetry for the highlight feature in pdf.js r=pdfjs-reviewers,marco

Comment 7

[Pulsebot]

Backout by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/511874307bd1
Backed out changeset 42781edfbf79 as requested by developer for proper reland CLOSED TREE

Comment 8

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/1143e3d3f40c

Comment 9

[Calixte Denizet (:calixte)]

Comment on attachment 9388174 [details]
Bug 1866437 - Add some telemetry for the highlight feature in pdf.js r=#pdfjs-reviewers

Beta/Release Uplift Approval Request

• User impact if declined: No telemetry for the new highlight in pdf feature
• 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: Use the feature and check that the different counters are updated.
  The different counters can be found here:
  https://searchfox.org/mozilla-central/source/toolkit/components/pdfjs/metrics.yaml#143-334
  and there are some descriptions about them.
• List of other uplifts needed: Bug 1866438, Bug 1883050
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): The new feature is behind a pref and pdf.js is self-contained.
• String changes made/needed: No
• Is Android affected?: No

Comment 10

[Dianna Smith [:diannaS]]

Comment on attachment 9388174 [details]
Bug 1866437 - Add some telemetry for the highlight feature in pdf.js r=#pdfjs-reviewers

Approved for 124.0b7

Comment 11

[Pulsebot]

https://hg.mozilla.org/releases/mozilla-beta/rev/8f6c9335d1f8

Comment 12

[Rares Doghi, Desktop QA]

This issue is verified as fixed in Nightly as well as our latest Beta 124.0b7, we do see the Telemetry pings, however the following two metrics are added to the metrics.yaml but the actions that triggers them are not yet implemented in Firefox:

edited:
  type: counter
  description: >
    Counts the number of times the user edits highlights.

toggle_visibility:
  type: counter
  description: >
    Counts the number of times the user toggles the visibility of highlights.

Also we only have one method for highlighting implemented so far (the main_toolbar), Highlighting using the Context menu or from a Floating button will be implemented later:

method:
  type: labeled_counter
  labels:
    - context_menu
    - main_toolbar
    - floating_button
  description: >
    Counts the number of times a given method is used to highlight.