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
|
<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2012 Intel Corporation
Authors:
Auke Kok <auke-jan.h.kok@intel.com>
William Giokas <1007380@gmail.com>
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-bootchart" conditional='ENABLE_BOOTCHART'>
<refentryinfo>
<title>systemd-bootchart</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Auke</firstname>
<surname>Kok</surname>
<email>auke-jan.h.kok@intel.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-bootchart</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-bootchart</refname>
<refpurpose>Boot performance analysis graphing tool</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>systemd-bootchart is a tool used to analyze a boot sequence.
It collects system information pertaining to the CPU and disk load, as
well as per-process information, and then creates a chart with this
information. Usually it is invoked by setting the init to
<filename>systemd-bootchart</filename> on the kernel command line. It
be run after boot to analyze running processes, though it is recommended
to use the <option>--rel</option> switch when doing this.</para>
<para>After collecting a certain amount of data (default: 20 seconds) it
will write the SVG chart to <filename>/run/log</filename>. This chart
can be used to find problems in the start up sequence and where these
problems exist. It is essentially a more detailed version of the
systemd-analyze plot function.</para>
</refsect1>
<refsect1>
<title>Invocation</title>
<para>systemd-bootchart can be invoked in several different ways:</para>
<variablelist>
<varlistentry>
<term><emphasis>Kernel invocation</emphasis></term>
<listitem><para>The kernel can invoke systemd-bootchart
instead of the init process. In itself, systemd-bootchart
will invoke <filename>/sbin/init</filename> if invoked in
this manner.</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Started as a standalone program</emphasis></term>
<listitem><para>One can execute systemd-bootchart as
normal application from the commandline. In this mode
it is highly recommended to pass the "-r" flag in order
to not graph the time elapsed since boot and before
systemd-bootchart was started, as it may result in
extremely large graphs.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Options</title>
<para>These options can be set globally in the <filename>/etc/systemd/bootchart.conf</filename>
file.</para>
<variablelist>
<varlistentry>
<term><option>-n</option></term>
<term><option>--sample N</option></term>
<listitem><para>Specify the amount of samples, N, to
record total before bootchart exits. Each sample will
record at intervals defined by --freq.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option></term>
<term><option>--freq N</option></term>
<listitem><para>Specify the sample log frequency, N.
This can be a fractional number, but must be larger than
0.0. Most systems can cope with values under 25-50 without
creating too much overhead.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option></term>
<term><option>--rel</option></term>
<listitem><para>Use relative times instead of absolute
times. This is useful for using bootchart at post-boot
time to profile an already booted system, otherwise the
graph would become extremely large. If set, the
horizontal axis starts at the first recorded sample
instead of time=0.0.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-F</option></term>
<term><option>--filter</option></term>
<listitem><para>Disable filtering of tasks tasks that
did not contribute significantly to the boot. Processes
that are too short-lived (only seen in one sample) or
that do not consume any significant CPU time (less than
0.001sec) will not be displayed in the output graph.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option></term>
<term><option>--output [path]</option></term>
<listitem><para>Configures the output folder for writing
the graphs. By default, bootchart writes the graphs to
<filename>/run/log</filename>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option></term>
<term><option>--init [path]</option></term>
<listitem><para>Set init binary to run. Defaults to
<filename>/sbin/init</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--pss</option></term>
<listitem><para>Enable logging and graphing
of processes PSS memory consumption.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option></term>
<term><option>--entropy</option></term>
<listitem><para>Enable logging and graphing
of the kernel random entropy pool size.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option></term>
<term><option>--scale-x N</option></term>
<listitem><para>Horizontal scaling factor for all variable
graph components.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-y</option></term>
<term><option>--scale-y N</option></term>
<listitem><para>Vertical scaling factor for all variable
graph components.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Output</title>
<para>systemd-bootchart generates SVG graphs. In order to render these
on a graphical display any SVG capable viewer can be used. It should be
noted that the SVG render engines in most browsers (including Chrome
and Firefox) are many times faster than dedicated graphical applications
like Gimp and Inkscape. Just point your browser at "file:///run/log"!
</para>
</refsect1>
<refsect1>
<title>History</title>
<para>This version of bootchart was implemented from scratch, but inspired
by former bootchart incantations:</para>
<variablelist>
<varlistentry>
<term><emphasis>Original bash</emphasis></term>
<listitem><para>The original bash/shell code implemented
bootchart. This version created a compressed tarball for
processing with external applications. This version did
not graph anything, only generated data.</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Ubuntu C Implementation</emphasis></term>
<listitem><para>This version replaced the shell version with
a fast and efficient data logger, but also did not graph
the data.</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Java bootchart</emphasis></term>
<listitem><para>This was the original graphing application
for charting the data, written in java.</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>pybootchartgui.py</emphasis></term>
<listitem><para>pybootchart created a graph from the data
collected by either the bash or C version.</para></listitem>
</varlistentry>
</variablelist>
<para>The version of bootchart you are using now combines both the data
collection and the charting into a single application, making it more
efficient and simpler. There are no longer any timing issues with the data
collector and the grapher, as the graphing cannot be run until the data
has been collected. Also, the data kept in memory is reduced to the absolute
minimum needed.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1>
<title>Bugs</title>
<para>For bugs, please contact the author or current maintainer:</para>
<varlistentry>
<term>Auke Kok</term>
<term><emphasis>auke-jan.h.kok@intel.com</emphasis></term>
</varlistentry>
</refsect1>
</refentry>
|
