services/healthreport/docs/index.rst@4ab42b5ab56c
services/healthreport/docs/index.rst
Wed, 31 Dec 2014 07:53:36 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:53:36 +0100
- branch
- TOR_BUG_3246
- changeset 5
- 4ab42b5ab56c
- permissions
- -rw-r--r--
Correct small whitespace inconsistency, lost while renaming variables.
1 .. _healthreport:
3 =====================
4 Firefox Health Report
5 =====================
7 ``/services/healthreport`` contains the implementation of the
8 ``Firefox Health Report`` (FHR).
10 Firefox Health Report is a background service that collects application
11 metrics and periodically submits them to a central server. The core
12 parts of the service are implemented in this directory. However, the
13 actual XPCOM service is implemented in the
14 :ref:`data_reporting_service`.
16 The core types can actually be instantiated multiple times and used to
17 power multiple data submission services within a single Gecko
18 application. In other words, everything in this directory is effectively
19 a reusable library. However, the terminology and some of the features
20 are very specific to what the Firefox Health Report feature requires.
22 .. toctree::
23 :maxdepth: 1
25 architecture
26 dataformat
27 identifiers
29 Legal and Privacy Concerns
30 ==========================
32 Because Firefox Health Report collects and submits data to remote
33 servers and is an opt-out feature, there are legal and privacy
34 concerns over what data may be collected and submitted. **Additions or
35 changes to submitted data should be signed off by responsible
36 parties.**
