Closed Bug 1406394 Opened 7 years ago Closed 7 years ago

Update Telemetry documentation to the data preference changes

Categories

(Toolkit :: Telemetry, enhancement, P1)

Product:
Toolkit
Component:
Telemetry
Type:
enhancement

Tracking

()

Status:
RESOLVED FIXED
Milestone:
mozilla59
Tracking Flags:
Tracking Status
firefox58 --- wontfix
firefox59 --- fixed

People

(Reporter: gfritzsche, Assigned: chutten)

References

(Blocks 2 open bugs)

Details

Attachments

(2 files)

bug 1406394 - Small correctness/readability fixes in Telemetry docs
59 bytes, text/x-review-board-request
Dexter
: review+
Details
bug 1406394 - Update Telemetry docs for preference changes
59 bytes, text/x-review-board-request
Dexter
: review+
Details 
This is per the preferences changes plan in here:
https://docs.google.com/document/d/12U_s9zHvpt7iGEMF5DazSzzx3whGbCnVWEsZTyclta0/edit#

The semantics for data preferences changed and we also change some technical Firefox internals.
Our Telemetry docs need to be updated to reflect this.
Priority: P2 → P1
Priority: P1 → P2
Priority: P2 → P1
Depends on: 1412312
Assignee: nobody → chutten
Status: NEW → ASSIGNED
We probably need to do a first update pass through:
https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/
https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Adding_a_new_Telemetry_probe

We can move future improvement to a follow-up (i'll file).
Blocks: 1413969
Comment on attachment 8927442 [details]
bug 1406394 - Small correctness/readability fixes in Telemetry docs

https://reviewboard.mozilla.org/r/198774/#review204054

This looks good, thanks Chris!

::: toolkit/components/telemetry/docs/collection/histograms.rst:205
(Diff revision 1)
>  
>      **Every** new data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection#Requesting_Approval>`_ from a data collection peer. Just set the feedback? flag for one of the data peers.
>  
>  Changing a histogram
>  ====================
> -Changing histogram declarations after the histogram has been released is tricky. The current recommended procedure is to change the name of the histogram.
> +Changing histogram declarations after the histogram has been released is tricky. Many tools assume histograms don't change. The current recommended procedure is to change the name of the histogram.

nit: can you mention one of these tools as an example here in the docs?

::: toolkit/components/telemetry/docs/data/anonymous-ping.rst:3
(Diff revision 1)
>  
>  "anonymous" ping
>  ============

Since we're here, would you mind to fix the warnings that we get from toolkit/components/telemetry docs when running ./mach doc? For example, [here](https://dxr.mozilla.org/mozilla-central/rev/2535bad09d720e71a982f3f70dd6925f66ab8ec7/toolkit/components/telemetry/docs/data/anonymous-ping.rst#3) the title marker is too short compared to the length of the title and, as a result, a warning is produced. Feel free to skip this if you feel you don't have time/wouldn't fit in this patch.

::: toolkit/components/telemetry/docs/data/first-shutdown-ping.rst:3
(Diff revision 1)
>  
>  "first-shutdown" ping
>  ==================

nit: would you mind making the === part as long as the line above?

::: toolkit/components/telemetry/docs/data/modules-ping.rst:3
(Diff revision 1)
>  
>  "modules" ping
>  ============

nit: == here as well
Attachment #8927442 - Flags: review?(alessio.placitelli) → review+
Comment on attachment 8927443 [details]
bug 1406394 - Update Telemetry docs for preference changes

https://reviewboard.mozilla.org/r/198772/#review204068

::: toolkit/components/telemetry/docs/internals/preferences.rst:129
(Diff revision 1)
>  
>    Allow the ``shutdown`` ping to be sent using the :doc:`ping sender <pingsender>` from the first browsing session.
>  
>  ``toolkit.telemetry.firstShutdownPing.enabled``
>  
> -  Allow a duplicate of the shutdown ping from the first browsing session to be sent as a separate ``first-shutdown`` ping.
> +  Allow a duplicate of the ``main`` shutdown ping from the first browsing session to be sent as a separate ``first-shutdown`` ping. This only happens if ``unified`` is on.

nit: do we need to specify the "unified" part? All of these pings are sent just on desktop (unified = true), unless there's a bug (saved-session on Android)
Attachment #8927443 - Flags: review?(alessio.placitelli) → review+
Comment on attachment 8927443 [details]
bug 1406394 - Update Telemetry docs for preference changes

https://reviewboard.mozilla.org/r/198772/#review204068

> nit: do we need to specify the "unified" part? All of these pings are sent just on desktop (unified = true), unless there's a bug (saved-session on Android)

Sure, I have no problems with that.
Pushed by chutten@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/b3883358e018
Small correctness/readability fixes in Telemetry docs r=Dexter
https://hg.mozilla.org/integration/autoland/rev/a736899d6d31
Update Telemetry docs for preference changes r=Dexter
https://hg.mozilla.org/mozilla-central/rev/b3883358e018
https://hg.mozilla.org/mozilla-central/rev/a736899d6d31
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
status-firefox59: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla59
Won't fix for 58. Let it ride the train.
status-firefox58: affected → wontfix
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: