1309256 - Add documentation for BrowserUsageTelemetry

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[Alessio Placitelli [:Dexter]]

We should probably start documenting BrowserUsageTelemetry and how it behaves/what does it do, especially since we're routing searches through it.

We could start by adding some high level docs to: http://gecko.readthedocs.io/en/latest/browser/browser/index.html

Comment 1

[Alessio Placitelli [:Dexter]]

Attachment: bug1309256.patch

Georg, I'm too much into the domain right now. Do you feel like this docs give a satisfying high level overview of the BrowserUsageModule?

Moreover, should you review this or should :mak/:gijs?

Comment 2

[Alessio Placitelli [:Dexter]]

Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch

Marco, I'm not sure if you or Georg should review this. Anyway, does it look reasonable to you or is there anything else that you feel should be added to the docs?

Comment 3

[Marco Bonardo [:mak] (Away Apr 25 - May 5)]

Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch

Review of attachment 8806664 [details] [diff] [review]:
-----------------------------------------------------------------

LGTM, I'm honestly not sure how many details we should go into here. It may depend on the expected audience, whether it's technical, analytical or general purpose.

Comment 4

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8806664 [details] [diff] [review]
bug1309256.patch

Review of attachment 8806664 [details] [diff] [review]:
-----------------------------------------------------------------

Lets also reference this from the toolkit/components/telemetry docs.

::: browser/docs/BrowserUsageTelemetry.rst
@@ +21,5 @@
> +**Histograms**
> +
> +- *SEARCH_COUNTS*
> +
> +**Scalars**

Instead of listing histograms and scalars, should this talk more about the tasks it does?
E.g. talking about measuring tab & window interactions, uri loads and navigation events (plus example probe references).

Comment 5

[Alessio Placitelli [:Dexter]]

Attachment: bug1309256.patch

Comment 6

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8808220 [details] [diff] [review]
bug1309256.patch

Review of attachment 8808220 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good with the below fixed.

::: toolkit/components/telemetry/docs/data/index.rst
@@ +18,5 @@
>  The `mozilla-pipeline-schemas repository <https://github.com/mozilla-services/mozilla-pipeline-schemas/>`_ contains schemas for some of the pings.
> +
> +Browser Usage Telemetry
> +~~~~~~~~~~~~~~~~~~~~~~~
> +For more information, see :ref:`browserusagetelemetry`.

This is probably better listed in docs/collection/index.rst.

Comment 7

[Alessio Placitelli [:Dexter]]

Attachment: bug1309256.patch

Comment 8

[Alessio Placitelli [:Dexter]]

This only updates the in-tree docs, no need for a try push.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/e9d203fbb3f3
Add documentation for BrowserUsageTelemetry. r=gfritzsche

Comment 10

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/e9d203fbb3f3