systemd-analyze.xml revision 21ac6ff143cc8bebfbd1818af28e8c6f82cd5265
3802a3d3d7af51ddff31943d5514382f01265770Lennart Poettering<?xml version='1.0'?> <!--*-nxml-*-->
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek<!--
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek This file is part of systemd.
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek Copyright 2012 Lennart Poettering
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek systemd is free software; you can redistribute it and/or modify it
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek under the terms of the GNU Lesser General Public License as published by
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek the Free Software Foundation; either version 2.1 of the License, or
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek (at your option) any later version.
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek systemd is distributed in the hope that it will be useful, but
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek WITHOUT ANY WARRANTY; without even the implied warranty of
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek Lesser General Public License for more details.
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek You should have received a copy of the GNU Lesser General Public License
5de0ccffcc4a5a946102a14e0b0e681d964e3225Zbigniew Jędrzejewski-Szmek along with systemd; If not, see <http://www.gnu.org/licenses/>.
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek-->
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek<refentry id="systemd-analyze"
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek xmlns:xi="http://www.w3.org/2001/XInclude">
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refentryinfo>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <title>systemd-analyze</title>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <productname>systemd</productname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <authorgroup>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <author>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <contrib>Developer</contrib>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <firstname>Lennart</firstname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <surname>Poettering</surname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <email>lennart@poettering.net</email>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </author>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <author>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <contrib>Developer</contrib>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <firstname>Harald</firstname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <surname>Hoyer</surname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <email>harald@redhat.com</email>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </author>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </authorgroup>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </refentryinfo>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refmeta>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refentrytitle>systemd-analyze</refentrytitle>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <manvolnum>1</manvolnum>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </refmeta>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refnamediv>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refname>systemd-analyze</refname>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refpurpose>Analyze system boot-up performance</refpurpose>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </refnamediv>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <refsynopsisdiv>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <cmdsynopsis>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <command>systemd-analyze</command>
fbce11397f4d19821a9dfe66ee3ebe11cad90057Jan Engelhardt <arg choice="opt" rep="repeat">OPTIONS</arg>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <arg>time</arg>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering </cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <cmdsynopsis>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <command>systemd-analyze</command>
847ae0ae7f29e7bfb245d692409fc2948eab7d1dLennart Poettering <arg choice="opt" rep="repeat">OPTIONS</arg>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <arg choice="plain">blame</arg>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering </cmdsynopsis>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <cmdsynopsis>
9365b048c0c9f62ef7f696216ba049e6b4c2f2e5Lennart Poettering <command>systemd-analyze</command>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt" rep="repeat">OPTIONS</arg>
ea021cc3ea7082786e764734bb344eebbd6f2caaLennart Poettering <arg choice="plain">critical-chain</arg>
ea021cc3ea7082786e764734bb344eebbd6f2caaLennart Poettering <arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
72f4d9669c253d5bd7c126bf2e7a0db0198cf2ebJan Engelhardt </cmdsynopsis>
ea021cc3ea7082786e764734bb344eebbd6f2caaLennart Poettering <cmdsynopsis>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <command>systemd-analyze</command>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <arg choice="opt" rep="repeat">OPTIONS</arg>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <arg choice="plain">plot</arg>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <arg choice="opt">&gt; file.svg</arg>
ea021cc3ea7082786e764734bb344eebbd6f2caaLennart Poettering </cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <command>systemd-analyze</command>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt" rep="repeat">OPTIONS</arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="plain">dot</arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt">&gt; file.dot</arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <command>systemd-analyze</command>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <arg choice="opt" rep="repeat">OPTIONS</arg>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <arg choice="plain">dump</arg>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering </cmdsynopsis>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <cmdsynopsis>
c129bd5df3ca08eb352cf69d01d2f374552624aeLennart Poettering <command>systemd-analyze</command>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt" rep="repeat">OPTIONS</arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="plain">set-log-level</arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <arg choice="opt"><replaceable>LEVEL</replaceable></arg>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </cmdsynopsis>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek </refsynopsisdiv>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <refsect1>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <title>Description</title>
3fde5f30bda2a70d97f3dc8fa918e42e1c07cc2cLennart Poettering
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <para><command>systemd-analyze</command> may be used
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek to determine system boot-up performance statistics and
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek retrieve other state and tracing information from the
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek system and service manager.</para>
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek
d868475ad62547f0a034dfaf038aff31b3d05372Zbigniew Jędrzejewski-Szmek <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>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>-h</option></term>
<term><option>--help</option></term>
<listitem><para>Prints a short help
text and exits.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--user</option></term>
<listitem><para>Shows performance data
of user sessions instead of the system
manager.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option></term>
<listitem><para>Shows performance data
of the system manager. This is the
implied default.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-H</option></term>
<term><option>--host=</option></term>
<listitem><para>Execute the operation
remotely. Specify a hostname, or
username and hostname separated by
<literal>@</literal>, to connect
to. This will use SSH to talk to the
remote machine manager
instance.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-M</option></term>
<term><option>--machine=</option></term>
<listitem><para>Execute the operation on a
local container. Specify a container
name to connect to.</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-pager</option></term>
<listitem>
<para>Do not pipe output into a pager.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<para>This plots all dependencies of any unit whose
name starts with <literal>avahi-daemon.</literal>:</para>
<programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg > avahi.svg
$ eog avahi.svg</programlisting>
<para>This plots the dependencies between all known target units:</para>
<programlisting>systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' | dot -Tsvg > targets.svg
$ eog targets.svg</programlisting>
</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>