1273684 - Add docs after landing core ping session measurements

Status: RESOLVED FIXED

(Firefox for Android Graveyard :: General, defect)

Description

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

Keeping the implementation separate from the doc update so we don't have issues uplifting.

Comment 1

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

Attachment: MozReview Request: Bug 1273684 - Add session measurements core ping doc. r=gfritzsche

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

Comment 2

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8753588 [details]
MozReview Request: Bug 1273684 - Add session measurements core ping doc. r=gfritzsche

https://reviewboard.mozilla.org/r/53378/#review50628

::: toolkit/components/telemetry/docs/core-ping.rst:104
(Diff revision 1)
> +On Android, a session is the time when Firefox is focused in the foreground.
> +Note that showing a dialog (including a Firefox dialog) will take Firefox out
> +of focus & end the current session.
> +
> +An implementation that records a session when Firefox is completely hidden is
> +preferrable (e.g. to avoid the dialog issue above), however, it's more complex
> +to implement and so we chose not to, at least for the initial implementation.

Thats good background in the documentation, thanks.
Lets shortly explain what the two fields specifically measure as well?

Comment 3

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

https://reviewboard.mozilla.org/r/53378/#review50628

> Thats good background in the documentation, thanks.
> Lets shortly explain what the two fields specifically measure as well?

This is defined in the top section, when the fields are shown in the ping directly – is there something more you're looking for? I'd rather not duplicate the information down here.

Comment 4

[Georg Fritzsche [:gfritzsche]]

https://reviewboard.mozilla.org/r/53378/#review50628

> This is defined in the top section, when the fields are shown in the ping directly – is there something more you're looking for? I'd rather not duplicate the information down here.

You could include this in the descriptions here, e.g.
> ... a session, tracked in `sessionCount` is the time when ...

I don't immediately get how the good background here connects to the field names. The comments on top are terse and a bit out of context from this piece.

Comment 5

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

Comment on attachment 8753588 [details]
MozReview Request: Bug 1273684 - Add session measurements core ping doc. r=gfritzsche

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

Comment 6

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8753588 [details]
MozReview Request: Bug 1273684 - Add session measurements core ping doc. r=gfritzsche

https://reviewboard.mozilla.org/r/53378/#review51480

Thanks.

Comment 7

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

https://hg.mozilla.org/integration/fx-team/rev/05adfc869721ffaa57a0b341bd56d78d9f5867f4
Bug 1273684 - Add session measurements core ping doc. r=gfritzsche

Comment 8

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/05adfc869721