gecko-dev/services/healthreport
Ryan VanderMeulen 6fddf1a235 Bug 931642 - Backed out changeset f4449a06e97f (bug 917883) for causing frequent OSX crashes. 2013-12-03 18:45:17 -05:00
..
modules-testing Bug 864993 - Part 2: Properly implement app update collection; r=rnewman 2013-07-18 16:13:43 -07:00
tests Bug 931642 - Backed out changeset f4449a06e97f (bug 917883) for causing frequent OSX crashes. 2013-12-03 18:45:17 -05:00
HealthReport.jsm Bug 854018 - Record counts for FHR upload actions; r=rnewman 2013-05-01 09:41:55 -07:00
HealthReportComponents.manifest Bug 854018 - Record counts for FHR upload actions; r=rnewman 2013-05-01 09:41:55 -07:00
Makefile.in Bug 912293 - Remove now redundant boilerplate from Makefile.in. r=gps 2013-09-05 09:01:46 +09:00
README.rst Bug 842393 - Documentation for Firefox Health Report; r=rnewman 2013-02-18 16:11:50 -08:00
healthreport-prefs.js bug 867737 - update FHR reporting URL, r=gps 2013-05-05 10:04:38 -04:00
healthreporter.jsm Bug 931642 - Backed out changeset f4449a06e97f (bug 917883) for causing frequent OSX crashes. 2013-12-03 18:45:17 -05:00
moz.build Bug 870370 - Move EXTRA_COMPONENTS to mozbuild (file batch #3); r=mshal 2013-06-11 16:38:22 -04:00
profile.jsm Bug 451283 - Move log4moz.js to Toolkit as Log.jsm. r=gps,Mossop 2013-08-26 11:55:58 -07:00
providers.jsm Bug 925521 - Part 2: correctly record identifiers for non-pre-installed engines. r=gps 2013-10-18 12:31:39 -07: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
====================

healthreporter.jsm contains the main interface for FHR, the
*HealthReporter* type. An instance of this is created by the data
reporting service. See /services/datareporting/.

providers.jsm contains numerous Metrics.Provider and Metrics.Measurement
used for collecting application metrics. If you are looking for the FHR
probes, this is where they are.

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

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

Some important preferences are:

* **service.enabled** - Controls whether the entire health report
  service runs. The overall service performs data collection, storing, and
  submission. This is the primary kill switch for Firefox Health Report
  outside of the build system variable. i.e. if you are using an
  official Firefox build and wish to disable FHR, this is what you
  should change.

* **uploadEnabled** - Whether uploading of data is enabled. This
  is the preference the checkbox in the UI reflects. If this is
  disabled, FHR still collects data - it just doesn't upload it.

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!

Registering Providers
=====================

Firefox Health Report providers are registered via the category manager.
See HealthReportComponents.manifest for providers defined in this
directory.

Essentially, the category manager receives the name of a JS type and the
URI of a JSM to import that exports this symbol. At run-time, the
providers registered in the category manager are instantiated. This
allows for a loose coupling of providers which in turns makes managing
the code behind the providers much simpler.

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.