services/healthreport/docs/index.rst

Tue, 06 Jan 2015 21:39:09 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Tue, 06 Jan 2015 21:39:09 +0100
branch
TOR_BUG_9701
changeset 8
97036ab72558
permissions
-rw-r--r--

Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.

michael@0 1 .. _healthreport:
michael@0 2
michael@0 3 =====================
michael@0 4 Firefox Health Report
michael@0 5 =====================
michael@0 6
michael@0 7 ``/services/healthreport`` contains the implementation of the
michael@0 8 ``Firefox Health Report`` (FHR).
michael@0 9
michael@0 10 Firefox Health Report is a background service that collects application
michael@0 11 metrics and periodically submits them to a central server. The core
michael@0 12 parts of the service are implemented in this directory. However, the
michael@0 13 actual XPCOM service is implemented in the
michael@0 14 :ref:`data_reporting_service`.
michael@0 15
michael@0 16 The core types can actually be instantiated multiple times and used to
michael@0 17 power multiple data submission services within a single Gecko
michael@0 18 application. In other words, everything in this directory is effectively
michael@0 19 a reusable library. However, the terminology and some of the features
michael@0 20 are very specific to what the Firefox Health Report feature requires.
michael@0 21
michael@0 22 .. toctree::
michael@0 23 :maxdepth: 1
michael@0 24
michael@0 25 architecture
michael@0 26 dataformat
michael@0 27 identifiers
michael@0 28
michael@0 29 Legal and Privacy Concerns
michael@0 30 ==========================
michael@0 31
michael@0 32 Because Firefox Health Report collects and submits data to remote
michael@0 33 servers and is an opt-out feature, there are legal and privacy
michael@0 34 concerns over what data may be collected and submitted. **Additions or
michael@0 35 changes to submitted data should be signed off by responsible
michael@0 36 parties.**

mercurial