platform_system_core/bootstat
Yongqin Liu 78b2b94d1d bootstat.cpp: update help message for --record_boot_complete
add description about --record_boot_complete in the help

Test: manually with HiKey

Change-Id: I521d6f5b9d98113c006fc6ab146b6c353ce2390c
Signed-off-by: Yongqin Liu <yongqin.liu@linaro.org>
2017-07-07 15:27:10 +00:00
..
.clang-format bootstat: Set up clang-format-2 for bootstat. 2017-05-24 10:19:25 -07:00
Android.bp Add test config to bootstat_tests 2017-04-05 14:49:47 +00:00
AndroidTest.xml Add test config to bootstat_tests 2017-04-05 14:49:47 +00: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: Refactor init/utils/boot_clock into base/chrono_utils. 2017-03-30 14:24:12 -07:00
boot_event_record_store.h Revert "Revert "bootstat: Handle v1 record files which do not contain file contents."" 2016-03-25 14:26:13 -07:00
boot_event_record_store_test.cpp bootstat: Refactor init/utils/boot_clock into base/chrono_utils. 2017-03-30 14:24:12 -07:00
bootstat.cpp bootstat.cpp: update help message for --record_boot_complete 2017-07-07 15:27:10 +00:00
bootstat.rc bootstat.rc: record post_decrypt_time_elapsed only for FDE device 2017-02-09 10:09:22 -08: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