michael@0: .. _healthreport:
michael@0: 
michael@0: =====================
michael@0: Firefox Health Report
michael@0: =====================
michael@0: 
michael@0: ``/services/healthreport`` contains the implementation of the
michael@0: ``Firefox Health Report`` (FHR).
michael@0: 
michael@0: Firefox Health Report is a background service that collects application
michael@0: metrics and periodically submits them to a central server. The core
michael@0: parts of the service are implemented in this directory. However, the
michael@0: actual XPCOM service is implemented in the
michael@0: :ref:`data_reporting_service`.
michael@0: 
michael@0: The core types can actually be instantiated multiple times and used to
michael@0: power multiple data submission services within a single Gecko
michael@0: application. In other words, everything in this directory is effectively
michael@0: a reusable library. However, the terminology and some of the features
michael@0: are very specific to what the Firefox Health Report feature requires.
michael@0: 
michael@0: .. toctree::
michael@0:    :maxdepth: 1
michael@0: 
michael@0:    architecture
michael@0:    dataformat
michael@0:    identifiers
michael@0: 
michael@0: Legal and Privacy Concerns
michael@0: ==========================
michael@0: 
michael@0: Because Firefox Health Report collects and submits data to remote
michael@0: servers and is an opt-out feature, there are legal and privacy
michael@0: concerns over what data may be collected and submitted. **Additions or
michael@0: changes to submitted data should be signed off by responsible
michael@0: parties.**