git.gag.com Git - debian/amanda/blob - 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 .ad l
  25 .hy 0
  26 .HP 7
  27 \fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
  28 .ad
  29 .hy
  30
  31 .SH "DESCRIPTION"
  32
  33 .PP
  34 \fBAmplot\fR reads an \fBamdump\fR output file that \fBAMANDA\fR generates each run (e\&.g\&. \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\&. \fBAmplot\fR also prints out \fBamdump\fR 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\&.
  35
  36 .PP
  37 \fBAmplot\fR is a shell script that executes an \fBawk\fR program \fB\fR(\fBamplot\&.awk\fR) to scan the \fBamdump\fR output file\&. It then executes a \fBgnuplot\fR program \fB\fR(\fBamplot\&.g\fR) to generate the graph\&. The \fBawk\fR program is written in an enhanced version of awk, such as GNU awk \fB\fR(\fBgawk\fR version 2\&.15 or later) or \fBnawk\fR\&.
  38
  39 .PP
  40 During execution, \fBamplot\fR generates a few temporary files that \fBgnuplot\fR uses\&. These files are deleted at the end of execution\&.
  41
  42 .PP
  43 See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
  44
  45 .SH "OPTIONS"
  46
  47 .TP
  48 \fB\-b\fR
  49 Generate b/w postscript file (need \fB\-p\fR)\&.
  50
  51 .TP
  52 \fB\-c\fR
  53 Compress \fBamdump_files\fR after plotting\&.
  54
  55 .TP
  56 \fB\-e\fR
  57 Extend the X (time) axis if needed\&.
  58
  59 .TP
  60 \fB\-g\fR
  61 Direct \fBgnuplot\fR output directly to the X11 display (default)\&.
  62
  63 .TP
  64 \fB\-p\fR
  65 Direct postscript output to file \fB\fR\fBYYYYMMDD\fR\fB\&.ps\fR (opposite of \fB\-g\fR)\&.
  66
  67 .TP
  68 \fB\-l\fR
  69 Generate landscape oriented output (needs \fB\-p\fR)\&.
  70
  71 .TP
  72 \fB\-t \fR\fBT\fR
  73 Set the right edge of the plot to be \fBT\fR hours\&.
  74
  75 .PP
  76 The \fBamdump_files\fR may be in various compressed formats \fB\fR(\fBcompress\fR, \fBgzip\fR, \fBpact\fR, \fBcompact\fR)\&.
  77
  78 .SH "INTERPRETATION"
  79
  80 .PP
  81 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 \fBamdump\fR\&. In the figure, the X axis is time, with 0 being the moment \fBamdump\fR was started\&. The Y axis is divided into 5 regions:
  82
  83 .PP
  84 \fBQUEUES:\fR 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\&.
  85
  86 .PP
  87 \fB%BANDWIDTH:\fR Percentage of allowed network bandwidth in use\&.
  88
  89 .PP
  90 \fBHOLDING DISK:\fR 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\&.
  91
  92 .PP
  93 \fBTAPE:\fR Tape drive usage\&.
  94
  95 .PP
  96 \fB%DUMPERS:\fR Percentage of active dumpers\&.
  97
  98 .PP
  99 The idle period at the left of the graph is time \fBamdump\fR 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\&.
 100
 101 .SH "AUTHOR"
 102
 103 .PP
 104 Olafur Gudmundsson <ogud@tis\&.com>, Trusted Information Systems, formerly at University of Maryland, College Park: Original text
 105
 106 .PP
 107 Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
 108
 109 .SH "BUGS"
 110
 111 .PP
 112 Reports lines it does not recognize, mainly error cases but some are legitimate lines the program needs to be taught about\&.
 113
 114 .SH "SEE ALSO"
 115
 116 .PP
 117 \fBamanda\fR(8), \fBamdump\fR(8), \fBgawk\fR(1), \fBnawk\fR(1), \fBawk\fR(1), \fBgnuplot\fR(1), \fBsh\fR(1), \fBcompress\fR(1), \fBgzip\fR(1)
 118