1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/services/docs/datareporting.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,28 @@
1.4 +.. _data_reporting_service:
1.5 +
1.6 +======================
1.7 +Data Reporting Service
1.8 +======================
1.9 +
1.10 +``/services/datareporting`` contains files related to an XPCOM service
1.11 +that collects and reports data within Gecko applications.
1.12 +
1.13 +The important files in this directory are:
1.14 +
1.15 +DataReportingService.js
1.16 + An XPCOM service that coordinates collection and reporting of data.
1.17 +
1.18 +policy.jsm
1.19 + A module containing the logic for coordinating and driving collection
1.20 + and upload of data.
1.21 +
1.22 +sessions.jsm
1.23 + Records Gecko application session history. This is loaded as part of
1.24 + the XPCOM service because it needs to capture state from very early in
1.25 + the application lifecycle. Bug 841561 tracks implementing this in C++.
1.26 +
1.27 +There is other code in the tree that collects and uploads data. The
1.28 +original intent of this directory and XPCOM service was to serve as a
1.29 +focal point for the coordination of all this activity so that it could
1.30 +all be done consistently and properly. This vision may or may not be fully
1.31 +realized.
