Imported Upstream version 2.4.4p3
[debian/amanda] / man / amplot.8
1 .TH AMPLOT 8
2 .UC 4
3 .SH NAME
4 amplot \- visualize the behavior of Amanda
5 .SH SYNOPSIS
6 .B amplot
7 [
8 .B -b
9 ]
10 [
11 .B -c
12 ]
13 [
14 .B -e
15 ]
16 [
17 .B -g
18 ]
19 [
20 .B -l
21 ]
22 [
23 .B -p
24 ]
25 [
26 .B -t
27 .I T
28 ]
29 .I amdump_files
30 .br
31 .SH DESCRIPTION
32 .B Amplot
33 reads an
34 .B amdump
35 output file that Amanda generates each run (e.g.
36 .IR amdump.1 )
37 and translates the information into a
38 picture format that may be used to determine how your installation
39 is doing and if any parameters need to be changed.
40 .B Amplot
41 also prints out
42 .B amdump
43 lines that it either does not
44 understand or knows to be warning or error lines
45 and a summary of the start, end and total time for each backup image.
46 .LP
47 .B Amplot
48 is a shell script that executes an
49 .B awk
50 program
51 .IR \fR(\fPamplot.awk )
52 to scan the
53 .B amdump
54 output file.
55 It then executes a
56 .B gnuplot
57 program
58 .IR \fR(\fPamplot.g )
59 to generate the graph.
60 The
61 .B awk
62 program is written in an enhanced version of awk,
63 such as GNU awk
64 .B \fR(\fPgawk
65 version 2.15 or later) or
66 .BR nawk .
67 .LP
68 During execution,
69 .B amplot
70 generates a few temporary files that
71 .B gnuplot
72 uses.
73 These files are deleted at the end of execution.
74 .LP
75 See the
76 .IR amanda (8)
77 man page for more details about Amanda.
78 .SH OPTIONS
79 .TP
80 .B -b
81 Generate b/w postscript file (need
82 .BR -p ).
83 .TP
84 .B -c
85 Compress
86 .I amdump_files
87 after plotting.
88 .TP
89 .B -e
90 Extend the X (time) axis if needed.
91 .TP
92 .B -g
93 Direct
94 .I gnuplot
95 output directly to the X11 display (default).
96 .TP
97 .B -p
98 Direct postscript output to file
99 .B \fIYYYYMMDD\fP.ps
100 (opposite of
101 .BR -g ).
102 .TP
103 .B -l
104 Generate landscape oriented output (need
105 .BR -p ).
106 .TP
107 .B "-t \fIT\fR"
108 Set the right edge of the plot to be
109 .I T
110 hours.
111 .LP
112 The
113 .I amdump_files
114 may be in various compressed formats
115 .BR \fR(\fPcompress ,
116 .BR gzip ,
117 .BR pact ,
118 .BR compact ).
119 .SH INTERPRETATION
120 The figure is divided into a number of regions.
121 There are titles on the top that show important statistical information
122 about the configuration and from this execution of
123 .BR amdump .
124 In the figure, the X axis is time, with 0 being the moment
125 .B amdump
126 was started.
127 The Y axis is divided into 5 regions:
128 .IP
129 .I QUEUES:
130 How many backups have not been started,
131 how many are waiting on space in the holding disk
132 and how many have been transferred successfully to tape.
133 .IP
134 .I %BANDWIDTH:
135 Percentage of allowed network bandwidth in use.
136 .IP
137 .I HOLDING DISK:
138 The higher line depicts space allocated on the holding disk to
139 backups in progress and completed backups waiting to be written to tape.
140 The lower line depicts the fraction of the holding disk containing completed
141 backups waiting to be written to tape including the file currently being
142 written to tape.
143 The scale is percentage of the holding disk.
144 .IP
145 .I TAPE:
146 Tape drive usage.
147 .IP
148 .I %DUMPERS:
149 Percentage of active dumpers.
150 .LP
151 The idle period at the left of the graph is time
152 .B amdump
153 is asking the machines how much data they are going to dump.
154 This process can take a while if hosts are down
155 or it takes them a long time to generate estimates.
156 .SH AUTHOR
157 Olafur Gudmundsson ogud@tis.com
158 .br
159 Trusted Information Systems
160 .br
161 formerly at University of Maryland, College Park
162 .SH BUGS
163 Reports lines it does not recognize, mainly error cases but some are
164 legitimate lines the program needs to be taught about.
165 .SH SEE ALSO
166 amanda(8),
167 amdump(8),
168 gawk(1),
169 nawk(1),
170 awk(1),
171 gnuplot(1),
172 sh(1),
173 compress(1),
174 gzip(1)