man/bootchart.conf.xml

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