summaryrefslogtreecommitdiffstats
path: root/man/systemd-analyze.xml
blob: 073e807b416097b2adc4d005530dc14086d4187c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2012 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd-analyze"
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>systemd-analyze</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Harald</firstname>
                                <surname>Hoyer</surname>
                                <email>harald@redhat.com</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd-analyze</refentrytitle>
                <manvolnum>1</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-analyze</refname>
                <refpurpose>Analyze system boot-up performance</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg>time</arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">blame</arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">critical-chain</arg>
                        <arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">plot</arg>
                        <arg choice="opt">&gt; file.svg</arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">dot</arg>
                        <arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
                        <arg choice="opt">&gt; file.dot</arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">dump</arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">set-log-level</arg>
                        <arg choice="opt"><replaceable>LEVEL</replaceable></arg>
                </cmdsynopsis>
                <cmdsynopsis>
                        <command>systemd-analyze</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="plain">verify</arg>
                        <arg choice="opt" rep="repeat"><replaceable>FILES</replaceable></arg>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>systemd-analyze</command> may be used
                to determine system boot-up performance statistics and
                retrieve other state and tracing information from the
                system and service manager, and to verify the
                correctness of unit files.</para>

                <para><command>systemd-analyze time</command>
                prints the time spent in the kernel before
                userspace has been reached, the time spent in the
                initial RAM disk (initrd) before normal system
                userspace has been reached, and the time normal system
                userspace took to initialize. Note that these
                measurements simply measure the time passed up to the
                point where all system services have been spawned, but
                not necessarily until they fully finished
                initialization or the disk is idle.</para>

                <para><command>systemd-analyze blame</command> prints
                a list of all running units, ordered by the time they
                took to initialize. This information may be used to
                optimize boot-up times. Note that the output might be
                misleading as the initialization of one service might
                be slow simply because it waits for the initialization
                of another service to complete.</para>

                <para><command>systemd-analyze critical-chain [<replaceable>UNIT...</replaceable>]</command>
                prints a tree of the time-critical chain of units
                (for each of the specified <replaceable>UNIT</replaceable>s
                or for the default target otherwise).
                The time after the unit is active or started is printed
                after the "@" character. The time the unit takes to
                start is printed after the "+" character.
                Note that the output might be misleading as the
                initialization of one service might depend on socket
                activation and because of the parallel execution
                of units.</para>

                <para><command>systemd-analyze plot</command> prints
                an SVG graphic detailing which system services have
                been started at what time, highlighting the time they
                spent on initialization.</para>

                <para><command>systemd-analyze dot</command> generates
                textual dependency graph description in dot format for
                further processing with the GraphViz
                <citerefentry><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                tool. Use a command line like <command>systemd-analyze
                dot | dot -Tsvg > systemd.svg</command> to generate a
                graphical dependency tree. Unless
                <option>--order</option> or <option>--require</option>
                is passed, the generated graph will show both ordering
                and requirement dependencies. Optional pattern
                globbing style specifications
                (e.g. <filename>*.target</filename>) may be given at
                the end. A unit dependency is included in the graph if
                any of these patterns match either the origin or
                destination node.</para>

                <para><command>systemd-analyze dump</command> outputs
                a (usually very long) human-readable serialization of
                the complete server state. Its format is subject to
                change without notice and should not be parsed by
                applications.</para>

                <para><command>systemd-analyze set-log-level
                <replaceable>LEVEL</replaceable></command> changes the
                current log level of the <command>systemd</command>
                daemon to <replaceable>LEVEL</replaceable> (accepts
                the same values as <option>--log-level=</option>
                described in
                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>).</para>

                <para><command>systemd-analyze verify</command> will
                load unit files and print warnings if any errors are
                detected. Files specified on the command line will be
                loaded, but also any other units referenced by
                them. This command works by prepending the directories
                for all command line arguments at the beginning of the
                unit load path, which means that all units files found
                in those directories will be used in preference to the
                unit files found in the standard locations, even if
                not listed explicitly.</para>

                <para>If no command is passed, <command>systemd-analyze
                time</command> is implied.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>--user</option></term>

                                <listitem><para>Operates on the user
                                systemd instance.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--system</option></term>

                                <listitem><para>Operates on the system
                                systemd instance. This is the implied
                                default.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--order</option></term>
                                <term><option>--require</option></term>

                                <listitem><para>When used in
                                conjunction with the
                                <command>dot</command> command (see
                                above), selects which dependencies are
                                shown in the dependency graph. If
                                <option>--order</option> is passed,
                                only dependencies of type
                                <varname>After=</varname> or
                                <varname>Before=</varname> are
                                shown. If <option>--require</option>
                                is passed, only dependencies of type
                                <varname>Requires=</varname>,
                                <varname>RequiresOverridable=</varname>,
                                <varname>Requisite=</varname>,
                                <varname>RequisiteOverridable=</varname>,
                                <varname>Wants=</varname> and
                                <varname>Conflicts=</varname> are
                                shown. If neither is passed, this shows
                                dependencies of all these
                                types.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--from-pattern=</option></term>
                                <term><option>--to-pattern=</option></term>

                                <listitem><para>When used in
                                conjunction with the
                                <command>dot</command> command (see
                                above), this selects which relationships
                                are shown in the dependency graph.
                                They both require
                                <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                patterns as arguments, which are
                                matched against left-hand and
                                right-hand, respectively, nodes of a
                                relationship. Each of these can be
                                used more than once, which means a
                                unit name must match one of the given
                                values.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--fuzz=</option><replaceable>timespan</replaceable></term>

                                <listitem><para>When used in conjunction
                                with the <command>critical-chain</command>
                                command (see above), also show units, which
                                finished <replaceable>timespan</replaceable> earlier, than the
                                latest unit in the same level. The unit of
                                <replaceable>timespan</replaceable> is seconds
                                unless specified with a different unit,
                                e.g. "50ms".</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-man</option></term>

                                <listitem><para>Do not invoke man to verify the existence
                                of man pages listen in <varname>Documentation=</varname>.
                                </para></listitem>
                        </varlistentry>

                        <xi:include href="user-system-options.xml" xpointer="host" />
                        <xi:include href="user-system-options.xml" xpointer="machine" />

                        <xi:include href="standard-options.xml" xpointer="help" />
                        <xi:include href="standard-options.xml" xpointer="version" />
                        <xi:include href="standard-options.xml" xpointer="no-pager" />
                </variablelist>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success, 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <refsect1>
                <title>Examples for <command>dot</command></title>

                <example>
                        <title>Plots all dependencies of any unit whose
                        name starts with <literal>avahi-daemon</literal></title>

                        <programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg > avahi.svg
                        $ eog avahi.svg</programlisting>
                </example>

                <example>
                        <title>Plots the dependencies between all known target units</title>

                        <programlisting>systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' | dot -Tsvg > targets.svg
$ eog targets.svg</programlisting>
                </example>
        </refsect1>

        <refsect1>
                <title>Examples for <command>verify</command></title>

                <para>The following errors are currently detected:</para>
                <itemizedlist>
                        <listitem><para>unknown sections and
                        directives, </para></listitem>

                        <listitem><para>missing dependencies which are
                        required to start the given unit,
                        </para></listitem>

                        <listitem><para>man pages listed in
                        <varname>Documentation=</varname> which are
                        not found in the system,</para></listitem>

                        <listitem><para>commands listed in
                        <varname>ExecStart=</varname> and similar
                        which are not found in the system or not
                        executable.</para></listitem>
                </itemizedlist>

                <example>
                        <title>Misspelt directives</title>

                        <programlisting>$ cat ./user.slice
[Unit]
WhatIsThis=11
Documentation=man:nosuchfile(1)
Requires=different.service

[Service]
Desription=x

$ systemd-verify ./user.slice
[./user.slice:9] Unknown lvalue 'WhatIsThis' in section 'Unit'
[./user.slice:13] Unknown section 'Service'. Ignoring.
Error: org.freedesktop.systemd1.LoadFailed:
         Unit different.service failed to load:
         No such file or directory.
Failed to create user.slice/start: Invalid argument
user.slice: man nosuchfile(1) command failed with code 16
                        </programlisting>
                </example>

                <example>
                        <title>Missing service units</title>

                        <programlisting>$ tail ./a.socket ./b.socket
==> ./a.socket &lt;==
[Socket]
ListenStream=100

==> ./b.socket &lt;==
[Socket]
ListenStream=100
Accept=yes

$ systemd-verify ./a.socket ./b.socket
Service a.service not loaded, a.socket cannot be started.
Service b@0.service not loaded, b.socket cannot be started.
                        </programlisting>
                </example>
        </refsect1>

        <xi:include href="less-variables.xml" />

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>