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

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