987333 - Document BrowserUITelemetry JSON blob format

Status: RESOLVED FIXED

(Firefox :: Toolbars and Customization, defect)

Description

[Mike Conley (:mconley) (:⚙️)]

This has come up a number of times in various discussions, and most recently when talking to Ilana Segall, who is working on processing the BrowserUITelemetry stuff we're gathering for Australis.

We really should document the format we're using here to make it easier to interpret what we're recording, what we're _not_ recording, and how we're doing it.

Comment 1

[:Gijs (he/him)]

Mike, I just landed some of this with bug 991757. Can you have a look at it and see what is still missing / could be improved? I think it could probably do (at the least) with a better explanation about the buckets, which I will happily admit I don't fully understand myself... :-)

Comment 2

[Mike Conley (:mconley) (:⚙️)]

Whoa! We're doing Sphinx now? THANK GOODNESS! :) That's awesome.

The docs look good - though we might want to add something about buckets. Blair, do you think you'd have a few minutes to extend that documentation with the bucket stuff?

Comment 3

[Blair McBride [:Unfocused] (UNAVAILABLE)]

Attachment: MozReview Request: bz://987333/Unfocused

Comment 4

[Blair McBride [:Unfocused] (UNAVAILABLE)]

/r/1797 - Bug 987333 - Add documentation for UITour and buckets to BrowserUITelemetry docs.

Pull down this commit:

hg pull review -r 20d82a2b517fdff78445865617e8c219610e6aa7

Comment 5

[Blair McBride [:Unfocused] (UNAVAILABLE)]

Oh, and it seems the existing UITelemetry document wasn't ever included in the generated docs:
https://gecko.readthedocs.org/en/latest/browser/browser/index.html
So I've fixed that too.

Comment 6

[Mike Conley (:mconley) (:⚙️)]

https://reviewboard.mozilla.org/r/1795/#review1243

So good to have documentation. Thanks for this, Blair. :)

::: browser/docs/UITelemetry.rst
(Diff revision 1)
> +- ``bucket_<NAME>|<INTERVAL>`` - Expiring buckets, which similar to a countdown timer. The ``<INTERNAL>`` in the bucket ID describes the time interval the recorded event happened in. The intervals are ``1m`` (one minute), ``3m`` (three minutes), ``10m`` (ten minutes), and ``1h`` (one hour). After one hour, the ``__DEFAULT__`` bucket is automatically used again.

"which similar" -> "which are similar",
"<INTERNAL>" -> "<INTERVAL>"

::: browser/docs/UITelemetry.rst
(Diff revision 1)
> -The UI Tour has its own section in the UI Telemetry output, outside of the ``toolbars`` section.
> +The UITour API provides ways for pages on trusted domains to safely interact with the browser UI and request it perform ations such as opening menus and showing highlights over the browser chrome - for the purposes of interactive tours. We track some usage of this API via the ``UITour`` object in the UI Telemetry output.

"request it perform" -> "request it to perform"

Comment 7

[Blair McBride [:Unfocused] (UNAVAILABLE)]

https://hg.mozilla.org/integration/fx-team/rev/9477cb31bf80

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/9477cb31bf80

Comment 10

[Blair McBride [:Unfocused] (UNAVAILABLE)]

Attachment: MozReview Request: Bug 987333 - Add documentation for UITour and buckets to BrowserUITelemetry docs.