]>
Commit | Line | Data |
---|---|---|
83fdc450 AK |
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"> | |
5 | ||
6 | <!-- | |
7 | This file is part of systemd. | |
8 | ||
9 | Copyright 2012 Intel Corporation | |
10 | ||
11 | Authors: | |
12 | Auke Kok <auke-jan.h.kok@intel.com> | |
13 | ||
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. | |
18 | ||
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. | |
23 | ||
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/>. | |
26 | --> | |
27 | ||
396f9e2b JT |
28 | <refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART' |
29 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
83fdc450 AK |
30 | <refentryinfo> |
31 | <title>bootchart.conf</title> | |
32 | <productname>systemd</productname> | |
33 | ||
34 | <authorgroup> | |
35 | <author> | |
36 | <contrib>Developer</contrib> | |
37 | <firstname>Auke</firstname> | |
38 | <surname>Kok</surname> | |
39 | <email>auke-jan.h.kok@intel.com</email> | |
40 | </author> | |
41 | </authorgroup> | |
42 | </refentryinfo> | |
43 | ||
44 | <refmeta> | |
45 | <refentrytitle>bootchart.conf</refentrytitle> | |
46 | <manvolnum>5</manvolnum> | |
47 | </refmeta> | |
48 | ||
49 | <refnamediv> | |
50 | <refname>bootchart.conf</refname> | |
396f9e2b JT |
51 | <refname>bootchart.conf.d</refname> |
52 | <refpurpose>Boot performance analysis graphing tool configuration files</refpurpose> | |
83fdc450 AK |
53 | </refnamediv> |
54 | ||
55 | <refsynopsisdiv> | |
56 | <para><filename>/etc/systemd/bootchart.conf</filename></para> | |
396f9e2b JT |
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> | |
83fdc450 AK |
60 | </refsynopsisdiv> |
61 | ||
62 | <refsect1> | |
63 | <title>Description</title> | |
64 | ||
65 | <para>When starting, systemd-bootchart will read the | |
396f9e2b JT |
66 | configuration file |
67 | <filename>/etc/systemd/bootchart.conf</filename>, followed by | |
68 | the files in the <filename>bootchart.conf.d</filename> | |
69 | directories. These configuration files determine logging | |
70 | parameters and graph output.</para> | |
83fdc450 AK |
71 | </refsect1> |
72 | ||
396f9e2b JT |
73 | <xi:include href="standard-conf.xml" xpointer="confd" /> |
74 | <xi:include href="standard-conf.xml" xpointer="conf" /> | |
75 | ||
83fdc450 AK |
76 | <refsect1> |
77 | <title>Options</title> | |
78 | ||
79 | <variablelist class='bootchart-directives'> | |
80 | ||
81 | <varlistentry> | |
e57b4771 | 82 | <term><varname>Samples=500</varname></term> |
83fdc450 | 83 | <listitem><para>Configure the amount of samples to |
409dee2e | 84 | record in total before bootchart exits. Each sample will |
e57b4771 | 85 | record at intervals defined by Frequency=.</para></listitem> |
83fdc450 AK |
86 | </varlistentry> |
87 | ||
88 | <varlistentry> | |
e57b4771 | 89 | <term><varname>Frequency=25</varname></term> |
83fdc450 AK |
90 | <listitem><para>Configure the sample log frequency. |
91 | This can be a fractional number, but must be larger than | |
92 | 0.0. Most systems can cope with values under 25-50 without | |
93 | impacting boot time severely.</para></listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
e57b4771 | 97 | <term><varname>Relative=no</varname></term> |
83fdc450 | 98 | <listitem><para>Configures whether the left axis of the |
74d00578 | 99 | output graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant> start). This |
83fdc450 AK |
100 | is useful for using bootchart at post-boot time to profile |
101 | an already booted system, otherwise the graph would become | |
e57b4771 WG |
102 | extremely large. If set to yes, the horizontal axis starts |
103 | at the first recorded sample instead of time=0.0. | |
83fdc450 AK |
104 | </para></listitem> |
105 | </varlistentry> | |
106 | ||
107 | <varlistentry> | |
e57b4771 | 108 | <term><varname>Filter=no</varname></term> |
83fdc450 AK |
109 | <listitem><para>Configures whether the resulting graph |
110 | should omit tasks that did not contribute significantly | |
111 | to the boot. Processes that are too short-lived (only | |
112 | seen in one sample) or that do not consume any significant | |
113 | CPU time (less than 0.001sec) will not be displayed in | |
114 | the output graph.</para></listitem> | |
115 | </varlistentry> | |
116 | ||
117 | <varlistentry> | |
e57b4771 | 118 | <term><varname>Output=[path]</varname></term> |
409dee2e | 119 | <listitem><para>Configures the output directory for writing |
83fdc450 | 120 | the graphs. By default, bootchart writes the graphs to |
895aeb27 | 121 | <filename>/run/log</filename>.</para></listitem> |
83fdc450 AK |
122 | </varlistentry> |
123 | ||
124 | <varlistentry> | |
e57b4771 | 125 | <term><varname>Init=[path]</varname></term> |
83fdc450 | 126 | <listitem><para>Configures bootchart to run a non-standard |
6e1bf7ab | 127 | binary instead of <filename>/usr/lib/systemd/systemd</filename>. This |
83fdc450 AK |
128 | option is only relevant if bootchart was invoked from the |
129 | kernel command line with | |
130 | init=/usr/lib/systemd/systemd-bootchart.</para></listitem> | |
131 | </varlistentry> | |
132 | ||
133 | <varlistentry> | |
e57b4771 WG |
134 | <term><varname>PlotMemoryUsage=no</varname></term> |
135 | <listitem><para>If set to yes, enables logging and graphing | |
409dee2e | 136 | of processes' PSS memory consumption.</para></listitem> |
83fdc450 AK |
137 | </varlistentry> |
138 | ||
139 | <varlistentry> | |
e57b4771 WG |
140 | <term><varname>PlotEntropyGraph=no</varname></term> |
141 | <listitem><para>If set to yes, enables logging and graphing | |
83fdc450 AK |
142 | of the kernel random entropy pool size.</para></listitem> |
143 | </varlistentry> | |
144 | ||
145 | <varlistentry> | |
e57b4771 | 146 | <term><varname>ScaleX=100</varname></term> |
83fdc450 AK |
147 | <listitem><para>Horizontal scaling factor for all variable |
148 | graph components.</para></listitem> | |
149 | </varlistentry> | |
150 | ||
151 | <varlistentry> | |
e57b4771 | 152 | <term><varname>ScaleY=20</varname></term> |
83fdc450 AK |
153 | <listitem><para>Vertical scaling factor for all variable |
154 | graph components.</para></listitem> | |
155 | </varlistentry> | |
156 | ||
49e5b2a9 WC |
157 | <varlistentry> |
158 | <term><varname>ControlGroup=no</varname></term> | |
159 | <listitem><para>Display process control group.</para></listitem> | |
160 | </varlistentry> | |
161 | ||
83fdc450 AK |
162 | </variablelist> |
163 | </refsect1> | |
164 | ||
165 | <refsect1> | |
166 | <title>See Also</title> | |
167 | <para> | |
9cc2c8b7 ZJS |
168 | <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
169 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
83fdc450 AK |
170 | </para> |
171 | </refsect1> | |
172 | ||
173 | </refentry> |