git.gag.com Git - debian/amanda/blob - man/amplot.8

   1 .\"     Title: amplot
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
   4 .\"      Date: 06/06/2007
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "AMPLOT" "8" "06/06/2007" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 amplot \- visualize the behavior of Amanda
  15 .SH "SYNOPSIS"
  16 .HP 7
  17 \fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
  18 .br
  19
  20 .SH "DESCRIPTION"
  21 .PP
  22 \fBAmplot\fR
  23 reads an
  24 \fBamdump\fR
  25 output file that
  26 \fIAmanda\fR
  27 generates each run (e.g.
  28 \fIamdump.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.
  29 \fBAmplot\fR
  30 also prints out
  31 \fBamdump\fR
  32 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.
  33 .PP
  34 \fBAmplot\fR
  35 is a shell script that executes an
  36 \fBawk\fR
  37 program
  38 (\fIamplot.awk\fR) to scan the
  39 \fBamdump\fR
  40 output file. It then executes a
  41 \fBgnuplot\fR
  42 program
  43 (\fIamplot.g\fR) to generate the graph. The
  44 \fBawk\fR
  45 program is written in an enhanced version of awk, such as GNU awk
  46 (\fIgawk\fR
  47 version 2.15 or later) or
  48 \fBnawk\fR.
  49 .PP
  50 During execution,
  51 \fBamplot\fR
  52 generates a few temporary files that
  53 \fBgnuplot\fR
  54 uses. These files are deleted at the end of execution.
  55 .PP
  56 See the
  57 \fBamanda\fR(8)
  58 man page for more details about
  59 \fIAmanda\fR.
  60 .SH "OPTIONS"
  61 .PP
  62 \fB\-b\fR
  63 .RS 4
  64 Generate b/w postscript file (need
  65 \fB\-p\fR).
  66 .RE
  67 .PP
  68 \fB\-c\fR
  69 .RS 4
  70 Compress
  71 \fIamdump_files\fR
  72 after plotting.
  73 .RE
  74 .PP
  75 \fB\-e\fR
  76 .RS 4
  77 Extend the X (time) axis if needed.
  78 .RE
  79 .PP
  80 \fB\-g\fR
  81 .RS 4
  82 Direct
  83 \fIgnuplot\fR
  84 output directly to the X11 display (default).
  85 .RE
  86 .PP
  87 \fB\-p\fR
  88 .RS 4
  89 Direct postscript output to file
  90 \fIYYYYMMDD\fR\fI.ps\fR
  91 (opposite of
  92 \fB\-g\fR).
  93 .RE
  94 .PP
  95 \fB\-l\fR
  96 .RS 4
  97 Generate landscape oriented output (needs
  98 \fB\-p\fR).
  99 .RE
 100 .PP
 101 \fB\-t \fR\fIT\fR
 102 .RS 4
 103 Set the right edge of the plot to be
 104 \fIT\fR
 105 hours.
 106 .RE
 107 .PP
 108 The
 109 \fIamdump_files\fR
 110 may be in various compressed formats
 111 (\fIcompress\fR,
 112 \fBgzip\fR,
 113 \fBpact\fR,
 114 \fBcompact\fR).
 115 .SH "INTERPRETATION"
 116 .PP
 117 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
 118 \fBamdump\fR. In the figure, the X axis is time, with 0 being the moment
 119 \fBamdump\fR
 120 was started. The Y axis is divided into 5 regions:
 121 .PP
 122 \fIQUEUES:\fR
 123 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.
 124 .PP
 125 \fI%BANDWIDTH:\fR
 126 Percentage of allowed network bandwidth in use.
 127 .PP
 128 \fIHOLDING DISK:\fR
 129 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.
 130 .PP
 131 \fITAPE:\fR
 132 Tape drive usage.
 133 .PP
 134 \fI%DUMPERS:\fR
 135 Percentage of active dumpers.
 136 .PP
 137 The idle period at the left of the graph is time
 138 \fBamdump\fR
 139 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.
 140 .SH "AUTHOR"
 141 .PP
 142 Olafur Gudmundsson
 143 <ogud@tis.com>, Trusted Information Systems, formerly at University of Maryland, College Park: Original text
 144 .PP
 145 Stefan G. Weichinger,
 146 <sgw@amanda.org>, maintainer of the
 147 \fIAmanda\fR\-documentation: XML\-conversion
 148 .SH "BUGS"
 149 .PP
 150 Reports lines it does not recognize, mainly error cases but some are legitimate lines the program needs to be taught about.
 151 .SH "SEE ALSO"
 152 .PP
 153 \fBamanda\fR(8),
 154 \fBamdump\fR(8),
 155 \fBgawk\fR(1),
 156 \fBnawk\fR(1),
 157 \fBawk\fR(1),
 158 \fBgnuplot\fR(1),
 159 \fBsh\fR(1),
 160 \fBcompress\fR(1),
 161 \fBgzip\fR(1)