gecko-dev/toolkit/components/telemetry/docs/crash-ping.rst
Benjamin Smedberg 702c087507 Bug 1187270 - Add Telemetry session ID to crash annotations, r=gfritzsche
MozReview-Commit-ID: GwVI0dfsT4H

--HG--
extra : rebase_source : 0ae9efbce919efcd0f20314bd89848da017b7e57
2016-03-14 09:31:19 -04:00

27 lines
1.2 KiB
ReStructuredText

"crash" ping
============
This ping is captured after the main Firefox process crashes, whether or not the crash report is submitted to crash-stats.mozilla.org. It includes non-identifying metadata about the crash.
The environment block that is sent with this ping varies: if Firefox was running long enough to record the environment block before the crash, then the environment at the time of the crash will be recorded and ``hasCrashEnvironment`` will be true. If Firefox crashed before the environment was recorded, ``hasCrashEnvironment`` will be false and the recorded environment will be the environment at time of submission.
The client ID is submitted with this ping.
Structure::
{
version: 1,
type: "crash",
... common ping data
clientId: <UUID>,
environment: { ... },
payload: {
crashDate: "YYYY-MM-DD",
sessionId: <UUID>, // may be missing for crashes that happen early
// in startup. Added in Firefox 48 with the
// intention of uplifting to Firefox 46
metadata: {...}, // Annotations saved while Firefox was running. See nsExceptionHandler.cpp for more information
hasCrashEnvironment: bool
}
}