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 '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 Amanda</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 Amanda 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 <emphasis remap='B'>awk</emphasis>
  74 program is written in an enhanced version of awk,
  75 such as GNU awk (<manref name="gawk" vol="1" />
  76 version 2.15 or later) or <manref name="nawk" vol="1" />.</para>
  77
  78 <para>During execution,
  79 <command>amplot</command>
  80 generates a few temporary files that
  81 <emphasis remap='B'>gnuplot</emphasis>
  82 uses.
  83 These files are deleted at the end of execution.</para>
  84
  85 <para>See the
  86 <manref name="amanda" vol="8"/>
  87 man page for more details about Amanda.</para>
  88 </refsect1>
  89
  90 <refsect1><title>OPTIONS</title>
  91 <variablelist remap='TP'>
  92   <varlistentry>
  93   <term><option>-b</option></term>
  94   <listitem>
  95 <para>Generate b/w postscript file (need
  96 <option>-p</option>).</para>
  97   </listitem>
  98   </varlistentry>
  99   <varlistentry>
 100   <term><option>-c</option></term>
 101   <listitem>
 102 <para>Compress
 103 <emphasis remap='I'>amdump_files</emphasis>
 104 after plotting.</para>
 105   </listitem>
 106   </varlistentry>
 107   <varlistentry>
 108   <term><option>-e</option></term>
 109   <listitem>
 110 <para>Extend the X (time) axis if needed.</para>
 111   </listitem>
 112   </varlistentry>
 113   <varlistentry>
 114   <term><option>-g</option></term>
 115   <listitem>
 116 <para>Direct
 117 <emphasis remap='I'>gnuplot</emphasis>
 118 output directly to the X11 display (default).</para>
 119   </listitem>
 120   </varlistentry>
 121   <varlistentry>
 122   <term><option>-p</option></term>
 123   <listitem>
 124 <para>Direct postscript output to file
 125 <emphasis remap='B'></emphasis><emphasis remap='I'>YYYYMMDD</emphasis><emphasis remap='P->B'>.ps</emphasis>
 126 (opposite of
 127 <option>-g</option>).</para>
 128   </listitem>
 129   </varlistentry>
 130   <varlistentry>
 131   <term><option>-l</option></term>
 132   <listitem>
 133 <para>Generate landscape oriented output (needs
 134 <option>-p</option>).</para>
 135   </listitem>
 136   </varlistentry>
 137   <varlistentry>
 138   <term><option>-t </option><emphasis remap='I'>T</emphasis></term>
 139   <listitem>
 140 <para>Set the right edge of the plot to be
 141 <emphasis remap='I'>T</emphasis>
 142 hours.</para>
 143   </listitem>
 144   </varlistentry>
 145 </variablelist>
 146
 147 <para>The
 148 <emphasis remap='I'>amdump_files</emphasis>
 149 may be in various compressed formats
 150 (<emphasis remap='P->B'>compress</emphasis>,
 151 <emphasis remap='B'>gzip</emphasis>,
 152 <emphasis remap='B'>pact</emphasis>,
 153 <emphasis remap='B'>compact</emphasis>).</para>
 154 </refsect1>
 155
 156 <refsect1><title>INTERPRETATION</title>
 157 <para>The figure is divided into a number of regions.
 158 There are titles on the top that show important statistical information
 159 about the configuration and from this execution of
 160 <emphasis remap='B'>amdump</emphasis>.
 161 In the figure, the X axis is time, with 0 being the moment
 162 <emphasis remap='B'>amdump</emphasis>
 163 was started.
 164 The Y axis is divided into 5 regions:</para>
 165
 166 <para><emphasis remap='I'>QUEUES:</emphasis>
 167 How many backups have not been started,
 168 how many are waiting on space in the holding disk
 169 and how many have been transferred successfully to tape.</para>
 170
 171 <para><emphasis remap='I'>%BANDWIDTH:</emphasis>
 172 Percentage of allowed network bandwidth in use.</para>
 173
 174 <para><emphasis remap='I'>HOLDING DISK:</emphasis>
 175 The higher line depicts space allocated on the holding disk to
 176 backups in progress and completed backups waiting to be written to tape.
 177 The lower line depicts the fraction of the holding disk containing completed
 178 backups waiting to be written to tape including the file currently being
 179 written to tape.
 180 The scale is percentage of the holding disk.</para>
 181
 182 <para><emphasis remap='I'>TAPE:</emphasis>
 183 Tape drive usage.</para>
 184
 185 <para><emphasis remap='I'>%DUMPERS:</emphasis>
 186 Percentage of active dumpers.</para>
 187
 188 <para>The idle period at the left of the graph is time
 189 <emphasis remap='B'>amdump</emphasis>
 190 is asking the machines how much data they are going to dump.
 191 This process can take a while if hosts are down
 192 or it takes them a long time to generate estimates.</para>
 193 </refsect1>
 194
 195 <refsect1><title>BUGS</title>
 196 <para>Reports lines it does not recognize, mainly error cases but some are
 197 legitimate lines the program needs to be taught about.</para>
 198 </refsect1>
 199
 200 <seealso>
 201 <manref name="amdump" vol="8"/>,
 202 <manref name="gnuplot" vol="1"/>,
 203 <manref name="compress" vol="1"/>,
 204 <manref name="gzip" vol="1"/>
 205 </seealso>
 206
 207 </refentry>
 208