Bug 1460433: Part 3 - Documentation for the launcher-process-failure ping; r=chutten
authorAaron Klotz <aklotz@mozilla.com>
Mon, 25 Feb 2019 18:07:41 +0000
changeset 460944 9105b6f8d62c90115989ec0b793f7525b36a2957
parent 460943 deda484b0623a4ab81833df97e01ddc6bafc967a
child 460945 8e4102596afd16d32bfef539acb909443d29d689
push id35613
push usernerli@mozilla.com
push dateTue, 26 Feb 2019 03:52:35 +0000
treeherdermozilla-central@faec87a80ed1 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerschutten
bugs1460433
milestone67.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1460433: Part 3 - Documentation for the launcher-process-failure ping; r=chutten Differential Revision: https://phabricator.services.mozilla.com/D20868
toolkit/components/telemetry/docs/data/launcher-process-failure.rst
new file mode 100644
--- /dev/null
+++ b/toolkit/components/telemetry/docs/data/launcher-process-failure.rst
@@ -0,0 +1,84 @@
+
+Launcher Process Failure ping
+=============================
+
+This ping is generated by the Firefox launcher process when it fails to successfully start the browser.
+
+Structure:
+
+.. code-block:: js
+
+    {
+      type: "launcher-process-failure",
+      "version": 1,
+      "id": <UUID>,
+      "creationDate": <Date string in ISO format>,
+      "update_channel": <string>,
+      "build_id": <string>,
+      "build_version": <string>,
+      // Windows version numnber in major.minor.build.UBR format (UBR is optional, only available on Win10)
+      "os_version": <string>,
+      // True if this build was running atop a Windows Server OS
+      "server_os": <bool>,
+      // The current user's OS locale setting
+      "os_locale": <string>,
+      // CPU Architecture. One of the values from the Windows SYSTEM_INFO::wProcessorArchitecture field
+      "cpu_arch": <int>,
+      "num_logical_cpus": <int>,
+      "memory": {
+        // Free space available in the page file, in bytes
+        "total_phys": <int>,
+        // Available physical memory on the machine, in bytes
+        "avail_phys": <int>,
+        // Free space available in the page file, in bytes
+        "avail_page_file": <int>,
+        // Available virtual memory on the machine, in bytes
+        "avail_virt": <int>
+      },
+      "xpcom_abi": <string>,
+      "launcher_error": {
+        // The leaf name of the source file where the error was raised
+        "source_file": <string>,
+        // The line number of the source file where the error was raised
+        "source_line": <int>,
+        // The HRESULT error code of the error that was raised
+        "hresult": <int>
+      },
+      "security": {
+        // A list of names of installed antivirus products
+        "av": [
+          <string>,
+          ...
+        ],
+        // A list of names of installed antispyware products
+        "antispyware": [
+          <string>,
+          ...
+        ],
+        // A list of names of installed firewall products
+        "firewall": [
+          <string>,
+          ...
+        ]
+      },
+      // A mapping of all modules present in the failing process, including
+      // their version numbers and an optional index into the signatures array
+      "modules": {
+        <moduleName>: [
+          <string>,
+          <int>
+        ],
+        ...
+      },
+      // A list of all signatures that were used to sign the binaries that are
+      // listed in modules.
+      "signatures": [
+        <string>,
+        ...
+      ]
+    }
+
+Version History
+~~~~~~~~~~~~~~~
+
+- Firefox 67: Initial release (`bug 1460433 <https://bugzilla.mozilla.org/show_bug.cgi?id=1460433>`_).