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