summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/debugging.rst
diff options
context:
space:
mode:
authorSam Gilson <t-sagils@microsoft.com>2019-07-15 21:50:33 +0000
committerServer Team CI Bot <josh.powers+server-team-bot@canonical.com>2019-07-15 21:50:33 +0000
commita24550aee4c7282cd3624bf63f9501444e517678 (patch)
tree9dd5d148266673021a56f29c4282b61e6f372898 /doc/rtd/topics/debugging.rst
parenta6faf3acef02bd8cd4d46ac9efeebf24b3f21d81 (diff)
downloadvyos-cloud-init-a24550aee4c7282cd3624bf63f9501444e517678.tar.gz
vyos-cloud-init-a24550aee4c7282cd3624bf63f9501444e517678.zip
Cloud-init analyze module: Added ability to analyze boot events.
This branch introduces a new command line feature for cloud-init. Currently, the cloud-init module has the capability to analyze events in cloud-init.log in three ways: 'show', 'blame', 'dump'. These changes add a fourth capability, called 'boot'. Running the command 'cloud-init analyze boot' will provide the user three timestamps. 1) Timestamp for when the kernel starts initializing. 2) Timestamp for when the kernel finishes its initialization. 3) Timestamp for when systemd activates cloud-init. This feature enables cloud-init users to analyze different boot phases. This would aid in debugging performance issues related to cloud-init startup or tracking regression.
Diffstat (limited to 'doc/rtd/topics/debugging.rst')
-rw-r--r--doc/rtd/topics/debugging.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/rtd/topics/debugging.rst b/doc/rtd/topics/debugging.rst
index 51363ea5..e13d9151 100644
--- a/doc/rtd/topics/debugging.rst
+++ b/doc/rtd/topics/debugging.rst
@@ -68,6 +68,19 @@ subcommands default to reading /var/log/cloud-init.log.
00.00100s (modules-final/config-rightscale_userdata)
...
+* ``analyze boot`` Make subprocess calls to the kernel in order to get relevant
+ pre-cloud-init timestamps, such as the kernel start, kernel finish boot, and cloud-init start.
+
+.. code-block:: shell-session
+
+ $ cloud-init analyze boot
+ -- Most Recent Boot Record --
+ Kernel Started at: 2019-06-13 15:59:55.809385
+ Kernel ended boot at: 2019-06-13 16:00:00.944740
+ Kernel time to boot (seconds): 5.135355
+ Cloud-init start: 2019-06-13 16:00:05.738396
+ Time between Kernel boot and Cloud-init start (seconds): 4.793656
+
Analyze quickstart - LXC
---------------------------