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 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="systemd-analyze">
27 <title>systemd-analyze</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
38 <contrib>Developer</contrib>
39 <firstname>Harald</firstname>
40 <surname>Hoyer</surname>
41 <email>harald@redhat.com</email>
47 <refentrytitle>systemd-analyze</refentrytitle>
48 <manvolnum>1</manvolnum>
52 <refname>systemd-analyze</refname>
53 <refpurpose>Analyze system boot-up performance</refpurpose>
58 <command>systemd-analyze</command>
59 <arg choice="opt" rep="repeat">OPTIONS</arg>
63 <command>systemd-analyze</command>
64 <arg choice="opt" rep="repeat">OPTIONS</arg>
65 <arg choice="plain">blame</arg>
68 <command>systemd-analyze</command>
69 <arg choice="opt" rep="repeat">OPTIONS</arg>
70 <arg choice="plain">critical-chain</arg>
71 <arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
74 <command>systemd-analyze</command>
75 <arg choice="opt" rep="repeat">OPTIONS</arg>
76 <arg choice="plain">plot</arg>
77 <arg choice="opt">> file.svg</arg>
80 <command>systemd-analyze</command>
81 <arg choice="opt" rep="repeat">OPTIONS</arg>
82 <arg choice="plain">dot</arg>
83 <arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
84 <arg choice="opt">> file.dot</arg>
87 <command>systemd-analyze</command>
88 <arg choice="opt" rep="repeat">OPTIONS</arg>
89 <arg choice="plain">dump</arg>
92 <command>systemd-analyze</command>
93 <arg choice="opt" rep="repeat">OPTIONS</arg>
94 <arg choice="plain">set-log-level</arg>
95 <arg choice="opt"><replaceable>LEVEL</replaceable></arg>
100 <title>Description</title>
102 <para><command>systemd-analyze</command> may be used
103 to determine system boot-up performance statistics and
104 retrieve other state and tracing information from the
105 system and service manager.</para>
107 <para><command>systemd-analyze time</command>
108 prints the time spent in the kernel before
109 userspace has been reached, the time spent in the
110 initial RAM disk (initrd) before normal system
111 userspace has been reached, and the time normal system
112 userspace took to initialize. Note that these
113 measurements simply measure the time passed up to the
114 point where all system services have been spawned, but
115 not necessarily until they fully finished
116 initialization or the disk is idle.</para>
118 <para><command>systemd-analyze blame</command> prints
119 a list of all running units, ordered by the time they
120 took to initialize. This information may be used to
121 optimize boot-up times. Note that the output might be
122 misleading as the initialization of one service might
123 be slow simply because it waits for the initialization
124 of another service to complete.</para>
126 <para><command>systemd-analyze critical-chain [<replaceable>UNIT...</replaceable>]</command>
127 prints a tree of the time-critical chain of units
128 (for each of the specified <replaceable>UNIT</replaceable>s
129 or for the default target otherwise).
130 The time after the unit is active or started is printed
131 after the "@" character. The time the unit takes to
132 start is printed after the "+" character.
133 Note that the output might be misleading as the
134 initialization of one service might depend on socket
135 activation and because of the parallel execution
138 <para><command>systemd-analyze plot</command> prints
139 an SVG graphic detailing which system services have
140 been started at what time, highlighting the time they
141 spent on initialization.</para>
143 <para><command>systemd-analyze dot</command> generates
144 textual dependency graph description in dot format for
145 further processing with the GraphViz
146 <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
147 tool. Use a command line like <command>systemd-analyze
148 dot | dot -Tsvg > systemd.svg</command> to generate a
149 graphical dependency tree. Unless
150 <option>--order</option> or <option>--require</option>
151 is passed, the generated graph will show both ordering
152 and requirement dependencies. Optional pattern
153 globbing style specifications
154 (e.g. <filename>*.target</filename>) may be given at
155 the end. A unit dependency is included in the graph if
156 any of these patterns match either the origin or
157 destination node.</para>
159 <para><command>systemd-analyze dump</command> outputs
160 a (usually very long) human-readable serialization of
161 the complete server state. Its format is subject to
162 change without notice and should not be parsed by
165 <para><command>systemd-analyze set-log-level
166 <replaceable>LEVEL</replaceable></command> changes the
167 current log level of the <command>systemd</command>
168 daemon to <replaceable>LEVEL</replaceable> (accepts
169 the same values as <option>--log-level=</option>
171 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).</para>
173 <para>If no command is passed, <command>systemd-analyze
174 time</command> is implied.</para>
179 <title>Options</title>
181 <para>The following options are understood:</para>
185 <term><option>-h</option></term>
186 <term><option>--help</option></term>
188 <listitem><para>Prints a short help
189 text and exits.</para></listitem>
193 <term><option>--user</option></term>
195 <listitem><para>Shows performance data
196 of user sessions instead of the system
197 manager.</para></listitem>
201 <term><option>--order</option></term>
202 <term><option>--require</option></term>
204 <listitem><para>When used in
206 <command>dot</command> command (see
207 above), selects which dependencies are
208 shown in the dependency graph. If
209 <option>--order</option> is passed,
210 only dependencies of type
211 <varname>After=</varname> or
212 <varname>Before=</varname> are
213 shown. If <option>--require</option>
214 is passed, only dependencies of type
215 <varname>Requires=</varname>,
216 <varname>RequiresOverridable=</varname>,
217 <varname>Requisite=</varname>,
218 <varname>RequisiteOverridable=</varname>,
219 <varname>Wants=</varname> and
220 <varname>Conflicts=</varname> are
221 shown. If neither is passed, this shows
222 dependencies of all these
223 types.</para></listitem>
227 <term><option>--from-pattern=</option></term>
228 <term><option>--to-pattern=</option></term>
230 <listitem><para>When used in
232 <command>dot</command> command (see
233 above), this selects which relationships
234 are shown in the dependency graph.
236 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
237 patterns as arguments, which are
238 matched against left-hand and
239 right-hand, respectively, nodes of a
240 relationship. Each of these can be
241 used more than once, which means a
242 unit name must match one of the given
243 values.</para></listitem>
247 <term><option>--fuzz=</option><replaceable>timespan</replaceable></term>
249 <listitem><para>When used in conjunction
250 with the <command>critical-chain</command>
251 command (see above), also show units, which
252 finished <replaceable>timespan</replaceable> earlier, than the
253 latest unit in the same level. The unit of
254 <replaceable>timespan</replaceable> is seconds
255 unless specified with a different unit,
256 e.g. "50ms".</para></listitem>
260 <term><option>--no-pager</option></term>
263 <para>Do not pipe output into a pager.</para>
271 <title>Exit status</title>
273 <para>On success 0 is returned, a non-zero failure
274 code otherwise.</para>
278 <title>Examples</title>
280 <para>This plots all dependencies of any unit whose
281 name starts with <literal>avahi-daemon.</literal>:</para>
283 <programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg > avahi.svg
284 $ eog avahi.svg</programlisting>
286 <para>This plots the dependencies between all known target units:</para>
288 <programlisting>systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' | dot -Tsvg > targets.svg
289 $ eog targets.svg</programlisting>
295 <title>Environment</title>
297 <variablelist class='environment-variables'>
299 <term><varname>$SYSTEMD_PAGER</varname></term>
302 <para>Pager to use when <option>--no-pager</option> is not
303 given; overrides <varname>$PAGER</varname>. Setting this to
304 an empty string or the value <literal>cat</literal> is
305 equivalent to passing
306 <option>--no-pager</option>.</para>
313 <title>See Also</title>
315 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
316 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>