Skip to content

Commit

Permalink
man: move bootchart README to manpage, docbooksify
Browse files Browse the repository at this point in the history
  • Loading branch information
@keszybz
keszybz committed Feb 16, 2013
1 parent d0a5cdb commit f1c24fe
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 144 deletions.
7 changes: 7 additions & 0 deletions README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ REQUIREMENTS:
dracut (optional)
PolicyKit (optional)

For systmed-bootchart a kernel with procfs support and several
proc output options enabled is required:

CONFIG_PROC_FS
CONFIG_SCHEDSTATS
CONFIG_SCHED_DEBUG

When building from git you need the following additional dependencies:

docbook-xsl
Expand Down
162 changes: 101 additions & 61 deletions man/systemd-bootchart.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,78 +48,115 @@

<refnamediv>
<refname>systemd-bootchart</refname>
<refpurpose>Boot performance analysis graphing tool</refpurpose>
<refpurpose>Boot performance 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>
<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
the <command>systemd-analyze</command>
<command>plot</command> function.
</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
time-stamped in <filename>/run/log</filename>.
</para>

</refsect1>

<refsect1>
<title>Invocation</title>

<para>systemd-bootchart can be invoked in several different ways:</para>
<para><command>systemd-bootchart</command> 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>
<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>
</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>
<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
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>
<para>These options can also be set in the
<filename>/etc/systemd/bootchart.conf</filename>
file. See
<citerefentry><refentrytitle>bootchart.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</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>
<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>
</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
<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
creating too much overhead.</para></listitem>
</varlistentry>

Expand All @@ -128,44 +165,48 @@
<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
time to profile an already booted system. Without this
option the graph would become extremely large. If set, the
horizontal axis starts at the first recorded sample
instead of time=0.0.</para></listitem>
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
<listitem><para>Disable filtering of 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.
0.001 s) 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
<term><option>--output <replaceable>path</replaceable></option></term>
<listitem><para>Specify the output folder for 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>.
<term><option>--init <replaceable>path</replaceable></option></term>
<listitem><para>Use this init binary. Defaults to
<command>/sbin/init</command>.
</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>
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>
</varlistentry>

<varlistentry>
Expand All @@ -177,14 +218,14 @@

<varlistentry>
<term><option>-x</option></term>
<term><option>--scale-x N</option></term>
<term><option>--scale-x <replaceable>N</replaceable></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>
<term><option>--scale-y <replaceable>N</replaceable></option></term>
<listitem><para>Vertical scaling factor for all variable
graph components.</para></listitem>
</varlistentry>
Expand All @@ -197,19 +238,20 @@
<refsect1>
<title>Output</title>

<para>systemd-bootchart generates SVG graphs. In order to render these
<para><command>systemd-bootchart</command> generates SVG graphs. In order to render those
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"!
like Gimp and Inkscape. Just point your browser at <ulink url="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>
<para>This version of bootchart was implemented from
scratch, but is inspired by former bootchart
incantations:</para>

<variablelist>
<varlistentry>
Expand Down Expand Up @@ -247,7 +289,6 @@
has been collected. Also, the data kept in memory is reduced to the absolute
minimum needed.</para>


</refsect1>

<refsect1>
Expand All @@ -259,11 +300,10 @@

<refsect1>
<title>Bugs</title>
<para>For bugs, please contact the author or current maintainer:</para>
<varlistentry>
<term>Auke Kok</term>
<term><emphasis>[email protected]</emphasis></term>
</varlistentry>
<para>For bugs, please contact the author and current maintainer:</para>
<simplelist>
<member>Auke Kok <email>[email protected]</email></member>
</simplelist>
</refsect1>

</refentry>
83 changes: 0 additions & 83 deletions src/bootchart/README
View file

This file was deleted.

11 changes: 11 additions & 0 deletions src/bootchart/bootchart.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

/***
Many thanks to those who contributed ideas and code:
- Ziga Mahkovec - Original bootchart author
- Anders Norgaard - PyBootchartgui
- Michael Meeks - bootchart2
- Scott James Remnant - Ubuntu C-based logger
- Arjan van der Ven - for the idea to merge bootgraph.pl functionality
***/

#include <sys/time.h>
#include <sys/types.h>
#include <sys/resource.h>
Expand Down

0 comments on commit f1c24fe

Please sign in to comment.