Imported Upstream version 2.5.0p2
[debian/amanda] / man / amplot.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMPLOT" 8 "" "" ""
21 .SH "NAME"
22 amplot - visualize the behavior of Amanda
23 .SH "SYNOPSIS"
24 .HP 7
25 \fBamplot\fR [-b] [-c] [-e] [-g] [-l] [-p] [-t \fIT\fR] \fIamdump_files\fR
26 .br
27
28 .SH "DESCRIPTION"
29 .PP
30 \fBAmplot\fR
31 reads an
32 \fBamdump\fR
33 output file that
34 \fBAmanda\fR
35 generates each run (e.g.
36 \fBamdump.1\fR) and translates the information into a picture format that may be used to determine how your installation is doing and if any parameters need to be changed.
37 \fBAmplot\fR
38 also prints out
39 \fBamdump\fR
40 lines that it either does not understand or knows to be warning or error lines and a summary of the start, end and total time for each backup image.
41 .PP
42 \fBAmplot\fR
43 is a shell script that executes an
44 \fBawk\fR
45 program
46 \fB\fR(\fBamplot.awk\fR) to scan the
47 \fBamdump\fR
48 output file. It then executes a
49 \fBgnuplot\fR
50 program
51 \fB\fR(\fBamplot.g\fR) to generate the graph. The
52 \fBawk\fR
53 program is written in an enhanced version of awk, such as GNU awk
54 \fB\fR(\fBgawk\fR
55 version 2.15 or later) or
56 \fBnawk\fR.
57 .PP
58 During execution,
59 \fBamplot\fR
60 generates a few temporary files that
61 \fBgnuplot\fR
62 uses. These files are deleted at the end of execution.
63 .PP
64 See the
65 \fBamanda\fR(8)
66 man page for more details about
67 \fBAmanda\fR.
68 .SH "OPTIONS"
69 .TP
70 \fB-b\fR
71 Generate b/w postscript file (need
72 \fB-p\fR).
73 .TP
74 \fB-c\fR
75 Compress
76 \fBamdump_files\fR
77 after plotting.
78 .TP
79 \fB-e\fR
80 Extend the X (time) axis if needed.
81 .TP
82 \fB-g\fR
83 Direct
84 \fBgnuplot\fR
85 output directly to the X11 display (default).
86 .TP
87 \fB-p\fR
88 Direct postscript output to file
89 \fB\fR\fBYYYYMMDD\fR\fB.ps\fR
90 (opposite of
91 \fB-g\fR).
92 .TP
93 \fB-l\fR
94 Generate landscape oriented output (needs
95 \fB-p\fR).
96 .TP
97 \fB-t \fR\fBT\fR
98 Set the right edge of the plot to be
99 \fBT\fR
100 hours.
101 .PP
102 The
103 \fBamdump_files\fR
104 may be in various compressed formats
105 \fB\fR(\fBcompress\fR,
106 \fBgzip\fR,
107 \fBpact\fR,
108 \fBcompact\fR).
109 .SH "INTERPRETATION"
110 .PP
111 The figure is divided into a number of regions. There are titles on the top that show important statistical information about the configuration and from this execution of
112 \fBamdump\fR. In the figure, the X axis is time, with 0 being the moment
113 \fBamdump\fR
114 was started. The Y axis is divided into 5 regions:
115 .PP
116 \fBQUEUES:\fR
117 How many backups have not been started, how many are waiting on space in the holding disk and how many have been transferred successfully to tape.
118 .PP
119 \fB%BANDWIDTH:\fR
120 Percentage of allowed network bandwidth in use.
121 .PP
122 \fBHOLDING DISK:\fR
123 The higher line depicts space allocated on the holding disk to backups in progress and completed backups waiting to be written to tape. The lower line depicts the fraction of the holding disk containing completed backups waiting to be written to tape including the file currently being written to tape. The scale is percentage of the holding disk.
124 .PP
125 \fBTAPE:\fR
126 Tape drive usage.
127 .PP
128 \fB%DUMPERS:\fR
129 Percentage of active dumpers.
130 .PP
131 The idle period at the left of the graph is time
132 \fBamdump\fR
133 is asking the machines how much data they are going to dump. This process can take a while if hosts are down or it takes them a long time to generate estimates.
134 .SH "AUTHOR"
135 .PP
136 Olafur Gudmundsson
137 <ogud@tis.com>, Trusted Information Systems, formerly at University of Maryland, College Park: Original text
138 .PP
139 Stefan G. Weichinger,
140 <sgw@amanda.org>, maintainer of the
141 \fBAmanda\fR-documentation: XML-conversion
142 .SH "BUGS"
143 .PP
144 Reports lines it does not recognize, mainly error cases but some are legitimate lines the program needs to be taught about.
145 .SH "SEE ALSO"
146 .PP
147 \fBamanda\fR(8),
148 \fBamdump\fR(8),
149 \fBgawk\fR(1),
150 \fBnawk\fR(1),
151 \fBawk\fR(1),
152 \fBgnuplot\fR(1),
153 \fBsh\fR(1),
154 \fBcompress\fR(1),
155 \fBgzip\fR(1)
156