man/bootchart.conf.xml

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