wine/gecko
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/wine-gecko.git synced 2024-09-13 09:24:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Bug 1137252 - Update the in-tree docs. r=gfritzsche

Browse Source
This commit is contained in:
Alessio Placitelli 2015-04-13 19:33:27 +02:00
parent 53efb896a5
commit d8c6e76d50
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
toolkit/components/telemetry/docs/pings.rst
View File

@ -33,3 +33,25 @@ Ping types
* ``activation`` - *planned* - sent right after installation or profile creation
* ``upgrade`` - *planned* - sent right after an upgrade
* ``deletion`` - *planned* - on opt-out we may have to tell the server to delete user data
Archiving
=========
When archiving is enabled through the relative preference, pings submitted to ``TelemetryPing`` are also stored locally in the user profile directory, in `<profile-dir>/datareporting/archived`.
To allow for cheaper lookup of archived pings, storage follows a specific naming scheme for both the directory and the ping file name: `<YYYY-MM>/<timestamp>.<UUID>.<type>.json`.
* ``<YYYY-MM>`` - The subdirectory name, generated from the ping creation date.
* ``<timestamp>`` - Timestamp of the ping creation date.
* ``<UUID>`` - The ping identifier.
* ``<type>`` - The ping type.
Preferences
===========
Telemetry behaviour is controlled through the following preferences:
* ``datareporting.healthreport.service.enabled`` - If true, records base Telemetry data. Otherwise, completely disables telemetry recording.
* ``toolkit.telemetry.enabled`` - If true, record the extended Telemetry data. Please note that base Telemetry data needs to be enabled as well and we need to be in an official build or in test mode. This preference is controlled through the `Preferences` dialog.
* ``datareporting.healthreport.uploadEnabled`` - Send the data we record if user has consented to FHR. This preference is controlled through the `Preferences` dialog.
* ``toolkit.telemetry.archive.enabled`` - Allow pings to be archived locally.