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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amplot.8'>
13 <refentrytitle>amplot</refentrytitle>
14 <manvolnum>8</manvolnum>
17 <refname>amplot</refname>
18 <refpurpose>visualize the behavior of &A;</refpurpose>
20 <!-- body begins here -->
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>
37 <refsect1><title>DESCRIPTION</title>
38 <para><emphasis remap='B'>Amplot</emphasis>
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>
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>
53 <para><emphasis remap='B'>Amplot</emphasis>
54 is a shell script that executes an
55 <emphasis remap='B'>awk</emphasis>
57 <emphasis remap='I'></emphasis>(<emphasis remap='P->I'>amplot.awk</emphasis>)
59 <emphasis remap='B'>amdump</emphasis>
62 <emphasis remap='B'>gnuplot</emphasis>
64 <emphasis remap='I'></emphasis>(<emphasis remap='P->I'>amplot.g</emphasis>)
65 to generate the graph.
67 <emphasis remap='B'>awk</emphasis>
68 program is written in an enhanced version of 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>
74 <para>During execution,
75 <command>amplot</command>
76 generates a few temporary files that
77 <emphasis remap='B'>gnuplot</emphasis>
79 These files are deleted at the end of execution.</para>
82 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
83 man page for more details about &A;.</para>
86 <refsect1><title>OPTIONS</title>
87 <variablelist remap='TP'>
89 <term><option>-b</option></term>
91 <para>Generate b/w postscript file (need
92 <option>-p</option>).</para>
96 <term><option>-c</option></term>
99 <emphasis remap='I'>amdump_files</emphasis>
100 after plotting.</para>
104 <term><option>-e</option></term>
106 <para>Extend the X (time) axis if needed.</para>
110 <term><option>-g</option></term>
113 <emphasis remap='I'>gnuplot</emphasis>
114 output directly to the X11 display (default).</para>
118 <term><option>-p</option></term>
120 <para>Direct postscript output to file
121 <emphasis remap='B'></emphasis><emphasis remap='I'>YYYYMMDD</emphasis><emphasis remap='P->B'>.ps</emphasis>
123 <option>-g</option>).</para>
127 <term><option>-l</option></term>
129 <para>Generate landscape oriented output (needs
130 <option>-p</option>).</para>
134 <term><option>-t </option><emphasis remap='I'>T</emphasis></term>
136 <para>Set the right edge of the plot to be
137 <emphasis remap='I'>T</emphasis>
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>
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>
160 The Y axis is divided into 5 regions:</para>
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>
167 <para><emphasis remap='I'>%BANDWIDTH:</emphasis>
168 Percentage of allowed network bandwidth in use.</para>
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
176 The scale is percentage of the holding disk.</para>
178 <para><emphasis remap='I'>TAPE:</emphasis>
179 Tape drive usage.</para>
181 <para><emphasis remap='I'>%DUMPERS:</emphasis>
182 Percentage of active dumpers.</para>
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>
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>
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>
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"/>