1660686 - Add some telemetry to measure how long it takes to collect printer information

Status: RESOLVED FIXED

(Core :: Printing: Setup, task, P1)

Description

[Jonathan Watt [:jwatt]]

We know that there's the potential for some of the operations that collect information about the available printers for the new print UI to take a long time. To help decide how much effort we should put into caching/optimizing, it would be helpful to have some histogram telemetry to measure how badly the delays can be for the various operations. Basically we should add telemetry for the Promise returning APIs on PrinterList and the objects that can be accessed via it.

Comment 1

[Bob Owen (:bobowen)]

Attachment: Bug 1660686: Add telemetry for time taken in print background tasks. r=jwatt, dr=tdsmith

Comment 2

[Bob Owen (:bobowen)]

Attachment: Print Background Task Data Review Form.txt

Comment 3

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

Comment on attachment 9172393 [details]
Print Background Task Data Review Form.txt

Thanks!

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 the probe definition files and the Probe Dictionary.

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?

n/a; temporary collection

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

Category 1, technical data. The histogram keys aren't mentioned in the data collection request; the description (copied over from Phab) is:

Keys describe the task, usually the information being retrieved, current possible keys are: DefaultSettings, MarginsForPaper, Printers, NamedPrinter, NamedOrDefaultPrinter, SupportsDuplex, SupportsColor, SupportsCollation, PaperList.

These are also cat 1.

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?

bobowen et al are responsible for renewing the collection as needed.

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

No.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ca085d770da4
Add telemetry for time taken in print background tasks. r=jwatt, dr=tdsmith

Comment 5

[Noemi Erli[:noemi_erli]]

Backed out changeset ca085d770da4 (Bug 1660686) for causing bustage in PrintBackgroundTask.h CLOSED TREE

Push with failures: https://treeherder.mozilla.org/#/jobs?repo=autoland&group_state=expanded&resultStatus=testfailed%2Cbusted%2Cexception&revision=ca085d770da4c6f0d90ecd8352e06c848a38eaed&selectedTaskRun=fKZU2pyxSLKAc_TwRShw8A.0

Failure log: https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=314324956&repo=autoland&lineNumber=89456

Backout: https://hg.mozilla.org/integration/autoland/rev/d05ddb4058554895f18b57f713956b7a4d03420e

Comment 6

[Bob Owen (:bobowen)]

emilio: thanks for looking at this, failure log is in previous comment.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1bf9ecdd9e77
Add telemetry for time taken in print background tasks. r=jwatt, dr=tdsmith

Comment 8

[Narcis Beleuzu [:NarcisB]]

https://hg.mozilla.org/mozilla-central/rev/1bf9ecdd9e77

Comment 9

[Bob Owen (:bobowen)]

Comment on attachment 9172202 [details]
Bug 1660686: Add telemetry for time taken in print background tasks. r=jwatt, dr=tdsmith

Beta/Release Uplift Approval Request

• User impact if declined: As part of the new Print Preview UI work, we want to be able to detect long printing system API calls that might be causing poor user experience.
• Is this code covered by automated tests?: No
• Has the fix been verified in Nightly?: Yes
• Needs manual test from QE?: No
• If yes, steps to reproduce:
• List of other uplifts needed: None
• Risk to taking this patch: Low
• Why is the change risky/not risky? (and alternatives if risky): Relatively simple patch that adds telemetry to existing code.
• String changes made/needed: None

Comment 10

[Ryan VanderMeulen [:RyanVM]]

Comment on attachment 9172202 [details]
Bug 1660686: Add telemetry for time taken in print background tasks. r=jwatt, dr=tdsmith

Approved for 81.0b5.

Comment 11

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/releases/mozilla-beta/rev/9fe17cc77d22