1358206 - Add in-tree Docs for mobile-event ping

Status: RESOLVED WONTFIX

(Focus-iOS :: General, enhancement, P3)

Description

[Frank Bertsch [:frank]]

Per a discussion with policy and legal, we decided the best place for the focus-event ping docs to exist was side-by-side with the rest of the ping documentation in readthedocs.

This should mirror the docs for existing pings.

Comment 1

[Georg Fritzsche [:gfritzsche]]

Moving this to the hopefully right component.
I'm happy to feedback this if it helps.

Comment 2

[Frank Bertsch [:frank]]

Attachment: 0001-Bug-1358206-Add-focus-event-ping-docs.r-sebastian.patch

Comment 3

[Sebastian Kaspari (:sebastian; :pocmo)]

Comment on attachment 8860144 [details] [diff] [review]
0001-Bug-1358206-Add-focus-event-ping-docs.r-sebastian.patch

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

::: toolkit/components/telemetry/docs/data/focus-event-ping.rst
@@ +28,5 @@
> +      "locale": <string>, // application locale, e.g. "en-US"
> +      "os": <string>, // OS name, e.g. Android
> +      "osversion": <string>, // OS version
> +      "created": <Timetamp> , // UNIX time, ms since epoch
> +      "tz": <integer>, // e.g. -300

+ in minutes?

@@ +58,5 @@
> +    a) Key: “pref_privacy_block_analytics”
> +    b) Values: [“true”, “false”]
> +#) Block web fonts
> +    a) Key: “pref_performance_block_webfonts”
> +    b) Values: [“true”, “false”]

There's a new one for blocking images: pref_performance_block_images

@@ +89,5 @@
> +~~~~~~~~~~~~~~~~~~
> +This header is used to track the submission date of the focus-event ping in the format
> +specified by
> +`rfc 2616 sec 14.18 <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18>`_,
> +et al (e.g. "Tue, 01 Feb 2011 14:00:00 GMT").

Oh, this is good to know. I don't set this header explicitly. Maybe the HTTP client is setting it.. otherwise I should add it.

Comment 4

[Frank Bertsch [:frank]]

How does this look? Tried to NI ellee but it looks like he's on PTO.

Comment 5

[Merwin]

Looks good.

Comment 6

[Frank Bertsch [:frank]]

Elvin, does this look okay?

Comment 7

[Elvin Lee [:ellee] (no longer with Mozilla)]

LGTM.

Comment 8

[Sebastian Kaspari (:sebastian; :pocmo)]

Since the first review of the patch Focus has added some more probes. We are documenting them in the Focus repository (just because it is straight-forward to update the document at the same time as code changes) here:
https://github.com/mozilla-mobile/focus-android/blob/master/docs/telemetry.md

We would need to update this patch before landing.

Comment 9

[Frank Bertsch [:frank]]

Moved to Glean.