platform_system_core/bootstat
James Hawkins 6d0d12a9d8 bootstat: Followup cleanups from the initial bootstat checkin.
* Clarify the README.md that the logs data may be utilized by anyone.
* Fix a whitespace issue.

Bug: 21724738
Change-Id: Id472485f505afb14588ccd645844a3f4a728abc2
2016-01-20 13:17:02 -08:00
..
Android.mk system/core: Add initial implementation of the bootstat command. 2016-01-19 15:10:38 -08:00
boot_event_record_store.cpp bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00
boot_event_record_store.h bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00
boot_event_record_store_test.cpp bootstat: Followup cleanups from the initial bootstat checkin. 2016-01-20 13:17:02 -08:00
bootstat.cpp bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00
event_log_list_builder.cpp bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00
event_log_list_builder.h bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00
event_log_list_builder_test.cpp system/core: Add initial implementation of the bootstat command. 2016-01-19 15:10:38 -08:00
README.md bootstat: Followup cleanups from the initial bootstat checkin. 2016-01-20 13:17:02 -08:00
testrunner.cpp bootstat: Fix the base includes to be AOSP-friendly. 2016-01-20 01:28:48 +00:00

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:
  -d              Dump the boot event records to the console.
  -h              Show this help.
  -l              Log all metrics to logstorage.
  -r              Record the relative time of a named boot event.

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