1492233 - Add telemetry for browser.search WebExtension API

Status: VERIFIED FIXED

(Firefox :: Search, enhancement, P1)

Description

[Mike Kaply [:mkaply]]

If the WebExtension browser.search API is used for a built in engine, we should record it in telemetry.

Comment 1

[Mike Kaply [:mkaply]]

Should just be a matter of:

BrowserSearch.recordSearchInTelemetry(engine, "urlbar", details) or BrowserUsageTelemetry.recordSearch

With a new type ("webextension");

Might also need to add new engagement type to 

https://searchfox.org/mozilla-central/source/toolkit/components/telemetry/Scalars.yaml#179

Need to follow complete path for search recording.

Comment 2

[Mike Kaply [:mkaply]]

Attachment: Bug 1492233 - Add telemetry for search from webextension.

Comment 3

[Mike Kaply [:mkaply]]

I'm guess I need datareview for this.

Comment 4

[Mike Kaply [:mkaply]]

Attachment: webextension_searchrequest.md

Rebecca:

Not sure if you're the right person for this. Seeking data review.

Comment 5

[Mike de Boer [:mikedeboer]]

Comment on attachment 9010273 [details]
Bug 1492233 - Add telemetry for search from webextension.

Mike de Boer [:mikedeboer] has approved the revision.

Comment 6

[François Marier [:francois]]

Comment on attachment 9010292 [details]
webextension_searchrequest.md

1) Is there or will there be **documentation** that describes the schema for the ultimate data set available publicly, complete and accurate?

Yes, in Scalars.yaml.

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

Yes, telemetry setting.

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

Yes, Ryan Harter.

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 1 or 2.

5) Is the data collection request for default-on or default-off?

Default ON, all channels.

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?

No, permanent.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9ab885f5520f
Add telemetry for search from webextension. r=mikedeboer

Comment 8

[Andreea Pavel [:apavel]]

https://hg.mozilla.org/mozilla-central/rev/9ab885f5520f

Comment 9

[Mike Kaply [:mkaply]]

Comment on attachment 9010273 [details]
Bug 1492233 - Add telemetry for search from webextension.

Approval Request Comment
[Feature/Bug causing the regression]: Need telemetry for a new webextension API
[User impact if declined]: None
[Is this code covered by automated tests?]: No
[Has the fix been verified in Nightly?]: No
[Needs manual test from QE? If yes, steps to reproduce]: Yes
[List of other uplifts needed for the feature/fix]: N
[Is the change risky?]: no
[Why is the change risky/not risky?]: Just adds telemetry, no other changes.
[String changes made/needed]:

Comment 10

[Pascal Chevrel:pascalc]

(In reply to Mike Kaply [:mkaply] from comment #9)
> Comment on attachment 9010273 [details]
> [Has the fix been verified in Nightly?]: No

Since it landed a couple days ago, can you check that you are receiving telemetry data on nightly for this probe?

> [Needs manual test from QE? If yes, steps to reproduce]: Yes

The QE steps are missing.

Comment 11

[Mike Kaply [:mkaply]]

> Since it landed a couple days ago, can you check that you are receiving telemetry data on nightly for this probe?

We wouldn't because there would have to be an addon in the wild that used the new API.


> The QE steps are missing.

Sorry, was working on that. I'll get a test addon up in a couple hours with an explanation

Comment 12

[Pascal Chevrel:pascalc]

Comment on attachment 9010273 [details]
Bug 1492233 - Add telemetry for search from webextension.

Low risk as it is only adding telemetry, uplift approved for 63 beta 10, thanks.

Comment 13

[Dorel Luca [:dluca]]

https://hg.mozilla.org/releases/mozilla-beta/rev/75c5cc385dc7

Comment 14

[Mike Kaply [:mkaply]]

Attachment: Sample webextension

To test:

Install this webextension via about:debugging.

Click the puzzle piece icon on the toolbar.

go to about:telemetry

Verify there is a Keyed Histogram with the name SEARCH_COUNTS that has an entry for google-2018.webextension

Comment 15

[Paul_B]

Verified using the latest DevEdition 63.0b10 (Build ID: 20180927143327) and latest Nightly 64.0a1 (Build ID: 20181001100147) on Windows 10, Windows 7, Ubuntu 18.04, Ubuntu 16.04 and Mac OSX. Everything works as described above.