diff options
Diffstat (limited to '')
| -rw-r--r-- | toolkit/components/crashes/docs/index.rst | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/toolkit/components/crashes/docs/index.rst b/toolkit/components/crashes/docs/index.rst new file mode 100644 index 0000000000..1a24f2649a --- /dev/null +++ b/toolkit/components/crashes/docs/index.rst @@ -0,0 +1,43 @@ +.. _crashes_crashmanager: + +============= +Crash Manager +============= + +The **Crash Manager** is a service and interface for managing crash +data within the Gecko application. + +From JavaScript, the service can be accessed via:: + + let crashManager = Services.crashmanager; + +That will give you an instance of ``CrashManager`` from ``CrashManager.sys.mjs``. +From there, you can access and manipulate crash data. + +The crash manager stores statistical information about crashes as well as +detailed information for both browser and content crashes. The crash manager +automatically detects new browser crashes at startup by scanning for +:ref:`Crash Events`. Content process crash information on the other hand is +provided externally. + +Crash Pings +=========== + +The Crash Manager is responsible for sending crash pings when a crash occurs +or when a crash event is found. Crash pings are sent using +`Telemetry pings <../../telemetry/data/crash-ping.html>`__. + +Glean +----- +Crash pings are being migrated to use `Glean pings <../../glean/index.html>`__, +however until information parity is reached, the Telemetry pings will still be +sent. The Glean `crash` ping can be found `here <https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/pings/crash>`__. + + +Other Documents +=============== + +.. toctree:: + :maxdepth: 1 + + crash-events |