1274727 - Update core ping search docs with more information

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: General, defect)

Description

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

"other" & the location strings.

17:26 <bnicholson> mcomella: what do you send with the "searches" data for custom engines? do you just not report them?
17:27 <bnicholson> mcomella: also, what are the different source strings you're using?
17:27 <bnicholson> should add this to the doc!
17:29 <mcomella> bnicholson: "other" https://dxr.mozilla.org/mozilla-central/source/mobile/android/base/java/org/mozilla/gecko/BrowserApp.java#3909
17:29 <mcomella> bnicholson: What do you mean source strings?
17:29 <mcomella> bnicholson: Patches welcome ;)
17:31 <bnicholson> mcomella: what are the strings other than "searchbar"?
17:33 <mcomella> bnicholson: I'm using our UI telemetry strings, e.g.: https://dxr.mozilla.org/mozilla-central/source/mobile/android/base/java/org/mozilla/gecko/home/BrowserSearch.java#732
17:33 <mcomella> LIST_ITEM
17:34 <mcomella> bnicholson: SUGGESTION, & ACTIONBAR

Comment 1

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

Attachment: MozReview Request: Bug 1274727 - Document more details about searches core ping field. r=bnicholson

Review commit: https://reviewboard.mozilla.org/r/54678/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/54678/

Comment 2

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

Attachment: MozReview Request: Bug 1274727 - Use toString method for search engine identifiers. r=bnicholson

These values are what are actually used UI telemetry (perhaps because the enums were added after the strings?). They're also a little less obnoxious than the enum names.

Review commit: https://reviewboard.mozilla.org/r/54686/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/54686/

Comment 3

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

Comment on attachment 8755597 [details]
MozReview Request: Bug 1274727 - Document more details about searches core ping field. r=bnicholson

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/54678/diff/1-2/

Comment 4

[Brian Nicholson (:bnicholson)]

Comment on attachment 8755614 [details]
MozReview Request: Bug 1274727 - Use toString method for search engine identifiers. r=bnicholson

https://reviewboard.mozilla.org/r/54686/#review51320

Comment 5

[Brian Nicholson (:bnicholson)]

Comment on attachment 8755597 [details]
MozReview Request: Bug 1274727 - Document more details about searches core ping field. r=bnicholson

https://reviewboard.mozilla.org/r/54678/#review51316

::: toolkit/components/telemetry/docs/core-ping.rst:50
(Diff revision 2)
>                             // in local time, "yyyy-mm-dd"
>        "tz": <integer>, // timezone offset (in minutes) of the
>                         // device when the ping was created
>        "searches": <object>, // Optional, object of search use counts in the
>                              // format: { "engine.source": <pos integer> }
> -                            // e.g.: { "yahoo.searchbar": 3, "other.searchbar": 1 }
> +                            // e.g.: { "yahoo.SUGGESTION": 3, "other.LIST_ITEM": 1 }

This should be ".suggestion" and ".listitem", right?

Comment 6

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/cf8073f1db3b
https://hg.mozilla.org/integration/fx-team/rev/021ff359274b

Comment 7

[Michael Comella (:mcomella) [NI reported issues only: ex-Mozilla]]

https://hg.mozilla.org/integration/fx-team/rev/cf8073f1db3b9bcee2c2dc208ef22993c3f25406
Bug 1274727 - Use toString method for search engine identifiers. r=bnicholson

https://hg.mozilla.org/integration/fx-team/rev/021ff359274b008d3d9a4c74ed07a67f965a75c2
Bug 1274727 - Document more details about searches core ping field. r=bnicholson

Comment 8

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/cf8073f1db3b
https://hg.mozilla.org/mozilla-central/rev/021ff359274b