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