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: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMPLOT" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "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 \fIAmanda\fR
  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
  34 \fIAmanda\fR
  35 generates each run (e\&.g\&.
  36 \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\&.
  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 (\fIamplot\&.awk\fR) to scan the
  47 \fBamdump\fR
  48 output file\&. It then executes a
  49 \fBgnuplot\fR
  50 program
  51 (\fIamplot\&.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 (\fIgawk\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 \fIAmanda\fR\&.
  68 .SH "OPTIONS"
  69 .PP
  70 \fB\-b\fR
  71 .RS 4
  72 Generate b/w postscript file (need
  73 \fB\-p\fR)\&.
  74 .RE
  75 .PP
  76 \fB\-c\fR
  77 .RS 4
  78 Compress
  79 \fIamdump_files\fR
  80 after plotting\&.
  81 .RE
  82 .PP
  83 \fB\-e\fR
  84 .RS 4
  85 Extend the X (time) axis if needed\&.
  86 .RE
  87 .PP
  88 \fB\-g\fR
  89 .RS 4
  90 Direct
  91 \fIgnuplot\fR
  92 output directly to the X11 display (default)\&.
  93 .RE
  94 .PP
  95 \fB\-p\fR
  96 .RS 4
  97 Direct postscript output to file
  98 \fIYYYYMMDD\fR\fI\&.ps\fR
  99 (opposite of
 100 \fB\-g\fR)\&.
 101 .RE
 102 .PP
 103 \fB\-l\fR
 104 .RS 4
 105 Generate landscape oriented output (needs
 106 \fB\-p\fR)\&.
 107 .RE
 108 .PP
 109 \fB\-t \fR\fIT\fR
 110 .RS 4
 111 Set the right edge of the plot to be
 112 \fIT\fR
 113 hours\&.
 114 .RE
 115 .PP
 116 The
 117 \fIamdump_files\fR
 118 may be in various compressed formats
 119 (\fIcompress\fR,
 120 \fBgzip\fR,
 121 \fBpact\fR,
 122 \fBcompact\fR)\&.
 123 .SH "INTERPRETATION"
 124 .PP
 125 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
 126 \fBamdump\fR\&. In the figure, the X axis is time, with 0 being the moment
 127 \fBamdump\fR
 128 was started\&. The Y axis is divided into 5 regions:
 129 .PP
 130 \fIQUEUES:\fR
 131 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\&.
 132 .PP
 133 \fI%BANDWIDTH:\fR
 134 Percentage of allowed network bandwidth in use\&.
 135 .PP
 136 \fIHOLDING DISK:\fR
 137 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\&.
 138 .PP
 139 \fITAPE:\fR
 140 Tape drive usage\&.
 141 .PP
 142 \fI%DUMPERS:\fR
 143 Percentage of active dumpers\&.
 144 .PP
 145 The idle period at the left of the graph is time
 146 \fBamdump\fR
 147 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\&.
 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),
 162 : http://wiki.zmanda.com
 163 .SH "AUTHORS"
 164 .PP
 165 \fBOlafur Gudmundsson\fR <\&ogud@tis\&.com\&>
 166 .RS 4
 167 Trusted Information Systems
 168 .RE
 169 .PP
 170 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>