1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2012 Intel Corporation
11 Auke Kok <auke-jan.h.kok@intel.com>
13 systemd is free software; you can redistribute it and/or modify it
14 under the terms of the GNU Lesser General Public License as published by
15 the Free Software Foundation; either version 2.1 of the License, or
16 (at your option) any later version.
18 systemd is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public License
24 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 <refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART'
28 xmlns:xi="http://www.w3.org/2001/XInclude">
30 <title>bootchart.conf</title>
31 <productname>systemd</productname>
35 <contrib>Developer</contrib>
36 <firstname>Auke</firstname>
37 <surname>Kok</surname>
38 <email>auke-jan.h.kok@intel.com</email>
44 <refentrytitle>bootchart.conf</refentrytitle>
45 <manvolnum>5</manvolnum>
49 <refname>bootchart.conf</refname>
50 <refname>bootchart.conf.d</refname>
51 <refpurpose>Boot performance analysis graphing tool configuration files</refpurpose>
55 <para><filename>/etc/systemd/bootchart.conf</filename></para>
56 <para><filename>/etc/systemd/bootchart.conf.d/*.conf</filename></para>
57 <para><filename>/run/systemd/bootchart.conf.d/*.conf</filename></para>
58 <para><filename>/usr/lib/systemd/bootchart.conf.d/*.conf</filename></para>
62 <title>Description</title>
64 <para>When starting, systemd-bootchart will read the configuration
65 file <filename>/etc/systemd/bootchart.conf</filename>, followed by
66 the files in the <filename>bootchart.conf.d</filename>
67 directories. These configuration files determine logging
68 parameters and graph output.</para>
71 <xi:include href="standard-conf.xml" xpointer="main-conf" />
74 <title>Options</title>
76 <variablelist class='bootchart-directives'>
79 <term><varname>Samples=500</varname></term>
80 <listitem><para>Configure the amount of samples to record in
81 total before bootchart exits. Each sample will record at
82 intervals defined by Frequency=.</para></listitem>
86 <term><varname>Frequency=25</varname></term>
87 <listitem><para>Configure the sample log frequency. This can
88 be a fractional number, but must be larger than 0.0. Most
89 systems can cope with values under 25-50 without impacting
90 boot time severely.</para></listitem>
94 <term><varname>Relative=no</varname></term>
95 <listitem><para>Configures whether the left axis of the output
96 graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant>
97 start). This is useful for using bootchart at post-boot time
98 to profile an already booted system, otherwise the graph would
99 become extremely large. If set to yes, the horizontal axis
100 starts at the first recorded sample instead of time=0.0.
105 <term><varname>Filter=no</varname></term>
106 <listitem><para>Configures whether the resulting graph should
107 omit tasks that did not contribute significantly to the boot.
108 Processes that are too short-lived (only seen in one sample)
109 or that do not consume any significant CPU time (less than
110 0.001sec) will not be displayed in the output
111 graph.</para></listitem>
115 <term><varname>Output=[path]</varname></term>
116 <listitem><para>Configures the output directory for writing
117 the graphs. By default, bootchart writes the graphs to
118 <filename>/run/log</filename>.</para></listitem>
122 <term><varname>Init=[path]</varname></term>
123 <listitem><para>Configures bootchart to run a non-standard
125 <filename>/usr/lib/systemd/systemd</filename>. This option is
126 only relevant if bootchart was invoked from the kernel command
128 init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
132 <term><varname>PlotMemoryUsage=no</varname></term>
133 <listitem><para>If set to yes, enables logging and graphing of
134 processes' PSS memory consumption.</para></listitem>
138 <term><varname>PlotEntropyGraph=no</varname></term>
139 <listitem><para>If set to yes, enables logging and graphing of
140 the kernel random entropy pool size.</para></listitem>
144 <term><varname>ScaleX=100</varname></term>
145 <listitem><para>Horizontal scaling factor for all variable
146 graph components.</para></listitem>
150 <term><varname>ScaleY=20</varname></term>
151 <listitem><para>Vertical scaling factor for all variable graph
152 components.</para></listitem>
156 <term><varname>ControlGroup=no</varname></term>
157 <listitem><para>Display process control group.
165 <title>See Also</title>
167 <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
168 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>