bootchart.conf.xml 7.73 KB
Newer Older
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
<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!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 Intel Corporation

  Authors:
    Auke Kok <auke-jan.h.kok@intel.com>

  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="bootchart.conf" conditional='ENABLE_BOOTCHART'>
        <refentryinfo>
                <title>bootchart.conf</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Auke</firstname>
                                <surname>Kok</surname>
                                <email>auke-jan.h.kok@intel.com</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>bootchart.conf</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>bootchart.conf</refname>
                <refpurpose>Boot performance analysis graphing tool configuration file</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/etc/systemd/bootchart.conf</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>When starting, systemd-bootchart will read the
                configuration file <filename>bootchart.conf</filename>.
                This configuration file determines logging parameters and
                graph output.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <variablelist class='bootchart-directives'>

                        <varlistentry>
                                <term><varname>Samples=500</varname></term>
                                <listitem><para>Configure the amount of samples to
75
                                record in total before bootchart exits. Each sample will
76 77 78 79 80 81 82 83 84 85 86 87 88 89
                                record at intervals defined by Frequency=.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Frequency=25</varname></term>
                                <listitem><para>Configure the sample log frequency.
                                This can be a fractional number, but must be larger than
                                0.0. Most systems can cope with values under 25-50 without
                                impacting boot time severely.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Relative=no</varname></term>
                                <listitem><para>Configures whether the left axis of the
90
                                output graph equals time=0.0 (<constant>CLOCK_MONOTONIC</constant> start). This
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
                                is useful for using bootchart at post-boot time to profile
                                an already booted system, otherwise the graph would become
                                extremely large. If set to yes, the horizontal axis starts
                                at the first recorded sample instead of time=0.0.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Filter=no</varname></term>
                                <listitem><para>Configures whether the resulting graph
                                should omit tasks that did not contribute significantly
                                to the boot. Processes that are too short-lived (only
                                seen in one sample) or that do not consume any significant
                                CPU time (less than 0.001sec) will not be displayed in
                                the output graph.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Output=[path]</varname></term>
110
                                <listitem><para>Configures the output directory for writing
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
                                the graphs. By default, bootchart writes the graphs to
                                <filename>/run/log</filename>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Init=[path]</varname></term>
                                <listitem><para>Configures bootchart to run a non-standard
                                binary instead of <filename>/sbin/init</filename>. This
                                option is only relevant if bootchart was invoked from the
                                kernel command line with
                                init=/usr/lib/systemd/systemd-bootchart.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>PlotMemoryUsage=no</varname></term>
                                <listitem><para>If set to yes, enables logging and graphing
127
                                of processes' PSS memory consumption.</para></listitem>
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
                        </varlistentry>

                        <varlistentry>
                                <term><varname>PlotEntropyGraph=no</varname></term>
                                <listitem><para>If set to yes, enables logging and graphing
                                of the kernel random entropy pool size.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>ScaleX=100</varname></term>
                                <listitem><para>Horizontal scaling factor for all variable
                                graph components.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>ScaleY=20</varname></term>
                                <listitem><para>Vertical scaling factor for all variable
                                graph components.</para></listitem>
                        </varlistentry>

148 149 150 151 152
                        <varlistentry>
                                <term><varname>ControlGroup=no</varname></term>
                                <listitem><para>Display process control group.</para></listitem>
                        </varlistentry>

153 154 155 156 157 158 159 160 161 162 163 164
                </variablelist>
        </refsect1>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd-bootchart</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                  </para>
        </refsect1>

</refentry>