]>
Commit | Line | Data |
---|---|---|
83fdc450 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
83fdc450 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
681eb9cf FB |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > | |
5 | %entities; | |
6 | ]> | |
83fdc450 AK |
7 | |
8 | <!-- | |
9 | This file is part of systemd. | |
10 | ||
11 | Copyright 2012 Intel Corporation | |
12 | ||
13 | Authors: | |
14 | Auke Kok <auke-jan.h.kok@intel.com> | |
15 | ||
16 | systemd is free software; you can redistribute it and/or modify it | |
17 | under the terms of the GNU Lesser General Public License as published by | |
18 | the Free Software Foundation; either version 2.1 of the License, or | |
19 | (at your option) any later version. | |
20 | ||
21 | systemd is distributed in the hope that it will be useful, but | |
22 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
24 | Lesser General Public License for more details. | |
25 | ||
26 | You should have received a copy of the GNU Lesser General Public License | |
27 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
28 | --> | |
29 | ||
396f9e2b | 30 | <refentry id="bootchart.conf" conditional='ENABLE_BOOTCHART' |
798d3a52 ZJS |
31 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
32 | <refentryinfo> | |
33 | <title>bootchart.conf</title> | |
34 | <productname>systemd</productname> | |
35 | ||
36 | <authorgroup> | |
37 | <author> | |
38 | <contrib>Developer</contrib> | |
39 | <firstname>Auke</firstname> | |
40 | <surname>Kok</surname> | |
41 | <email>auke-jan.h.kok@intel.com</email> | |
42 | </author> | |
43 | </authorgroup> | |
44 | </refentryinfo> | |
45 | ||
46 | <refmeta> | |
47 | <refentrytitle>bootchart.conf</refentrytitle> | |
48 | <manvolnum>5</manvolnum> | |
49 | </refmeta> | |
50 | ||
51 | <refnamediv> | |
52 | <refname>bootchart.conf</refname> | |
53 | <refname>bootchart.conf.d</refname> | |
54 | <refpurpose>Boot performance analysis graphing tool configuration files</refpurpose> | |
55 | </refnamediv> | |
56 | ||
57 | <refsynopsisdiv> | |
681eb9cf FB |
58 | <para><filename>&pkgsysconfdir;/bootchart.conf</filename></para> |
59 | <para><filename>&pkgsysconfdir;/bootchart.conf.d/*.conf</filename></para> | |
798d3a52 | 60 | <para><filename>/run/systemd/bootchart.conf.d/*.conf</filename></para> |
681eb9cf | 61 | <para><filename>&rootlibexecdir;/bootchart.conf.d/*.conf</filename></para> |
798d3a52 ZJS |
62 | </refsynopsisdiv> |
63 | ||
64 | <refsect1> | |
65 | <title>Description</title> | |
66 | ||
67 | <para>When starting, systemd-bootchart will read the configuration | |
681eb9cf | 68 | file <filename>&pkgsysconfdir;/bootchart.conf</filename>, followed by |
798d3a52 ZJS |
69 | the files in the <filename>bootchart.conf.d</filename> |
70 | directories. These configuration files determine logging | |
71 | parameters and graph output.</para> | |
72 | </refsect1> | |
73 | ||
e93549ef | 74 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> |
798d3a52 ZJS |
75 | |
76 | <refsect1> | |
77 | <title>Options</title> | |
78 | ||
79 | <variablelist class='bootchart-directives'> | |
80 | ||
81 | <varlistentry> | |
82 | <term><varname>Samples=500</varname></term> | |
83 | <listitem><para>Configure the amount of samples to record in | |
84 | total before bootchart exits. Each sample will record at | |
85 | intervals defined by Frequency=.</para></listitem> | |
86 | </varlistentry> | |
87 | ||
88 | <varlistentry> | |
89 | <term><varname>Frequency=25</varname></term> | |
90 | <listitem><para>Configure the sample log frequency. This can | |
91 | be a fractional number, but must be larger than 0.0. Most | |
92 | systems can cope with values under 25-50 without impacting | |
93 | boot time severely.</para></listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
97 | <term><varname>Relative=no</varname></term> | |
98 | <listitem><para>Configures whether the left axis of the output | |
99 | graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant> | |
100 | start). This is useful for using bootchart at post-boot time | |
101 | to profile an already booted system, otherwise the graph would | |
102 | become extremely large. If set to yes, the horizontal axis | |
103 | starts at the first recorded sample instead of time=0.0. | |
104 | </para></listitem> | |
105 | </varlistentry> | |
106 | ||
107 | <varlistentry> | |
108 | <term><varname>Filter=no</varname></term> | |
109 | <listitem><para>Configures whether the resulting graph should | |
110 | omit tasks that did not contribute significantly to the boot. | |
111 | Processes that are too short-lived (only seen in one sample) | |
112 | or that do not consume any significant CPU time (less than | |
113 | 0.001sec) will not be displayed in the output | |
114 | graph.</para></listitem> | |
115 | </varlistentry> | |
116 | ||
117 | <varlistentry> | |
118 | <term><varname>Output=[path]</varname></term> | |
119 | <listitem><para>Configures the output directory for writing | |
120 | the graphs. By default, bootchart writes the graphs to | |
121 | <filename>/run/log</filename>.</para></listitem> | |
122 | </varlistentry> | |
123 | ||
124 | <varlistentry> | |
125 | <term><varname>Init=[path]</varname></term> | |
126 | <listitem><para>Configures bootchart to run a non-standard | |
127 | binary instead of | |
681eb9cf | 128 | <filename>&rootlibexecdir;/systemd</filename>. This option is |
798d3a52 ZJS |
129 | only relevant if bootchart was invoked from the kernel command |
130 | line with | |
681eb9cf | 131 | init=&rootlibexecdir;/systemd-bootchart.</para></listitem> |
798d3a52 ZJS |
132 | </varlistentry> |
133 | ||
134 | <varlistentry> | |
135 | <term><varname>PlotMemoryUsage=no</varname></term> | |
136 | <listitem><para>If set to yes, enables logging and graphing of | |
137 | processes' PSS memory consumption.</para></listitem> | |
138 | </varlistentry> | |
139 | ||
140 | <varlistentry> | |
141 | <term><varname>PlotEntropyGraph=no</varname></term> | |
142 | <listitem><para>If set to yes, enables logging and graphing of | |
143 | the kernel random entropy pool size.</para></listitem> | |
144 | </varlistentry> | |
145 | ||
146 | <varlistentry> | |
147 | <term><varname>ScaleX=100</varname></term> | |
148 | <listitem><para>Horizontal scaling factor for all variable | |
149 | graph components.</para></listitem> | |
150 | </varlistentry> | |
151 | ||
152 | <varlistentry> | |
153 | <term><varname>ScaleY=20</varname></term> | |
154 | <listitem><para>Vertical scaling factor for all variable graph | |
155 | components.</para></listitem> | |
156 | </varlistentry> | |
157 | ||
158 | <varlistentry> | |
159 | <term><varname>ControlGroup=no</varname></term> | |
160 | <listitem><para>Display process control group. | |
161 | </para></listitem> | |
162 | </varlistentry> | |
163 | ||
164 | </variablelist> | |
165 | </refsect1> | |
166 | ||
167 | <refsect1> | |
168 | <title>See Also</title> | |
169 | <para> | |
170 | <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
171 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
172 | </para> | |
173 | </refsect1> | |
83fdc450 AK |
174 | |
175 | </refentry> |