1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
.. _analyze:
Performance
***********
The :command:`analyze` subcommand was added to ``cloud-init`` to help analyze
``cloud-init`` boot time performance. It is loosely based on
``systemd-analyze``, where there are four subcommands:
- :command:`blame`
- :command:`show`
- :command:`dump`
- :command:`boot`
Usage
=====
The :command:`analyze` command requires one of the four subcommands:
.. code-block:: shell-session
$ cloud-init analyze blame
$ cloud-init analyze show
$ cloud-init analyze dump
$ cloud-init analyze boot
Availability
============
The :command:`analyze` subcommand is generally available across all
distributions, with the exception of Gentoo and FreeBSD.
Subcommands
===========
:command:`Blame`
----------------
The :command:`blame` subcommand matches :command:`systemd-analyze blame` where
it prints, in descending order, the units that took the longest time to run.
This output is highly useful for examining where ``cloud-init`` is spending
its time.
.. code-block:: shell-session
$ cloud-init analyze blame
Example output:
.. code-block::
-- Boot Record 01 --
00.80300s (init-network/config-growpart)
00.64300s (init-network/config-resizefs)
00.62100s (init-network/config-ssh)
00.57300s (modules-config/config-grub-dpkg)
00.40300s (init-local/search-NoCloud)
00.38200s (init-network/config-users-groups)
00.19800s (modules-config/config-apt-configure)
00.03700s (modules-final/config-keys-to-console)
00.02100s (init-network/config-update_etc_hosts)
00.02100s (init-network/check-cache)
00.00800s (modules-final/config-ssh-authkey-fingerprints)
00.00800s (init-network/consume-vendor-data)
00.00600s (modules-config/config-timezone)
00.00500s (modules-final/config-final-message)
00.00400s (init-network/consume-user-data)
00.00400s (init-network/config-mounts)
00.00400s (init-network/config-disk_setup)
00.00400s (init-network/config-bootcmd)
00.00400s (init-network/activate-datasource)
00.00300s (init-network/config-update_hostname)
00.00300s (init-network/config-set_hostname)
00.00200s (modules-final/config-snappy)
00.00200s (init-network/config-rsyslog)
00.00200s (init-network/config-ca-certs)
00.00200s (init-local/check-cache)
00.00100s (modules-final/config-scripts-vendor)
00.00100s (modules-final/config-scripts-per-once)
00.00100s (modules-final/config-salt-minion)
00.00100s (modules-final/config-rightscale_userdata)
00.00100s (modules-final/config-phone-home)
00.00100s (modules-final/config-package-update-upgrade-install)
00.00100s (modules-final/config-fan)
00.00100s (modules-config/config-ubuntu-advantage)
00.00100s (modules-config/config-ssh-import-id)
00.00100s (modules-config/config-snap)
00.00100s (modules-config/config-set-passwords)
00.00100s (modules-config/config-runcmd)
00.00100s (modules-config/config-locale)
00.00100s (modules-config/config-byobu)
00.00100s (modules-config/config-apt-pipelining)
00.00100s (init-network/config-write-files)
00.00100s (init-network/config-seed_random)
00.00100s (init-network/config-migrator)
00.00000s (modules-final/config-ubuntu-drivers)
00.00000s (modules-final/config-scripts-user)
00.00000s (modules-final/config-scripts-per-instance)
00.00000s (modules-final/config-scripts-per-boot)
00.00000s (modules-final/config-puppet)
00.00000s (modules-final/config-power-state-change)
00.00000s (modules-final/config-mcollective)
00.00000s (modules-final/config-lxd)
00.00000s (modules-final/config-landscape)
00.00000s (modules-final/config-chef)
00.00000s (modules-config/config-snap_config)
00.00000s (modules-config/config-ntp)
00.00000s (modules-config/config-disable-ec2-metadata)
00.00000s (init-network/setup-datasource)
1 boot records analyzed
:command:`Show`
---------------
The :command:`show` subcommand is similar to
:command:`systemd-analyze critical-chain` which prints a list of units, the
time they started and how long they took. ``Cloud-init`` has five
:ref:`boot stages<boot_stages>`, and within each stage a number of modules may
run depending on configuration. :command:`cloudinit-analyze show` will, for
each boot, print this information and a summary of the total time.
The following is an abbreviated example of the :command:`show` subcommand:
.. code-block:: shell-session
$ cloud-init analyze show
Example output:
.. code-block:: shell-session
-- Boot Record 01 --
The total time elapsed since completing an event is printed after the "@" character.
The time the event takes is printed after the "+" character.
Starting stage: init-local
|``->no cache found @00.01700s +00.00200s
|`->found local data from DataSourceNoCloud @00.11000s +00.40300s
Finished stage: (init-local) 00.94200 seconds
Starting stage: init-network
|`->restored from cache with run check: DataSourceNoCloud [seed=/dev/sr0][dsmode=net] @04.79500s +00.02100s
|`->setting up datasource @04.88900s +00.00000s
|`->reading and applying user-data @04.90100s +00.00400s
|`->reading and applying vendor-data @04.90500s +00.00800s
|`->activating datasource @04.95200s +00.00400s
Finished stage: (init-network) 02.72100 seconds
Starting stage: modules-config
|`->config-snap ran successfully @15.43100s +00.00100s
...
|`->config-runcmd ran successfully @16.22300s +00.00100s
|`->config-byobu ran successfully @16.23400s +00.00100s
Finished stage: (modules-config) 00.83500 seconds
Starting stage: modules-final
|`->config-snappy ran successfully @16.87400s +00.00200s
|`->config-package-update-upgrade-install ran successfully @16.87600s +00.00100s
...
|`->config-final-message ran successfully @16.93700s +00.00500s
|`->config-power-state-change ran successfully @16.94300s +00.00000s
Finished stage: (modules-final) 00.10300 seconds
Total Time: 4.60100 seconds
1 boot records analyzed
If additional boot records are detected then they are printed out from oldest
to newest.
:command:`Dump`
---------------
The :command:`dump` subcommand simply dumps the ``cloud-init`` logs that the
:command:`analyze` module is performing its analysis on, and returns a list of
dictionaries that can be consumed for other reporting needs. Each element in
the list is a boot entry.
.. code-block:: shell-session
$ cloud-init analyze dump
Example output:
.. code-block::
[
{
"description": "starting search for local datasources",
"event_type": "start",
"name": "init-local",
"origin": "cloudinit",
"timestamp": 1567057578.037
},
{
"description": "attempting to read from cache [check]",
"event_type": "start",
"name": "init-local/check-cache",
"origin": "cloudinit",
"timestamp": 1567057578.054
},
{
"description": "no cache found",
"event_type": "finish",
"name": "init-local/check-cache",
"origin": "cloudinit",
"result": "SUCCESS",
"timestamp": 1567057578.056
},
{
"description": "searching for local data from DataSourceNoCloud",
"event_type": "start",
"name": "init-local/search-NoCloud",
"origin": "cloudinit",
"timestamp": 1567057578.147
},
{
"description": "found local data from DataSourceNoCloud",
"event_type": "finish",
"name": "init-local/search-NoCloud",
"origin": "cloudinit",
"result": "SUCCESS",
"timestamp": 1567057578.55
},
{
"description": "searching for local datasources",
"event_type": "finish",
"name": "init-local",
"origin": "cloudinit",
"result": "SUCCESS",
"timestamp": 1567057578.979
},
{
"description": "searching for network datasources",
"event_type": "start",
"name": "init-network",
"origin": "cloudinit",
"timestamp": 1567057582.814
},
{
"description": "attempting to read from cache [trust]",
"event_type": "start",
"name": "init-network/check-cache",
"origin": "cloudinit",
"timestamp": 1567057582.832
},
...
{
"description": "config-power-state-change ran successfully",
"event_type": "finish",
"name": "modules-final/config-power-state-change",
"origin": "cloudinit",
"result": "SUCCESS",
"timestamp": 1567057594.98
},
{
"description": "running modules for final",
"event_type": "finish",
"name": "modules-final",
"origin": "cloudinit",
"result": "SUCCESS",
"timestamp": 1567057594.982
}
]
:command:`Boot`
---------------
The :command:`boot` subcommand prints out kernel-related timestamps that are
not included in any of the ``cloud-init`` logs. There are three different
timestamps that are presented to the user:
- ``kernel start``
- ``kernel finish boot``
- ``cloud-init start``
This was added for additional clarity into the boot process that
``cloud-init`` does not have control over, to aid in debugging performance
issues related to ``cloud-init`` startup, and tracking regression.
.. code-block:: shell-session
$ cloud-init analyze boot
Example output:
.. code-block::
-- Most Recent Boot Record --
Kernel Started at: 2019-08-29 01:35:37.753790
Kernel ended boot at: 2019-08-29 01:35:38.807407
Kernel time to boot (seconds): 1.053617000579834
Cloud-init activated by systemd at: 2019-08-29 01:35:43.992460
Time between Kernel end boot and Cloud-init activation (seconds): 5.185053110122681
Cloud-init start: 2019-08-29 08:35:45.867000
successful
Timestamp gathering
-------------------
The following boot-related timestamps are gathered on demand when
:command:`cloud-init analyze boot` runs:
- Kernel startup gathered from system uptime
- Kernel finishes initialization from systemd
``UserSpaceMonotonicTimestamp`` property
- ``Cloud-init`` activation from the property ``InactiveExitTimestamp``
of the ``cloud-init`` local systemd unit
In order to gather the necessary timestamps using systemd, running the
following command will gather the ``UserspaceTimestamp``:
.. code-block:: shell-session
$ systemctl show -p UserspaceTimestampMonotonic
Example output:
.. code-block::
UserspaceTimestampMonotonic=989279
The ``UserspaceTimestamp`` tracks when the init system starts, which is used
as an indicator of the kernel finishing initialisation.
Running the following command will gather the ``InactiveExitTimestamp``:
.. code-block:: shell-session
$ systemctl show cloud-init-local -p InactiveExitTimestampMonotonic
Example output:
.. code-block::
InactiveExitTimestampMonotonic=4493126
The ``InactiveExitTimestamp`` tracks when a particular systemd unit
transitions from the `Inactive` to `Active` state, which can be used to mark
the beginning of systemd's activation of ``cloud-init``.
Currently this only works for distros that use systemd as the init process.
We will be expanding support for other distros in the future and this document
will be updated accordingly.
If systemd is not present on the system, ``dmesg`` is used to attempt to find
an event that logs the beginning of the init system. However, with this method
only the first two timestamps are able to be found; ``dmesg`` does not monitor
userspace processes, so no ``cloud-init`` start timestamps are emitted --
unlike when using systemd.
|
