gecko-dev/services/healthreport
Ed Morley 7d5145ce2c Backout 9e11714fcba2 (bug 809094) for browser-chrome failures on a CLOSED TREE 2013-01-07 10:22:08 +00:00
..
modules-testing Bug 812608 - Part 2c: Further improvements to shutdown logic; r=rnewman 2013-01-06 16:24:50 -08:00
tests Bug 827187 - Part 2: Fix test bustage; r=rnewman 2013-01-06 21:32:18 -08:00
HealthReportComponents.manifest Bug 808126 - Crash report collection for Firefox Health Report; r=rnewman 2013-01-06 14:47:18 -08:00
HealthReportService.js Bug 812608 - Part 2: Refactor FHR on top of new Metrics APIs; r=rnewman 2013-01-06 12:13:27 -08:00
Makefile.in Bug 813287 - Move healthreport prefs into greprefs.js; r=rnewman 2013-01-06 16:15:51 -08:00
README.rst Bug 808219 - Firefox Health Reporter service; r=rnewman 2012-11-13 20:22:09 -08:00
healthreport-prefs.js Backout 9e11714fcba2 (bug 809094) for browser-chrome failures on a CLOSED TREE 2013-01-07 10:22:08 +00:00
healthreporter.jsm Bug 812608 - Part 2c: Further improvements to shutdown logic; r=rnewman 2013-01-06 16:24:50 -08:00
policy.jsm Bug 817076 - Update various services paths to point to the gre. r=gps 2012-12-05 16:36:27 -06:00
profile.jsm Bug 812608 - Part 3: further tweaks to profile age fetch. r=trivial 2013-01-06 14:07:34 -08:00
providers.jsm Bug 808126 - Part 3: Use OS.File.stat() to look for missing directory; r=rnewman 2013-01-07 00:17:19 -08:00

README.rst

=====================
Firefox Health Report
=====================

This directory contains the implementation of the Firefox Health Report
(FHR).

Firefox Health Report is a background service that collects application
metrics and periodically submits them to a central server.

Implementation Notes
====================

The XPCOM service powering FHR is defined in HealthReportService.js. It
simply instantiates an instance of HealthReporter from healthreporter.jsm.

All the logic for enforcing the privacy policy and for scheduling data
submissions lives in policy.jsm.

Preferences
===========

Preferences controlling behavior of Firefox Health Report live in the
*healthreport.* branch.

Some important preferences are:

* **healthreport.serviceEnabled** - Controls whether the entire health report
  service runs. The overall service performs data collection, storing, and
  submission.

* **healthreport.policy.dataSubmissionEnabled** - Controls whether data
  submission is enabled. If this is *false*, data will still be collected
  and stored - it just won't ever be submitted to a remote server.

If the entire service is disabled, you lose data collection. This means that
data analysis won't be available because there is no data to analyze!

Other Notes
===========

There are many legal and privacy concerns with this code, especially
around the data that is submitted. Changes to submitted data should be
signed off by responsible parties.