android-components/components/lib/crash/docs/metrics.md

5.3 KiB

Metrics

This document enumerates the metrics collected by this project using the Glean SDK. This project may depend on other projects which also collect metrics. This means you might have to go searching through the dependency tree to get a full picture of everything collected by this project.

Pings

crash

A ping to report crash information. This information is sent as soon as possible after a crash occurs (whether the crash is a background/content process or the main process). It is expected to be used for crash report analysis and to reduce blind spots in crash reporting.

This ping includes the client id.

Data reviews for this ping:

Bugs related to this ping:

Reasons this ping may be sent:

  • crash: A process crashed and a ping was immediately sent.

  • event_found: A process crashed and produced a crash event, which was later found and sent in a ping.

All Glean pings contain built-in metrics in the ping_info and client_info sections.

In addition to those built-in metrics, the following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
crash.cause string The cause of the crash. May be one of os_fault or java_exception. Bug 1839697 never 1
crash.process_type string The type of process that experienced a crash. See the full list of options here. Bug 1790569 never 1
crash.remote_type string Type of the child process, can be set to "web", "file" or "extension" but could also be unavailable. Bug 1851518 never 1
crash.startup boolean If true, the crash occurred during process startup. Bug 1790569 never 1
crash.time datetime The time at which the crash occurred. Bug 1790569 never 1
crash.uptime timespan The application uptime. This is equivalent to the legacy crash ping's UptimeTS field. Bug 1790569 never 1

metrics

This is a built-in ping that is assembled out of the box by the Glean SDK.

See the Glean SDK documentation for the metrics ping.

All Glean pings contain built-in metrics in the ping_info and client_info sections.

In addition to those built-in metrics, the following metrics are added to the ping:

Name Type Description Data reviews Extras Expiration Data Sensitivity
crash_metrics.crash_count labeled_counter Counts the number of crashes that occur in the application. This measures only the counts of each crash in association with the labeled type of the crash. The labels correspond to the types of crashes handled by lib-crash. Deprecated: native_code_crash, fatal_native_code_crash and nonfatal_native_code_crash replaced by main_proc_native_code_crash, fg_proc_native_code_crash and bg_proc_native_code_crash. Bug 1553935, mozilla-mobile/android-components#5700, mozilla-mobile/android-components#11908
  • uncaught_exception
  • caught_exception
  • main_proc_native_code_crash
  • fg_proc_native_code_crash
  • bg_proc_native_code_crash
  • fatal_native_code_crash
  • nonfatal_native_code_crash
never 1

Data categories are defined here.