diff --git a/README.md b/README.md index e908928..c50d006 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,55 @@ prototype for collecting these errors to aid in Firefox development. +## Data Collection +The study collects errors by listening to all messages that are being logged to +the [Browser console][] and filtering out non-error messages. Then, it filters +out errors with [categories that the Web console displays][categories], leaving +only errors from the Firefox UI itself. + +### Telemetry Ping Example +Once an hour, if any errors were captured, a [Telemetry][] ping is sent with +[environmental data][] and a payload that looks like this: + +```json +{ + "version": 3, + "study_name": "shield-study-js-errors", + "branch": "default", + "addon_version": "0.1.0", + "shield_version": "unset", + "type": "shield-study-addon", + "data": { + "attributes": { + "fingerprints": "[{\"fingerprint\":\"q35iauGpeCg8FIHj4ptetoBxjIdkuyQi2InIkNpd3AYLwSH7RS44By4CbrPVH0yA\",\"utcTimestampMs\":1512683455924}]", + "utcTimestampMs": "1512683575918" + } + }, + "testing": false +} +``` + +The study specific fields are: + +
data.attributes.fingerprints
data.attributes.utcTimestampMs