1244182 - Properly document all the fields of the main ping

Status: RESOLVED FIXED

(Toolkit :: Telemetry, defect, P1)

Description

[Alessio Placitelli [:Dexter]]

We need to properly document all the fields in the main ping.

Comment 1

[Alessio Placitelli [:Dexter]]

We should at least have a small description for all the top level properties.

Comment 2

[Alessio Placitelli [:Dexter]]

Attachment: bug1244182.patch

Sorry for the delay, but this took a bit of code archaeology to find out about a few things :)

Comment 3

[Georg Fritzsche [:gfritzsche]]

Comment on attachment 8715741 [details] [diff] [review]
bug1244182.patch

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

::: toolkit/components/telemetry/docs/main-ping.rst
@@ +84,5 @@
>  If ``sessionLength`` is ``-1``, the monotonic clock is not working.
>  
> +childPayloads
> +-------------
> +The Telemetry payloads sent by child processes, only available with e10s.

Lets add a little bit on the contents of the child payloads (i.e. they are a reduced session payload with ... stripped).
I'd like to see more documentation on how they are collected etc. - maybe chutten can document this in a follow-up bug.

Comment 4

[Alessio Placitelli [:Dexter]]

Attachment: bug1244182.patch

Comment 5

[Alessio Placitelli [:Dexter]]

(In reply to Georg Fritzsche [:gfritzsche] from comment #3)
> I'd like to see more documentation on how they are collected etc. - maybe
> chutten can document this in a follow-up bug.

Filed bug 1246644.

Comment 6

[Pulsebot]

https://hg.mozilla.org/integration/fx-team/rev/68f3b136eeac

Comment 7

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/68f3b136eeac