1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7 This file is part of systemd.
9 Copyright 2012 Intel Corporation
12 Auke Kok <auke-jan.h.kok@intel.com>
14 systemd is free software; you can redistribute it and/or modify it
15 under the terms of the GNU Lesser General Public License as published by
16 the Free Software Foundation; either version 2.1 of the License, or
17 (at your option) any later version.
19 systemd is distributed in the hope that it will be useful, but
20 WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public License
25 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 <refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART'
29 xmlns:xi="http://www.w3.org/2001/XInclude">
31 <title>bootchart.conf</title>
32 <productname>systemd</productname>
36 <contrib>Developer</contrib>
37 <firstname>Auke</firstname>
38 <surname>Kok</surname>
39 <email>auke-jan.h.kok@intel.com</email>
45 <refentrytitle>bootchart.conf</refentrytitle>
46 <manvolnum>5</manvolnum>
50 <refname>bootchart.conf</refname>
51 <refname>bootchart.conf.d</refname>
52 <refpurpose>Boot performance analysis graphing tool configuration files</refpurpose>
56 <para><filename>/etc/systemd/bootchart.conf</filename></para>
57 <para><filename>/etc/systemd/bootchart.conf.d/*.conf</filename></para>
58 <para><filename>/run/systemd/bootchart.conf.d/*.conf</filename></para>
59 <para><filename>/usr/lib/systemd/bootchart.conf.d/*.conf</filename></para>
63 <title>Description</title>
65 <para>When starting, systemd-bootchart will read the configuration
66 file <filename>/etc/systemd/bootchart.conf</filename>, followed by
67 the files in the <filename>bootchart.conf.d</filename>
68 directories. These configuration files determine logging
69 parameters and graph output.</para>
72 <xi:include href="standard-conf.xml" xpointer="confd" />
73 <xi:include href="standard-conf.xml" xpointer="conf" />
76 <title>Options</title>
78 <variablelist class='bootchart-directives'>
81 <term><varname>Samples=500</varname></term>
82 <listitem><para>Configure the amount of samples to record in
83 total before bootchart exits. Each sample will record at
84 intervals defined by Frequency=.</para></listitem>
88 <term><varname>Frequency=25</varname></term>
89 <listitem><para>Configure the sample log frequency. This can
90 be a fractional number, but must be larger than 0.0. Most
91 systems can cope with values under 25-50 without impacting
92 boot time severely.</para></listitem>
96 <term><varname>Relative=no</varname></term>
97 <listitem><para>Configures whether the left axis of the output
98 graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant>
99 start). This is useful for using bootchart at post-boot time
100 to profile an already booted system, otherwise the graph would
101 become extremely large. If set to yes, the horizontal axis
102 starts at the first recorded sample instead of time=0.0.
107 <term><varname>Filter=no</varname></term>
108 <listitem><para>Configures whether the resulting graph should
109 omit tasks that did not contribute significantly to the boot.
110 Processes that are too short-lived (only seen in one sample)
111 or that do not consume any significant CPU time (less than
112 0.001sec) will not be displayed in the output
113 graph.</para></listitem>
117 <term><varname>Output=[path]</varname></term>
118 <listitem><para>Configures the output directory for writing
119 the graphs. By default, bootchart writes the graphs to
120 <filename>/run/log</filename>.</para></listitem>
124 <term><varname>Init=[path]</varname></term>
125 <listitem><para>Configures bootchart to run a non-standard
127 <filename>/usr/lib/systemd/systemd</filename>. This option is
128 only relevant if bootchart was invoked from the kernel command
130 init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
134 <term><varname>PlotMemoryUsage=no</varname></term>
135 <listitem><para>If set to yes, enables logging and graphing of
136 processes' PSS memory consumption.</para></listitem>
140 <term><varname>PlotEntropyGraph=no</varname></term>
141 <listitem><para>If set to yes, enables logging and graphing of
142 the kernel random entropy pool size.</para></listitem>
146 <term><varname>ScaleX=100</varname></term>
147 <listitem><para>Horizontal scaling factor for all variable
148 graph components.</para></listitem>
152 <term><varname>ScaleY=20</varname></term>
153 <listitem><para>Vertical scaling factor for all variable graph
154 components.</para></listitem>
158 <term><varname>ControlGroup=no</varname></term>
159 <listitem><para>Display process control group.
167 <title>See Also</title>
169 <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
170 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>