git.gag.com Git - debian/amanda/blob - man/xml-source/amplot.8.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
   4 [
   5   <!-- entities files to use -->
   6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
   7   %global_entities;
   8 ]>
   9
  10 <!-- lifted from troff+man by doclifter -->
  11 <refentry id='amplot.8'>
  12 <refmeta>
  13 <refentrytitle>amplot</refentrytitle>
  14 <manvolnum>8</manvolnum>
  15 &rmi.source;
  16 &rmi.version;
  17 &rmi.manual.8;
  18 </refmeta>
  19 <refnamediv>
  20 <refname>amplot</refname>
  21 <refpurpose>visualize the behavior of &A;</refpurpose>
  22 </refnamediv>
  23 <refentryinfo>
  24 &author.ogud;
  25 &author.sgw.xml;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28 <refsynopsisdiv>
  29 <cmdsynopsis>
  30   <command>amplot</command>
  31     <arg choice='opt'>-b </arg>
  32     <arg choice='opt'>-c </arg>
  33     <arg choice='opt'>-e </arg>
  34     <arg choice='opt'>-g </arg>
  35     <arg choice='opt'>-l </arg>
  36     <arg choice='opt'>-p </arg>
  37     <arg choice='opt'><arg choice='plain'>-t </arg><arg choice='plain'><replaceable>T</replaceable></arg></arg>
  38     <arg choice='plain'><replaceable>amdump_files</replaceable></arg>
  39     <sbr/>
  40 </cmdsynopsis>
  41 </refsynopsisdiv>
  42
  43
  44 <refsect1><title>DESCRIPTION</title>
  45 <para><emphasis remap='B'>Amplot</emphasis>
  46 reads an
  47 <emphasis remap='B'>amdump</emphasis>
  48 output file that &A; generates each run (e.g.
  49 <emphasis remap='I'>amdump.1</emphasis>)
  50 and translates the information into a
  51 picture format that may be used to determine how your installation
  52 is doing and if any parameters need to be changed.
  53 <emphasis remap='B'>Amplot</emphasis>
  54 also prints out
  55 <emphasis remap='B'>amdump</emphasis>
  56 lines that it either does not
  57 understand or knows to be warning or error lines
  58 and a summary of the start, end and total time for each backup image.</para>
  59
  60 <para><emphasis remap='B'>Amplot</emphasis>
  61 is a shell script that executes an
  62 <emphasis remap='B'>awk</emphasis>
  63 program
  64 <emphasis remap='I'></emphasis>(<emphasis remap='P->I'>amplot.awk</emphasis>)
  65 to scan the
  66 <emphasis remap='B'>amdump</emphasis>
  67 output file.
  68 It then executes a
  69 <emphasis remap='B'>gnuplot</emphasis>
  70 program
  71 <emphasis remap='I'></emphasis>(<emphasis remap='P->I'>amplot.g</emphasis>)
  72 to generate the graph.
  73 The
  74 <emphasis remap='B'>awk</emphasis>
  75 program is written in an enhanced version of awk,
  76 such as GNU awk
  77 <emphasis remap='B'></emphasis>(<emphasis remap='P->B'>gawk</emphasis>
  78 version 2.15 or later) or
  79 <emphasis remap='B'>nawk</emphasis>.</para>
  80
  81 <para>During execution,
  82 <command>amplot</command>
  83 generates a few temporary files that
  84 <emphasis remap='B'>gnuplot</emphasis>
  85 uses.
  86 These files are deleted at the end of execution.</para>
  87
  88 <para>See the
  89 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  90 man page for more details about &A;.</para>
  91 </refsect1>
  92
  93 <refsect1><title>OPTIONS</title>
  94 <variablelist remap='TP'>
  95   <varlistentry>
  96   <term><option>-b</option></term>
  97   <listitem>
  98 <para>Generate b/w postscript file (need
  99 <option>-p</option>).</para>
 100   </listitem>
 101   </varlistentry>
 102   <varlistentry>
 103   <term><option>-c</option></term>
 104   <listitem>
 105 <para>Compress
 106 <emphasis remap='I'>amdump_files</emphasis>
 107 after plotting.</para>
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term><option>-e</option></term>
 112   <listitem>
 113 <para>Extend the X (time) axis if needed.</para>
 114   </listitem>
 115   </varlistentry>
 116   <varlistentry>
 117   <term><option>-g</option></term>
 118   <listitem>
 119 <para>Direct
 120 <emphasis remap='I'>gnuplot</emphasis>
 121 output directly to the X11 display (default).</para>
 122   </listitem>
 123   </varlistentry>
 124   <varlistentry>
 125   <term><option>-p</option></term>
 126   <listitem>
 127 <para>Direct postscript output to file
 128 <emphasis remap='B'></emphasis><emphasis remap='I'>YYYYMMDD</emphasis><emphasis remap='P->B'>.ps</emphasis>
 129 (opposite of
 130 <option>-g</option>).</para>
 131   </listitem>
 132   </varlistentry>
 133   <varlistentry>
 134   <term><option>-l</option></term>
 135   <listitem>
 136 <para>Generate landscape oriented output (needs
 137 <option>-p</option>).</para>
 138   </listitem>
 139   </varlistentry>
 140   <varlistentry>
 141   <term><option>-t </option><emphasis remap='I'>T</emphasis></term>
 142   <listitem>
 143 <para>Set the right edge of the plot to be
 144 <emphasis remap='I'>T</emphasis>
 145 hours.</para>
 146   </listitem>
 147   </varlistentry>
 148 </variablelist>
 149
 150 <para>The
 151 <emphasis remap='I'>amdump_files</emphasis>
 152 may be in various compressed formats
 153 <emphasis remap='B'></emphasis>(<emphasis remap='P->B'>compress</emphasis>,
 154 <emphasis remap='B'>gzip</emphasis>,
 155 <emphasis remap='B'>pact</emphasis>,
 156 <emphasis remap='B'>compact</emphasis>).</para>
 157 </refsect1>
 158
 159 <refsect1><title>INTERPRETATION</title>
 160 <para>The figure is divided into a number of regions.
 161 There are titles on the top that show important statistical information
 162 about the configuration and from this execution of
 163 <emphasis remap='B'>amdump</emphasis>.
 164 In the figure, the X axis is time, with 0 being the moment
 165 <emphasis remap='B'>amdump</emphasis>
 166 was started.
 167 The Y axis is divided into 5 regions:</para>
 168
 169 <para><emphasis remap='I'>QUEUES:</emphasis>
 170 How many backups have not been started,
 171 how many are waiting on space in the holding disk
 172 and how many have been transferred successfully to tape.</para>
 173
 174 <para><emphasis remap='I'>%BANDWIDTH:</emphasis>
 175 Percentage of allowed network bandwidth in use.</para>
 176
 177 <para><emphasis remap='I'>HOLDING DISK:</emphasis>
 178 The higher line depicts space allocated on the holding disk to
 179 backups in progress and completed backups waiting to be written to tape.
 180 The lower line depicts the fraction of the holding disk containing completed
 181 backups waiting to be written to tape including the file currently being
 182 written to tape.
 183 The scale is percentage of the holding disk.</para>
 184
 185 <para><emphasis remap='I'>TAPE:</emphasis>
 186 Tape drive usage.</para>
 187
 188 <para><emphasis remap='I'>%DUMPERS:</emphasis>
 189 Percentage of active dumpers.</para>
 190
 191 <para>The idle period at the left of the graph is time
 192 <emphasis remap='B'>amdump</emphasis>
 193 is asking the machines how much data they are going to dump.
 194 This process can take a while if hosts are down
 195 or it takes them a long time to generate estimates.</para>
 196 </refsect1>
 197
 198 <refsect1><title>BUGS</title>
 199 <para>Reports lines it does not recognize, mainly error cases but some are
 200 legitimate lines the program needs to be taught about.</para>
 201 </refsect1>
 202
 203 <refsect1><title>SEE ALSO</title>
 204 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 205 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 206 <citerefentry><refentrytitle>gawk</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 207 <citerefentry><refentrytitle>nawk</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 208 <citerefentry><refentrytitle>awk</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 209 <citerefentry><refentrytitle>gnuplot</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 210 <citerefentry><refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 211 <citerefentry><refentrytitle>compress</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 212 <citerefentry><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 213 <ulink url="http://wiki.zmanda.com"/>
 214 </para>
 215 </refsect1>
 216 </refentry>
 217