platform_system_core/bootstat
Mark Salyzyn 39cc3e7073 bootstat: allow kernel_panic,sysrq to propagate subreason
Allow for a daemon to write to last kmsg to propagate a detailed
subreason to kernel_panic,sysrq actions.  A minor refactor moves
common code into a helper function getSubreason for retrieval and
bit error correction operations.

A sysrq crash generally produces a kernel-provided message:
    SysRq : Trigger a crash
which is used to generate a canonical boot reason kernel_panic,sysrq.
A user daemon could write to /dev/kmsg just prior to the sysrq with
    SysRq : Trigger a crash : '<subreason>'
to change the canonical boot reason to kernel_panic,sysrq,<subreason>.

Administration added pending kBootReasonMap entries present in TRON.

Test: manual echo into /dev/kmsg and /proc/sysrq-trigger and check
Test: boot_reason_test.sh
Bug: 33808187
Bug: 63736262
Change-Id: Ibf5432737e5a3449ebe40a8c6cf2d3e912ed6bbc
2018-03-20 13:11:44 -07:00
..
.clang-format bootstat: Set up clang-format-2 for bootstat. 2017-05-24 10:19:25 -07:00
Android.bp Fix PDK build 2018-02-14 03:03:28 +00:00
AndroidTest.xml Add test config to bootstat_tests 2017-04-05 14:49:47 +00:00
OWNERS Add OWNERS. 2017-12-07 13:30:03 -08:00
README.md bootstat: Record the time since factory reset on init. 2016-02-24 11:01:03 -08:00
boot_event_record_store.cpp bootstat: clang-format rebase 2017-09-20 11:27:56 -07:00
boot_event_record_store.h bootstat: clang-format rebase 2017-09-20 11:27:56 -07:00
boot_event_record_store_test.cpp bootstat: clang-format rebase 2017-09-20 11:27:56 -07:00
boot_reason_test.sh bootstat: test error out only on first bad bootloader reason 2018-03-20 13:10:16 -07:00
bootstat-debug.rc bootstat: test: inject ro.boot.bootreason values 2017-10-11 13:48:33 -07:00
bootstat.cpp bootstat: allow kernel_panic,sysrq to propagate subreason 2018-03-20 13:11:44 -07:00
bootstat.rc bootstat: reduce overall boot time 2017-09-19 07:36:34 -07:00
testrunner.cpp bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00

README.md

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