summaryrefslogtreecommitdiffstats
path: root/toolkit/components/crashes/docs/index.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /toolkit/components/crashes/docs/index.rst
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'toolkit/components/crashes/docs/index.rst')
-rw-r--r--toolkit/components/crashes/docs/index.rst43
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