toolkit/crashreporter/CrashAnnotations.yaml

   1 # This lists all the available crash annotations.
   2 #
   3 # Mandatory fields for each entry are:
   4 # - description: A string describing the annotation
   5 # - type: the annotation type, currently `string`, `boolean`, `u32`, `u64` or
   6 #   `usize`. Note that `boolean` values are stringified to `1` for
   7 #   true and `0` for false.
   8 #
   9 # Additionally a field can have the following optional fields:
  10 # - altname: A string that will be used when writing out the annotation to the
  11 #   .extra file instead of the annotation name
  12 # - ping: A boolean that indicates whether the annotation is allowed for
  13 #   inclusion in the crash ping, if not specified this defaults to false
  14 # - skip_if: A string that will cause the annotation not to be included in the
  15 #   crash report if the contents match it.
  16
  17 AbortMessage:
  18   description: >
  19     Message passed to NS_DebugBreak().
  20   type: string
  21
  22 Accessibility:
  23   description: >
  24     Set to "Active" by the accessibility service when it is active.
  25   type: string
  26
  27 AccessibilityClient:
  28   description: >
  29     Accessibility client ID.
  30   type: string
  31
  32 AccessibilityInProcClient:
  33   description: >
  34     Hexadecimal mask of in-process accessibility consumers, see
  35     accessible/windows/msaa/Compatibility.h for the mappings.
  36   type: string
  37
  38 AdapterDeviceID:
  39   description: >
  40     Graphics adapter name.
  41   type: string
  42
  43 AdapterDriverVendor:
  44   description: >
  45     Graphics adapter driver vendor.
  46   type: string
  47
  48 AdapterDriverVersion:
  49   description: >
  50     Graphics adapter driver version.
  51   type: string
  52
  53 AdapterSubsysID:
  54   description: >
  55     Graphics adapter subsystem ID.
  56   type: string
  57
  58 AdapterVendorID:
  59   description: >
  60     Graphics adapter vendor name.
  61   type: string
  62
  63 additional_minidumps:
  64   description: >
  65     Comma separated list of additional minidumps for this crash, each element
  66     in the list represent the suffix used in the dump filename. E.g. the
  67     "browser" entry for crash fa909194-737b-4b93-b8da-da110ac785e0 implies the
  68     existence of the fa909194-737b-4b93-b8da-da110ac785e0-browser.dmp file.
  69   type: string
  70
  71 Addons:
  72   description: >
  73     List of currently enabled add-ons.
  74   type: string
  75   altname: Add-ons
  76
  77 Android_Board:
  78   description: >
  79     The name of the underlying board used by the Android device. e.g. "k68v1_64"
  80   type: string
  81
  82 Android_Brand:
  83   description: >
  84     The consumer-visible brand associated with this Android device. e.g. "vivo"
  85   type: string
  86
  87 Android_CPU_ABI:
  88   description: >
  89     The Android primary CPU ABI being used. e.g. "arm64-v8a"
  90   type: string
  91
  92 Android_CPU_ABI2:
  93   description: >
  94     The Android secondary CPU ABI being used. e.g. "armeabi-v7a"
  95   type: string
  96
  97 Android_Device:
  98   description: >
  99     Android device name. e.g. "1907"
 100   type: string
 101
 102 Android_Display:
 103   description: >
 104     End-user visible display name of the build id for the Android build.
 105     e.g. "SP1A.210812.003 release-keys"
 106   type: string
 107
 108 Android_Fingerprint:
 109   description: >
 110     A string that uniquely identifies the Android build. e.g.
 111     "vivo/1907/1907:12/SP1A.210812.003/compiler03091510:user/release-keys"
 112   type: string
 113
 114 Android_Hardware:
 115   description: >
 116     The name of the Android hardware from "/proc". e.g. "mt6768"
 117   type: string
 118
 119 Android_Manufacturer:
 120   description: >
 121     Android device manufacturer. e.g. "vivo"
 122   type: string
 123
 124 Android_Model:
 125   description: >
 126     End-user visible Android device model name. e.g. "vivo 1907"
 127   type: string
 128
 129 Android_PackageName:
 130   description: >
 131     The package name of an Android application that uniquely identifies the
 132     application on the device, Google Play Store, and third-party Android
 133     stores. e.g. "com.example.referencebrowser"
 134   type: string
 135
 136 Android_Version:
 137   description: >
 138     The developer preview revision of a prerelease SDK plus The current
 139     development codename, or the string "REL" if this is a release build.
 140     e.g. "31 (REL)"
 141   type: string
 142
 143 AppInitDLLs:
 144   description: >
 145     List of DLLs loaded when launching any application on Windows, this
 146     reflects the contents of the AppInit_DLLs registry key.
 147   type: string
 148
 149 ApplicationBuildID:
 150   description: >
 151     Product application's build ID.
 152   type: string
 153
 154 AsyncShutdownTimeout:
 155   description: >
 156     This annotation is present if a shutdown blocker was not released in time
 157     and the browser was crashed instead of waiting for shutdown to finish. The
 158     condition that caused the hang is contained in the annotation.
 159   type: string
 160   ping: true
 161
 162 AvailablePageFile:
 163   description: >
 164     Available commit-space in bytes.
 165     - Under Windows, computed from the PERFORMANCE_INFORMATION structure by substracting
 166       the CommitTotal field from the CommitLimit field.
 167     - Under Linux, computed from /proc/meminfo's CommitLimit - Committed_AS. Note that
 168       the kernel is not guaranteed to enforce that CommittedLimit >= Committed_AS. If
 169       Committed_AS > CommittedLimit, this value is set to 0.
 170     - Not available on other platforms.
 171   type: usize
 172   ping: true
 173
 174 AvailablePhysicalMemory:
 175   description: >
 176     Amount of free physical memory in bytes.
 177     - Under Windows, populated with the contents of the MEMORYSTATUSEX's structure
 178     ullAvailPhys field.
 179     - Under macOS, populated with vm_statistics64_data_t::free_count.
 180     - Under Linux, populated with /proc/meminfo's MemFree.
 181     - Not available on other platforms.
 182   type: usize
 183   ping: true
 184
 185 AvailableSwapMemory:
 186   description: >
 187     Amount of free swap space in bytes.
 188     - Under macOS, populated with the contents of
 189       sysctl "vm.swapusage" :: xsu_avail.
 190     - Under Linux, populated with /proc/meminfo's SwapFree.
 191     - Not available on other platforms.
 192   type: usize
 193   ping: true
 194
 195 AvailableVirtualMemory:
 196   description: >
 197     Amount of free virtual memory in bytes
 198     - Under Windows, populated with the contents of the MEMORYSTATUSEX's structure ullAvailVirtual field.
 199     - Under Linux, populated with /proc/meminfo's MemAvailable.
 200     - Not available on other platforms.
 201     - For macOS, see AvailableSwapMemory, AvailablePhysicalMemory and PurgeablePhysicalMemory.
 202   type: usize
 203   ping: true
 204
 205 BackgroundTaskMode:
 206   description: >
 207     True if the app was invoked in background task mode via `--backgroundtask ...`, false otherwise.
 208   type: boolean
 209
 210 BackgroundTaskName:
 211   description: >
 212     If the app was invoked in background task mode via `--backgroundtask <task name>`, the string "task name".
 213   type: string
 214   ping: true
 215
 216 BlockedDllList:
 217   description: >
 218     Comma-separated list of blocked DLLS, Windows-only
 219   type: string
 220   ping: true
 221
 222 BlocklistInitFailed:
 223   description: >
 224     Set to 1 if the DLL blocklist could not be initialized.
 225   type: boolean
 226   ping: true
 227   skip_if: "0"
 228
 229 Breadcrumbs:
 230   description: >
 231     Trail of events that occurred before a report. this will consist of multiple breadcrumbs with
 232     timestamp, message, category, level, type and data in JSON format.
 233   type: string
 234
 235 BuildID:
 236   description: >
 237     Application build ID, the format is YYYYMMDDHHMMSS.
 238   type: string
 239   ping: true
 240
 241 ContentSandboxCapabilities:
 242   description: >
 243     List of capabilities of the content process sandbox.
 244   type: u32
 245
 246 ContentSandboxEnabled:
 247   description: >
 248     Set to 1 when content process sandboxing is enabled.
 249   type: boolean
 250
 251 ContentSandboxCapable:
 252   description: >
 253     Set to 1 if the client is capable of content sandboxing.
 254   type: boolean
 255
 256 ContentSandboxLevel:
 257   description: >
 258     Content sandbox level.
 259   type: u32
 260
 261 ContentSandboxWin32kState:
 262   description: >
 263     Content sandbox Win32k state
 264   type: string
 265
 266 GpuSandboxLevel:
 267   description: >
 268     GPU sandbox level.
 269   type: u32
 270
 271 CPUMicrocodeVersion:
 272   description: >
 273     Version of the CPU microcode.
 274   type: string
 275
 276 CrashTime:
 277   description: >
 278     Crash time in seconds since the Epoch.
 279   type: string
 280   ping: true
 281
 282 CycleCollector:
 283   description: >
 284     Reason why the cycle collector crashed.
 285   type: string
 286
 287 DesktopEnvironment:
 288   description: >
 289     Desktop environment used on Linux, e.g. GNOME, KDE, XFCE, etc.
 290   type: string
 291
 292 DeviceResetReason:
 293   description: >
 294     Reason why a DirectX device has been reset, Windows only.
 295   type: u32
 296
 297 DOMFissionEnabled:
 298   description: >
 299     Set to 1 when DOM fission is enabled, and subframes are potentially loaded
 300     in a separate process.
 301   type: boolean
 302   ping: true
 303
 304 DOMIPCEnabled:
 305   description: >
 306     Set to 1 when a tab is running in a content process
 307   type: boolean
 308
 309 DumperError:
 310   description: >
 311     Error message of the minidump writer, in case there was an error during dumping.
 312   type: string
 313
 314 EMCheckCompatibility:
 315   description: >
 316     Set to true if add-on compatibility checking is enabled. Technically this
 317     annotation should be a boolean, but historically it's been set by JavaScript
 318     code as a string, so keep it as such for the time being.
 319   type: string
 320
 321 EventLoopNestingLevel:
 322   description: >
 323     Present only if higher than 0, indicates that we're running in a nested
 324     event loop and indicates the nesting level.
 325   type: u32
 326   ping: true
 327   skip_if: "0"
 328
 329 ExperimentalFeatures:
 330   description: >
 331     Comma-separated list of enabled experimental features from about:preferences#experimental.
 332   type: string
 333   ping: true
 334
 335 FontName:
 336   description: >
 337     Set before attempting to load a font to help diagnose crashes during loading.
 338   type: string
 339   ping: true
 340
 341 GMPLibraryPath:
 342   description: >
 343     Holds the path to the GMP plugin library.
 344   type: string
 345
 346 GMPPlugin:
 347   description: >
 348     Set to 1 if the GMP plugin is enabled.
 349   type: boolean
 350
 351 GPUProcessLaunchCount:
 352   description: >
 353     Number of times the GPU process was launched.
 354   type: u32
 355   ping: true
 356
 357 GPUProcessStatus:
 358   description: >
 359     Status of the GPU process, can be set to "Running" or "Destroyed"
 360   type: string
 361
 362 GraphicsCompileShader:
 363   description: >
 364     Name of the shader we are in the process of compiling, if applicable. See
 365     file names in gfx/wr/webrender/res/* for the possible values.
 366   type: string
 367
 368 GraphicsCriticalError:
 369   description: >
 370     Information of a critical error that occurred within the graphics code.
 371   type: string
 372
 373 GraphicsDrawShader:
 374   description: >
 375     Name of the shader that is currently bound for a draw call, if applicable.
 376     See file names in gfx/wr/webrender/res/* for the possible values.
 377   type: string
 378
 379 GraphicsNumActiveRenderers:
 380   description: >
 381     Number of webrender renderer instances that are not in a paused state.
 382   type: usize
 383
 384 GraphicsNumRenderers:
 385   description: >
 386     Total number of webrender renderer instances.
 387   type: usize
 388
 389 GraphicsStartupTest:
 390   description: >
 391     Set to 1 by the graphics driver crash guard when it's activated.
 392   type: boolean
 393
 394 HeadlessMode:
 395   description: >
 396     True if the app was invoked in headless mode via `--headless ...` or `--backgroundtask ...`, false otherwise.
 397   type: boolean
 398   ping: true
 399
 400 PHCKind:
 401   description: >
 402     The allocation kind, if the crash involved a bad access of a special PHC
 403     allocation.
 404   type: string
 405
 406 PHCBaseAddress:
 407   description: >
 408     The allocation's base address, if the crash involved a bad access of a
 409     special PHC allocation. Encoded as a decimal address.
 410   type: string
 411
 412 PHCUsableSize:
 413   description: >
 414     The allocation's usable size, if the crash involved a bad access of a
 415     special PHC allocation.
 416   # A 32-bit integer is enough because the maximum usable size of a special PHC
 417   # allocation is far less than 2 GiB.
 418   type: u32
 419
 420 PHCAllocStack:
 421   description: >
 422     The allocation's allocation stack trace, if the crash involved a bad access
 423     of a special PHC allocation. Encoded as a comma-separated list of decimal
 424     addresses.
 425   type: string
 426
 427 PHCFreeStack:
 428   description: >
 429     The allocation's free stack trace, if the crash involved a bad access
 430     of a special PHC allocation. Encoded as a comma-separated list of decimal
 431     addresses.
 432   type: string
 433
 434 HasDeviceTouchScreen:
 435   description: >
 436     Set to 1 if the device had a touch-screen, this only applies to Firefox
 437     desktop as on mobile devices we assume a touch-screen is always present.
 438   type: boolean
 439
 440 InstallTime:
 441   description: >
 442     The time when Firefox was installed expressed as seconds since the Epoch
 443   type: string # This should be u64 but we currently handle it as a string
 444
 445 ipc_channel_error:
 446   description: >
 447     Set before a content process crashes because of an IPC channel error, holds
 448     a description of the error.
 449   type: string
 450   ping: true
 451
 452 IpcCreatePipeCloExecErrno:
 453   description: >
 454     errno value retrieved after failing to set the O_CLOEXEC flag on a pipe
 455     used for IPC.
 456   type: u32
 457
 458 IpcCreatePipeFcntlErrno:
 459   description: >
 460     errno value retrieved after a call to fcntl() on a pipe used for IPC failed.
 461   type: u32
 462
 463 IpcCreatePipeSocketPairErrno:
 464   description: >
 465     errno value retrieved after a socketpair() call failed while creating an IPC
 466     transport object.
 467   type: u32
 468
 469 IPCFatalErrorMsg:
 470   description: >
 471     Describes a fatal error that occurred during IPC operation.
 472   type: string
 473
 474 IPCFatalErrorProtocol:
 475   description: >
 476     Name of the protocol used by IPC when a fatal error occurred.
 477   type: string
 478
 479 IPCMessageName:
 480   description: >
 481     Name of the IPC message that caused a crash because it was too large.
 482   type: string
 483
 484 IPCMessageSize:
 485   description: >
 486     Size of the IPC message that caused a crash because it was too large.
 487   type: u32
 488
 489 IPCReadErrorReason:
 490   description: >
 491     Reason why reading an object via IPC failed.
 492   type: string
 493
 494 IPCShutdownState:
 495   description: >
 496     IPC shutdown state, can be set to either "RecvShutdown" or
 497     "SendFinishShutdown" by a content process while it's shutting down.
 498   type: string
 499
 500 IPCSystemError:
 501   description: >
 502     Description of the last system error that occurred during IPC operation.
 503   type: u32
 504
 505 Hang:
 506   description: >
 507     Set if the crash was the result of a hang, with a value which describes the
 508     type of hang (e.g. "ui" or "shutdown").
 509   type: string
 510   ping: true
 511
 512 IsGarbageCollecting:
 513   description: >
 514     If true then the JavaScript garbage collector was running when the crash
 515     occurred.
 516   type: boolean
 517   ping: true
 518   skip_if: "0"
 519
 520 IsWayland:
 521   description: >
 522     If true then the Wayland windowing system was in use.
 523   type: boolean
 524
 525 IsWebRenderResourcePathOverridden:
 526   description: >
 527     If true then the WebRender resources (i.e. shaders) are loaded from a user specified path.
 528   type: boolean
 529
 530 JavaException:
 531   description: >
 532     JSON structured Java stack trace, only present on Firefox for Android if we encounter an
 533     uncaught Java exception.
 534   type: string
 535
 536 JavaStackTrace:
 537   description: >
 538     Java stack trace, only present on Firefox for Android if we encounter an
 539     uncaught Java exception.
 540   type: string
 541
 542 JSActorMessage:
 543   description: >
 544     If an actor is currently treating a message, this is the name of the message.
 545     Otherwise, empty.
 546   type: string
 547
 548 JSActorName:
 549   description: >
 550     If an actor is currently treating a message, this is the name of the actor.
 551     Otherwise, empty.
 552   type: string
 553
 554 JSLargeAllocationFailure:
 555   description: >
 556     A large allocation couldn't be satisfied, check the JSOutOfMemory
 557     description for the possible values of this annotation.
 558   type: string
 559
 560 JSModuleLoadError:
 561   description: >
 562     The error raised when attempting to import a critical JS module from C++
 563   type: string
 564
 565 JSOutOfMemory:
 566   description: >
 567     A small allocation couldn't be satisfied, the annotation may contain the
 568     "Reporting", "Reported" or "Recovered" value. The first one means that
 569     we crashed while responding to the OOM condition (possibly while running a
 570     memory-pressure observers), the second that we crashed after having tried to
 571     free some memory, and the last that the GC had managed to free enough memory
 572     to satisfy the allocation.
 573   type: string
 574
 575
 576 LastInteractionDuration:
 577   description: >
 578     How long the user had been inactive in seconds if the user was inactive
 579     at crash.  The value is not set if the user state was active.
 580   type: u64
 581   ping: true
 582
 583 LastStartupWasCrash:
 584   description: >
 585     True if the last startup was detected to have been a crash.
 586   type: boolean
 587
 588 MacMemoryPressure:
 589   description: >
 590     The current memory pressure state as provided by the macOS memory pressure
 591     dispatch source. The annotation value is one of "Normal" for no memory
 592     pressure, "Unset" indicating a memory pressure event has not been received,
 593     "Warning" or "Critical" mapping to the system memory pressure levels,
 594     or "Unexpected" for an unexpected level. This is a Mac-specific annotation.
 595   type: string
 596
 597 MacMemoryPressureNormalTime:
 598   description: >
 599     The time when the memory pressure state last transitioned to 'Normal'
 600     expressed as seconds since the Epoch.
 601   type: string
 602
 603 MacMemoryPressureWarningTime:
 604   description: >
 605     The time when the memory pressure state last transitioned to 'Warning'
 606     expressed as seconds since the Epoch.
 607   type: string
 608
 609 MacMemoryPressureCriticalTime:
 610   description: >
 611     The time when the memory pressure state last transitioned to 'Critical'
 612     expressed as seconds since the Epoch.
 613   type: string
 614
 615 MacMemoryPressureSysctl:
 616   description: >
 617     The value of the memory pressure sysctl
 618     'kern.memorystatus_vm_pressure_level'. Indicates which memory
 619     pressure level the system is in at the time of the crash. The expected
 620     values are one of 4 (Critical), 2 (Warning), or 1 (Normal).
 621   type: u32
 622
 623 MacAvailableMemorySysctl:
 624   description: >
 625     The value of the available memory sysctl 'kern.memorystatus_level'.
 626     Expected to be a percentage integer value.
 627   type: u32
 628
 629 LinuxUnderMemoryPressure:
 630   description: >
 631     Set to true if the memory pressure watcher was under memory pressure when
 632     the crash occurred.
 633   type: boolean
 634
 635 LauncherProcessState:
 636   description: >
 637     Launcher process enabled state. The integer value of this annotation must
 638     match with one of the values in the
 639     mozilla::LauncherRegistryInfo::EnableState enum
 640   type: u32
 641
 642 LowPhysicalMemoryEvents:
 643   description: >
 644     Number of times the available memory tracker has detected that free
 645     physical memory is running low. This is a Windows-specific annotation.
 646   type: u32
 647   ping: true
 648   skip_if: "0"
 649
 650 MainThreadRunnableName:
 651   description: >
 652     Name of the currently executing nsIRunnable on the main thread.
 653   type: string
 654   ping: true
 655
 656 MozCrashReason:
 657   description: >
 658     Plaintext description of why Firefox crashed, this is usually set by
 659     assertions and the like.
 660   type: string
 661   ping: true
 662
 663 Notes:
 664   description: >
 665     Miscellaneous notes that can be appended to a crash.
 666   type: string
 667
 668 OOMAllocationSize:
 669   description: >
 670     Size of the allocation that caused an out-of-memory condition.
 671   type: usize
 672   ping: true
 673   skip_if: "0"
 674
 675 PluginFilename:
 676   description: >
 677     Plugin filename, only the process holding the plugin has this annotation.
 678   type: string
 679
 680 PluginName:
 681   description: >
 682     Display name of a plugin, only the process holding the plugin has this
 683     annotation.
 684   type: string
 685
 686 PluginVersion:
 687   description: >
 688     Version of a plugin, only the process holding the plugin has this
 689     annotation.
 690   type: string
 691
 692 ProcessType:
 693   description: >
 694     Type of the process that crashed, the possible values are defined in
 695     GeckoProcessTypes.h.
 696   type: string
 697
 698 ProductName:
 699   description: >
 700     Application name (e.g. Firefox).
 701   type: string
 702   ping: true
 703
 704 ProductID:
 705   description: >
 706     Application UUID (e.g. ec8030f7-c20a-464f-9b0e-13a3a9e97384).
 707   type: string
 708   ping: true
 709
 710 ProfilerChildShutdownPhase:
 711   description: >
 712     When a child process shuts down, this describes if the profiler is running,
 713     and the point the profiler shutdown sequence has reached.
 714   type: string
 715   ping: true
 716
 717 PurgeablePhysicalMemory:
 718   description: >
 719     macOS only. Amount of physical memory currently allocated but which may
 720     be deallocated by the system in case of memory pressure. Populated from
 721     vm_statistics64_data_t::purgeable_count * vm_page_size.
 722   type: usize
 723   ping: true
 724
 725 QuotaManagerShutdownTimeout:
 726   description: >
 727     This annotation is present if the quota manager shutdown (resp. the shutdown
 728     of the quota manager clients) was not finished in time and the browser was
 729     crashed instead of waiting for the shutdown to finish. The status of objects
 730     which were blocking completion of the shutdown when reaching the timeout
 731     is contained in the annotation.
 732
 733     In the case of IndexedDB, objects are divided into three groups:
 734     FactoryOperations, LiveDatabases and DatabaseMaintenances.
 735
 736     In the case of LocalStorage, objects are divided into three groups:
 737     PrepareDatastoreOperations, Datastores and LiveDatabases.
 738
 739     In the case of Cache API, objects are in one group only:
 740     Managers.
 741
 742     Each group is reported separately and contains the number of objects in the
 743     group and the status of individual objects in the group (duplicate entries
 744     are removed):
 745     "GroupName: N (objectStatus1, objectStatus2, ...)" where N is the number of
 746     objects in the group.
 747
 748     The status of individual objects is constructed by taking selected object
 749     properties. Properties which contain origin strings are anonymized.
 750
 751     In addition, intermediate steps are recorded for change events after shutdown
 752     started. These include the time difference and the type of object.
 753   type: string
 754   ping: true
 755
 756 QuotaManagerStorageIsNetworkResource:
 757   description: >
 758     On Windows, this indicates if QM's base dir lives on a network resource.
 759     It is the direct result of the Win32 API function PathIsNetworkPath.
 760   type: boolean
 761
 762 RDDProcessStatus:
 763   description: >
 764     Status of the RDD process, can be set to "Running" or "Destroyed"
 765   type: string
 766
 767 ReleaseChannel:
 768   description: >
 769     Application release channel (e.g. default, beta, ...)
 770   type: string
 771   ping: true
 772
 773 RemoteType:
 774   description: >
 775     Type of the content process, can be set to "web", "file" or "extension".
 776   type: string
 777   ping: true
 778
 779 SafeMode:
 780   description: >
 781     Set to 1 if the browser was started in safe mode.
 782   type: boolean
 783
 784 SecondsSinceLastCrash:
 785   description: >
 786     Time in seconds since the last crash occurred.
 787   type: u64
 788   ping: true
 789
 790 ServerURL:
 791   description: >
 792     URL used to post the crash report.
 793   type: string
 794
 795 ShutdownProgress:
 796   description: >
 797     Shutdown step at which the browser crashed, can be set to "quit-application",
 798     "profile-change-teardown", "profile-before-change", "xpcom-will-shutdown" or
 799     "xpcom-shutdown".
 800   type: string
 801   ping: true
 802
 803 ShutdownReason:
 804   description: >
 805     One out of "Unknown", "AppClose", "AppRestart", "OSForceClose",
 806     "OSSessionEnd", "OSShutdown" or "WinUnexpectedMozQuit".
 807   type: string
 808   ping: true
 809
 810 StartupCacheValid:
 811   description: >
 812     True if the startup cache was deemed valid and usable. Will be false if the
 813     last session used a different browser version or had a startup cache.
 814   type: boolean
 815
 816 StartupCrash:
 817   description: >
 818     If set to 1 then this crash occurred during startup.
 819   type: boolean
 820   ping: true
 821
 822 StartupTime:
 823   description: >
 824     The time when Firefox was launched expressed in seconds since the Epoch.
 825   type: u64
 826
 827 StorageConnectionNotClosed:
 828   description: >
 829     This annotation is added when a mozStorage connection has not been properly
 830     closed during shutdown. The annotation holds the filename of the database
 831     associated with the connection.
 832   type: string
 833
 834 SubmittedFrom:
 835   description: >
 836     This annotation can hold one of the following five values depending on how
 837     this crash was submitted by the user:
 838     * Auto: the user had opted-in to auto-submission
 839     * Infobar: the user clicked on the infobar to submit the crash
 840     * AboutCrashes: the user sent the crash from the about:crashes page
 841     * CrashedTab: the user sent the crash from a crashed tab page
 842     * Client: the user sent the crash using the crash reporter client
 843   type: string
 844
 845 SystemMemoryUsePercentage:
 846   description: >
 847     Windows-only, percentage of physical memory in use. This annotation is
 848     populated with the contents of the MEMORYSTATUSEX's structure dwMemoryLoad
 849     field.
 850   type: u32
 851   ping: true
 852
 853 TelemetryClientId:
 854   description: >
 855     Telemetry client ID.
 856   type: string
 857
 858 TelemetryEnvironment:
 859   description: >
 860     The telemetry environment in JSON format.
 861   type: string
 862
 863 TelemetryServerURL:
 864   description: >
 865     Telemetry server URL. Used to send main process crash pings directly from
 866     the crashreporter client.
 867   type: string
 868
 869 TelemetrySessionId:
 870   description: >
 871     Telemetry session ID.
 872   type: string
 873
 874 TestKey:
 875   description: >
 876     Annotation used in tests.
 877   type: string
 878
 879 TestUnicode:
 880   description: >
 881     Annotation used in tests.
 882   type: string
 883
 884 TextureUsage:
 885   description: >
 886     Amount of memory in bytes consumed by textures.
 887   type: usize
 888   ping: true
 889   skip_if: "0"
 890
 891 Throttleable:
 892   description: >
 893     Whether Socorro can selectively discard this crash report or not. If set
 894     to "0" the crash report will always be processed by Socorro. Do not set
 895     this annotation within Gecko code, it's only supposed to be used by the
 896     crash reporting machinery.
 897   type: boolean
 898
 899 TotalPageFile:
 900   description: >
 901     Maximum amount of memory that can be committed without extending the swap/page file.
 902     - Under Windows, populated with the contents of the PERFORMANCE_INFORMATION's
 903       structure CommitLimit field.
 904     - Under Linux, populated with /proc/meminfo MemTotal + SwapTotal. The swap file
 905       typically cannot be extended, so that's a hard limit.
 906     - Not available on other systems.
 907   type: usize
 908   ping: true
 909
 910 TotalPhysicalMemory:
 911   description: >
 912     Amount of physical memory in bytes.
 913     - Under Windows, populated with the contents of the MEMORYSTATUSEX's structure
 914     ullTotalPhys field.
 915     - Under macOS, populated with sysctl "hw.memsize".
 916     - Under Linux, populated with /proc/meminfo's "MemTotal".
 917     - Not available on other systems.
 918   type: usize
 919   ping: true
 920
 921 TotalVirtualMemory:
 922   description: >
 923     Size of the virtual address space.
 924     - Under Windows, populated with the contents of the MEMORYSTATUSEX's structure
 925       ullTotalVirtual field.
 926     - Not available on other platforms.
 927   type: usize
 928   ping: true
 929
 930 UnknownNetAddrSocketFamily:
 931   description: >
 932     An unknown network address family was requested to Necko. The value is the
 933     requested family number.
 934   type: u32
 935
 936 UptimeTS:
 937   description: >
 938     Uptime in seconds. This annotation uses a string instead of an integer
 939     because it has a fractional component.
 940   type: string # This is a floating-point number but we treat it as a string
 941   ping: true
 942
 943 URL:
 944   description: >
 945     URL being loaded.
 946   type: string
 947
 948 URLSegments:
 949   description: >
 950     The offsets of the nsStandardURL segments that fail a sanity check
 951   type: string
 952
 953 User32BeforeBlocklist:
 954   description: >
 955     Set to 1 if user32.dll was loaded before we could install the DLL blocklist.
 956   type: boolean
 957   ping: true
 958   skip_if: "0"
 959
 960 useragent_locale:
 961   description: >
 962     User-agent locale.
 963   type: string
 964
 965 UtilityProcessStatus:
 966   description: >
 967     Status of the Utility process, can be set to "Running" or "Destroyed"
 968   type: string
 969
 970 UtilityActorsName:
 971   description: >
 972     Comma-separated list of IPC actors name running on this Utility process instance
 973   type: string
 974   ping: true
 975
 976 Vendor:
 977   description: >
 978     Application vendor (e.g. Mozilla).
 979   type: string
 980
 981 Version:
 982   description: >
 983     Product version.
 984   type: string
 985
 986 VRProcessStatus:
 987   description: >
 988     Status of the VR process, can be set to "Running" or "Destroyed"
 989   type: string
 990
 991 WasmLibrarySandboxMallocFailed:
 992   description: >
 993     Set to 1 if a rlbox wasm library sandbox ran out of memory, causing a
 994     malloc inside the sandbox to fail.
 995   type: boolean
 996
 997 WindowsFileDialogErrorCode:
 998   description: >
 999     The HRESULT returned from a Win32 system call leading to termination of the
1000     file-dialog utility process. MozCrashReason is expected to provide context
1001     for the value.
1002   type: u32 # This is an HRESULT which is defined as signed, but we don't want to print it as a signed integer
1003   ping: true
1004
1005 WindowsPackageFamilyName:
1006   description: >
1007     If running in a Windows package context, the package family name, per
1008     https://docs.microsoft.com/en-us/windows/win32/api/appmodel/nf-appmodel-getcurrentpackagefamilyname.
1009
1010     The package family name is only included when it is likely to have been produced by Mozilla: it
1011     starts "Mozilla." or "MozillaCorporation.".
1012   type: string
1013   ping: true
1014
1015 WindowsErrorReporting:
1016   description: >
1017     Set to 1 if this crash was intercepted via the Windows Error Reporting
1018     runtime exception module.
1019   type: boolean
1020   ping: true
1021
1022 Winsock_LSP:
1023   description: >
1024     Information on winsock LSPs injected in our networking stack.
1025   type: string
1026
1027 XPCOMSpinEventLoopStack:
1028   description: >
1029     If we crash while some code is spinning manually the event loop on the
1030     main thread, we will see the stack of nested annotations here.
1031     If the crashing process was killed (e.g. due to an IPC error), this
1032     annotation may refer to the parent process that killed it, look out for
1033     the prefix ("default" means parent) and see bug 1741131 for details.
1034   type: string