platform_system_core/bootstat
David Tracy 691d805d30 bootstat: Adds additional reboot reason patterns
- Adding allowance for arbitrary ota subreason details, such as
  success or failure conditions
- Adding the new subreason "periodic", which is useful for POS devices
  which require e.g. daily reboots as part of security requirements
Test: Full Android build

Change-Id: Id0a6d38ed902e2b25fbb050980c763912c948f27
Signed-off-by: David Tracy <dtracy@squareup.com>
2023-03-24 09:04:07 -07:00
..
.clang-format
Android.bp Use libgtest_prod_headers. 2021-04-20 15:22:02 -07:00
boot_event_record_store.cpp
boot_event_record_store.h Remove libmetricslogger dependency from bootstats 2020-01-31 15:39:52 -08:00
boot_event_record_store_test.cpp
boot_reason_test.sh bootstat: remove unused FDE boot events 2022-09-26 19:50:09 +00:00
bootstat-debug.rc
bootstat.cpp bootstat: Adds additional reboot reason patterns 2023-03-24 09:04:07 -07:00
bootstat.rc bootstat.rc: remove trigger that logged post_decrypt_time_elapsed 2023-01-18 02:14:35 +00:00
OWNERS Remove salyzyn@ from OWNERS. 2021-01-25 18:40:15 +00:00
README.md
testrunner.cpp

bootstat

The bootstat command records boot events (e.g., firmware_loaded, boot_complete) and the relative time at which these events occurred. The command also aggregates boot event metrics locally and logs the metrics for analysis.

Usage: bootstat [options]
options include:
  -h, --help            Show this help
  -l, --log             Log all metrics to logstorage
  -p, --print           Dump the boot event records to the console
  -r, --record          Record the timestamp of a named boot event
  --record_boot_reason  Record the reason why the device booted
  --record_time_since_factory_reset Record the time since the device was reset

Relative time

The timestamp recorded by bootstat is the uptime of the system, i.e., the number of seconds since the system booted.

Recording boot events

To record the relative time of an event during the boot phase, call bootstat with the -r option and the name of the boot event.

$ bootstat -r boot_complete

The relative time at which the command runs is recorded along with the name of the boot event to be persisted.

Logging boot events

To log the persisted boot events, call bootstat with the -l option.

$ bootstat -l

bootstat logs all boot events recorded using the -r option to the EventLog using the Tron histogram. These logs may be uploaded by interested parties for aggregation and analysis of boot time across different devices and versions.

Printing boot events

To print the set of persisted boot events, call bootstat with the -p option.

$ bootstat -p
Boot events:
------------
boot_complete   71