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="confd" />
72 <xi:include href="standard-conf.xml" xpointer="conf" />
75 <title>Options</title>
77 <variablelist class='bootchart-directives'>
80 <term><varname>Samples=500</varname></term>
81 <listitem><para>Configure the amount of samples to record in
82 total before bootchart exits. Each sample will record at
83 intervals defined by Frequency=.</para></listitem>
87 <term><varname>Frequency=25</varname></term>
88 <listitem><para>Configure the sample log frequency. This can
89 be a fractional number, but must be larger than 0.0. Most
90 systems can cope with values under 25-50 without impacting
91 boot time severely.</para></listitem>
95 <term><varname>Relative=no</varname></term>
96 <listitem><para>Configures whether the left axis of the output
97 graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant>
98 start). This is useful for using bootchart at post-boot time
99 to profile an already booted system, otherwise the graph would
100 become extremely large. If set to yes, the horizontal axis
101 starts at the first recorded sample instead of time=0.0.
106 <term><varname>Filter=no</varname></term>
107 <listitem><para>Configures whether the resulting graph should
108 omit tasks that did not contribute significantly to the boot.
109 Processes that are too short-lived (only seen in one sample)
110 or that do not consume any significant CPU time (less than
111 0.001sec) will not be displayed in the output
112 graph.</para></listitem>
116 <term><varname>Output=[path]</varname></term>
117 <listitem><para>Configures the output directory for writing
118 the graphs. By default, bootchart writes the graphs to
119 <filename>/run/log</filename>.</para></listitem>
123 <term><varname>Init=[path]</varname></term>
124 <listitem><para>Configures bootchart to run a non-standard
126 <filename>/usr/lib/systemd/systemd</filename>. This option is
127 only relevant if bootchart was invoked from the kernel command
129 init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
133 <term><varname>PlotMemoryUsage=no</varname></term>
134 <listitem><para>If set to yes, enables logging and graphing of
135 processes' PSS memory consumption.</para></listitem>
139 <term><varname>PlotEntropyGraph=no</varname></term>
140 <listitem><para>If set to yes, enables logging and graphing of
141 the kernel random entropy pool size.</para></listitem>
145 <term><varname>ScaleX=100</varname></term>
146 <listitem><para>Horizontal scaling factor for all variable
147 graph components.</para></listitem>
151 <term><varname>ScaleY=20</varname></term>
152 <listitem><para>Vertical scaling factor for all variable graph
153 components.</para></listitem>
157 <term><varname>ControlGroup=no</varname></term>
158 <listitem><para>Display process control group.
166 <title>See Also</title>
168 <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
169 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>