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