2012-10-18 03:01:12 +04:00
<?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 @ i n t e l . c o m >
2013-02-13 13:38:49 +04:00
William Giokas <1007380 @ g m a i l . c o m >
2012-10-18 03:01:12 +04:00
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: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
2014-02-13 23:33:51 +04:00
<refentry id= "systemd-bootchart" conditional= 'ENABLE_BOOTCHART'
xmlns:xi="http://www.w3.org/2001/XInclude">
2012-10-18 03:01:12 +04:00
<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>
2013-02-16 21:40:33 +04:00
<refpurpose > Boot performance graphing tool</refpurpose>
2012-10-18 03:01:12 +04:00
</refnamediv>
<refsect1 >
<title > Description</title>
2013-02-16 21:40:33 +04:00
<para >
<command > systemd-bootchart</command> is a
tool, usually run at system startup, that
collects the CPU load, disk load, memory
usage, as well as per-process information from
a running system. Collected results are output
as an SVG graph. Normally, systemd-bootchart
is invoked by the kernel by passing
<option > init=<filename > /usr/lib/systemd/systemd-bootchart</filename> </option>
on the kernel commandline. systemd-bootchart will then
fork the real init off to resume normal system
startup, while monitoring and logging startup
information in the background.
</para>
<para >
After collecting a certain amount of data
(usually 15-30 seconds, default 20 s) the
logging stops and a graph is generated from
the logged information. This graph contains
vital clues as to which resources are being used,
in which order, and where possible problems
exist in the startup sequence of the system.
It is essentially a more detailed version of
2014-03-06 12:49:49 +04:00
the <command > systemd-analyze plot</command>
function.
2013-02-16 21:40:33 +04:00
</para>
<para >
Of course, bootchart can also be used at any
moment in time to collect and graph some data
for an amount of time. It is
recommended to use the <option > --rel</option>
switch in this case.
</para>
<para >
Bootchart does not require root privileges,
and will happily run as a normal user.
</para>
<para >
Bootchart graphs are by default written
2013-04-16 06:42:27 +04:00
time-stamped in <filename > /run/log</filename>
and saved to the journal with
<varname > MESSAGE_ID=9f26aa562cf440c2b16c773d0479b518</varname> .
Journal field <varname > BOOTCHART=</varname> contains
the bootchart in SVG format.
2013-02-16 21:40:33 +04:00
</para>
2012-10-18 03:01:12 +04:00
</refsect1>
<refsect1 >
<title > Invocation</title>
2013-02-16 21:40:33 +04:00
<para > <command > systemd-bootchart</command> can be invoked in several different ways:</para>
2012-10-18 03:01:12 +04:00
2013-01-26 19:47:16 +04:00
<variablelist >
2012-10-18 03:01:12 +04:00
<varlistentry >
2013-02-14 10:13:54 +04:00
<term > <emphasis > Kernel invocation</emphasis> </term>
2013-02-16 21:40:33 +04:00
<listitem > <para > The kernel can invoke
<command > systemd-bootchart</command>
instead of the init process. In turn,
<command > systemd-bootchart</command>
will invoke <command > /sbin/init</command> .
</para> </listitem>
2012-10-18 03:01:12 +04:00
</varlistentry>
<varlistentry >
2013-02-14 10:13:54 +04:00
<term > <emphasis > Started as a standalone program</emphasis> </term>
2013-02-16 21:40:33 +04:00
<listitem > <para > One can execute
<command > systemd-bootchart</command>
as normal application from the
commandline. In this mode it is highly
recommended to pass the
<option > -r</option> flag in order to
not graph the time elapsed since boot
and before systemd-bootchart was
started, as it may result in extremely
2014-07-31 12:15:39 +04:00
large graphs. The time elapsed since boot
might also include any time that the system
was suspended.</para> </listitem>
2012-10-18 03:01:12 +04:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1 >
<title > Options</title>
2013-02-16 21:40:33 +04:00
<para > These options can also be set in the
<filename > /etc/systemd/bootchart.conf</filename>
file. See
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 02:25:54 +04:00
<citerefentry project= 'man-pages' > <refentrytitle > bootchart.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
2013-02-16 21:40:33 +04:00
</para>
2013-02-14 10:13:54 +04:00
<variablelist >
2014-02-13 23:33:51 +04:00
<xi:include href= "standard-options.xml" xpointer= "help" />
2013-05-02 20:21:23 +04:00
2013-02-13 13:38:49 +04:00
<varlistentry >
<term > <option > -n</option> </term>
2013-02-16 21:40:33 +04:00
<term > <option > --sample <replaceable > N</replaceable> </option> </term>
<listitem > <para > Specify the number of
samples, <replaceable > N</replaceable> ,
to record. Samples will be recorded at
intervals defined with <option > --freq</option> .
</para> </listitem>
2013-02-13 13:38:49 +04:00
</varlistentry>
<varlistentry >
<term > <option > -f</option> </term>
2013-02-16 21:40:33 +04:00
<term > <option > --freq <replaceable > f</replaceable> </option> </term>
<listitem > <para > Specify the sample log
frequency, a positive real <replaceable > f</replaceable> , in Hz.
Most systems can cope with values up to 25-50 without
2013-02-14 10:13:54 +04:00
creating too much overhead.</para> </listitem>
2013-02-13 13:38:49 +04:00
</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
2013-02-16 21:40:33 +04:00
time to profile an already booted system. Without this
option the graph would become extremely large. If set, the
2013-02-13 13:38:49 +04:00
horizontal axis starts at the first recorded sample
2013-02-16 21:40:33 +04:00
instead of time 0.0.</para> </listitem>
2013-02-13 13:38:49 +04:00
</varlistentry>
<varlistentry >
<term > <option > -F</option> </term>
2013-02-17 00:16:24 +04:00
<term > <option > --no-filter</option> </term>
2013-02-16 21:40:33 +04:00
<listitem > <para > Disable filtering of tasks that
2013-02-13 13:38:49 +04:00
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
2013-02-16 21:40:33 +04:00
0.001 s) will not be displayed in the output graph.
2013-02-13 13:38:49 +04:00
</para> </listitem>
</varlistentry>
2013-03-07 19:19:38 +04:00
<varlistentry >
<term > <option > -C</option> </term>
<term > <option > --cmdline</option> </term>
<listitem > <para > Display the full command line with arguments of processes,
instead of only the process name.
</para> </listitem>
</varlistentry>
2014-04-24 19:50:51 +04:00
<varlistentry >
<term > <option > -g</option> </term>
<term > <option > --control-group</option> </term>
<listitem > <para > Display process control group
</para> </listitem>
</varlistentry>
2013-02-13 13:38:49 +04:00
<varlistentry >
<term > <option > -o</option> </term>
2013-02-16 21:40:33 +04:00
<term > <option > --output <replaceable > path</replaceable> </option> </term>
2013-07-21 08:53:14 +04:00
<listitem > <para > Specify the output directory for the
2013-02-16 21:40:33 +04:00
graphs. By default, bootchart writes the graphs to
2013-02-14 00:49:24 +04:00
<filename > /run/log</filename> .</para> </listitem>
2013-02-13 13:38:49 +04:00
</varlistentry>
<varlistentry >
<term > <option > -i</option> </term>
2013-02-16 21:40:33 +04:00
<term > <option > --init <replaceable > path</replaceable> </option> </term>
<listitem > <para > Use this init binary. Defaults to
<command > /sbin/init</command> .
2013-02-13 13:38:49 +04:00
</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > -p</option> </term>
<term > <option > --pss</option> </term>
<listitem > <para > Enable logging and graphing
2013-02-16 21:40:33 +04:00
of processes' PSS (Proportional Set Size)
memory consumption. See <filename > filesystems/proc.txt</filename>
in the kernel documentation for an
explanation of this field.
</para> </listitem>
2013-02-13 13:38:49 +04:00
</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>
2013-02-16 21:40:33 +04:00
<term > <option > --scale-x <replaceable > N</replaceable> </option> </term>
2013-02-13 13:38:49 +04:00
<listitem > <para > Horizontal scaling factor for all variable
graph components.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > -y</option> </term>
2013-02-16 21:40:33 +04:00
<term > <option > --scale-y <replaceable > N</replaceable> </option> </term>
2013-02-13 13:38:49 +04:00
<listitem > <para > Vertical scaling factor for all variable
graph components.</para> </listitem>
</varlistentry>
</variablelist>
2012-10-18 03:01:12 +04:00
</refsect1>
<refsect1 >
<title > Output</title>
2013-02-16 21:40:33 +04:00
<para > <command > systemd-bootchart</command> generates SVG graphs. In order to render those
2013-01-10 00:25:02 +04:00
on a graphical display any SVG capable viewer can be used. It should be
2012-10-18 03:01:12 +04:00
noted that the SVG render engines in most browsers (including Chrome
and Firefox) are many times faster than dedicated graphical applications
2013-02-16 21:40:33 +04:00
like Gimp and Inkscape. Just point your browser at <ulink url= "file:///run/log/" /> !
2013-02-14 10:13:54 +04:00
</para>
</refsect1>
<refsect1 >
<title > History</title>
2013-02-16 21:40:33 +04:00
<para > This version of bootchart was implemented from
scratch, but is inspired by former bootchart
incantations:</para>
2013-02-14 10:13:54 +04:00
<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 >
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 02:25:54 +04:00
<citerefentry project= 'man-pages' > <refentrytitle > bootchart.conf</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2012-10-18 03:01:12 +04:00
</para>
</refsect1>
<refsect1 >
2013-02-14 10:13:54 +04:00
<title > Bugs</title>
2013-02-17 08:04:29 +04:00
<para > systemd-bootchart does not get the model information for the hard drive
unless the root device is specified with <code > root=/dev/sdxY</code> . Using
UUIDs or PARTUUIDs will boot fine, but the hard drive model will not be
added to the chart.</para>
2013-02-16 21:40:33 +04:00
<para > For bugs, please contact the author and current maintainer:</para>
<simplelist >
<member > Auke Kok <email > auke-jan.h.kok@intel.com</email> </member>
</simplelist>
2012-10-18 03:01:12 +04:00
</refsect1>
</refentry>
