Closed Bug 1412312 Opened 4 years ago Closed 4 years ago

Document Telemetry mozconfig defines in the in-tree docs

Categories

(Toolkit :: Telemetry, enhancement, P1)

enhancement

Tracking

()

RESOLVED FIXED
mozilla58
Tracking Status
firefox58 --- fixed

People

(Reporter: chutten, Assigned: chutten)

References

Details

Attachments

(1 file)

Like preferences.rst (and possibly within preferences.rst, given their influences on each other) we may benefit from documenting the current mess of compiler defines that change Telemetry and data collection behaviour.
Blocks: 1406394
Assignee: nobody → chutten
Status: NEW → ASSIGNED
Priority: P2 → P1
Comment on attachment 8927059 [details]
bug 1412312 - Document mozconfig defines in in-tree docs

https://reviewboard.mozilla.org/r/198268/#review203684

::: toolkit/components/telemetry/docs/internals/preferences.rst:17
(Diff revision 1)
> +
> +  * If ``RELEASE_OR_BETA`` is not defined, defines ``MOZ_TELEMETRY_ON_BY_DEFAULT``
> +
> +  When Not Defined:
> +
> +  * If ``datareporting.healthreport.uploadEnabled`` is locked, we print a message in the Privacy settings that you cannot turn on data submission and disabled the checkbox so you don't try. Possibly used by Tor Browser.

The preferences UI change was introduced to match our submission behaviour: local/custom builds are not sending pings and won't be sending pings despite of the pref. That's why the checkbox is disabled. I'm not sure if you want to add this here. It was definitely not introduced because of Tor, but I'm not sure if it's useful for them.
Attachment #8927059 - Flags: review?(alessio.placitelli) → review+
Comment on attachment 8927059 [details]
bug 1412312 - Document mozconfig defines in in-tree docs

https://reviewboard.mozilla.org/r/198268/#review203684

> The preferences UI change was introduced to match our submission behaviour: local/custom builds are not sending pings and won't be sending pings despite of the pref. That's why the checkbox is disabled. I'm not sure if you want to add this here. It was definitely not introduced because of Tor, but I'm not sure if it's useful for them.

I'll just omit the editorial statement altogether and leave that as work for the reader :)
Pushed by chutten@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/3c135c119ef4
Document mozconfig defines in in-tree docs r=Dexter
https://hg.mozilla.org/mozilla-central/rev/3c135c119ef4
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla58
You need to log in before you can comment on or make changes to this bug.