Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-02-28 05:10:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1328657 - Added documentation for the crash ping processType field and quieted some warnings r=me

Browse Source
This commit is contained in:
Gabriele Svelto 2017-01-11 12:09:43 +01:00
parent e639e46d9a
commit 31100686b0
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
toolkit/components/telemetry/docs/data/crash-ping.rst
View File

@ -18,6 +18,7 @@ Structure:
... common ping data
clientId: <UUID>,
environment: { ... },
processType: <type>, // Type of process that crashed, see below for a list of types
payload: {
crashDate: "YYYY-MM-DD",
sessionId: <UUID>, // may be missing for crashes that happen early
@ -26,6 +27,7 @@ Structure:
crashId: <UUID>, // Optional, ID of the associated crash
stackTraces: { ... }, // Optional, see below
metadata: { // Annotations saved while Firefox was running. See nsExceptionHandler.cpp for more information
ProductID: "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}",
ProductName: "Firefox",
ReleaseChannel: <channel>,
Version: <version number>,
@ -55,6 +57,21 @@ Structure:
}
}
Process Types
-------------
The ``processType`` field contains the type of process that crashed. There are
currently multiple process types defined in ``nsICrashService`` but crash pings
are sent only for the ones below:
+---------------+---------------------------------------------------+
| Type | Description |
+===============+===================================================+
| main | Main process, also known as the browser process |
+---------------+---------------------------------------------------+
| content | Content process |
+---------------+---------------------------------------------------+
Stack Traces
------------
@ -113,7 +130,7 @@ crash address meaning depends on the type of crash. In a segmentation fault the
crash address will be the memory address whose access caused the fault; in a
crash triggered by an illegal instruction exception the address will be the
instruction pointer where the invalid instruction resides.
See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/c99d374dde62654a024840accfb357b2851daea0/src/processor/minidump_processor.cc#675>`_'s
See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/c99d374dde62654a024840accfb357b2851daea0/src/processor/minidump_processor.cc#675>`__'s
relevant code for further information.
Since it's not always possible to establish with certainty the address of the
@ -140,5 +157,5 @@ The trust levels are (from least trusted to most trusted):
+---------------+---------------------------------------------------+
The ``code_id`` field holds a unique ID used to distinguish between different
versions and builds of the same module. See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/24f5931c5e0120982c0cbf1896641e3ef2bdd52f/src/google_breakpad/processor/code_module.h#60>`_'s
versions and builds of the same module. See `breakpad <https://chromium.googlesource.com/breakpad/breakpad/+/24f5931c5e0120982c0cbf1896641e3ef2bdd52f/src/google_breakpad/processor/code_module.h#60>`__'s
description for further information. This field is populated only on Windows.