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

   1 .\"     Title: amplot
   2 .\"    Author: Olafur Gudmundsson <ogud@tis.com>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMPLOT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amplot \- visualize the behavior of \fIAmanda\fR
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamplot\fR\ 'u
 174 \fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
 175 .br
 176
 177 .fam
 178 .SH "DESCRIPTION"
 179 .PP
 180 \fBAmplot\fR
 181 reads an
 182 \fBamdump\fR
 183 output file that
 184 \fIAmanda\fR
 185 generates each run (e\&.g\&.
 186 \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\&.
 187 \fBAmplot\fR
 188 also prints out
 189 \fBamdump\fR
 190 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\&.
 191 .PP
 192 \fBAmplot\fR
 193 is a shell script that executes an
 194 \fBawk\fR
 195 program
 196 (\fIamplot\&.awk\fR) to scan the
 197 \fBamdump\fR
 198 output file\&. It then executes a
 199 \fBgnuplot\fR
 200 program
 201 (\fIamplot\&.g\fR) to generate the graph\&. The
 202 \fBawk\fR
 203 program is written in an enhanced version of awk, such as GNU awk
 204 (\fIgawk\fR
 205 version 2\&.15 or later) or
 206 \fBnawk\fR\&.
 207 .PP
 208 During execution,
 209 \fBamplot\fR
 210 generates a few temporary files that
 211 \fBgnuplot\fR
 212 uses\&. These files are deleted at the end of execution\&.
 213 .PP
 214 See the
 215 \fBamanda\fR(8)
 216 man page for more details about
 217 \fIAmanda\fR\&.
 218 .SH "OPTIONS"
 219 .PP
 220 \fB\-b\fR
 221 .RS 4
 222 Generate b/w postscript file (need
 223 \fB\-p\fR)\&.
 224 .RE
 225 .PP
 226 \fB\-c\fR
 227 .RS 4
 228 Compress
 229 \fIamdump_files\fR
 230 after plotting\&.
 231 .RE
 232 .PP
 233 \fB\-e\fR
 234 .RS 4
 235 Extend the X (time) axis if needed\&.
 236 .RE
 237 .PP
 238 \fB\-g\fR
 239 .RS 4
 240 Direct
 241 \fIgnuplot\fR
 242 output directly to the X11 display (default)\&.
 243 .RE
 244 .PP
 245 \fB\-p\fR
 246 .RS 4
 247 Direct postscript output to file
 248 \fIYYYYMMDD\fR\fI\&.ps\fR
 249 (opposite of
 250 \fB\-g\fR)\&.
 251 .RE
 252 .PP
 253 \fB\-l\fR
 254 .RS 4
 255 Generate landscape oriented output (needs
 256 \fB\-p\fR)\&.
 257 .RE
 258 .PP
 259 \fB\-t \fR\fIT\fR
 260 .RS 4
 261 Set the right edge of the plot to be
 262 \fIT\fR
 263 hours\&.
 264 .RE
 265 .PP
 266 The
 267 \fIamdump_files\fR
 268 may be in various compressed formats
 269 (\fIcompress\fR,
 270 \fBgzip\fR,
 271 \fBpact\fR,
 272 \fBcompact\fR)\&.
 273 .SH "INTERPRETATION"
 274 .PP
 275 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
 276 \fBamdump\fR\&. In the figure, the X axis is time, with 0 being the moment
 277 \fBamdump\fR
 278 was started\&. The Y axis is divided into 5 regions:
 279 .PP
 280 \fIQUEUES:\fR
 281 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\&.
 282 .PP
 283 \fI%BANDWIDTH:\fR
 284 Percentage of allowed network bandwidth in use\&.
 285 .PP
 286 \fIHOLDING DISK:\fR
 287 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\&.
 288 .PP
 289 \fITAPE:\fR
 290 Tape drive usage\&.
 291 .PP
 292 \fI%DUMPERS:\fR
 293 Percentage of active dumpers\&.
 294 .PP
 295 The idle period at the left of the graph is time
 296 \fBamdump\fR
 297 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\&.
 298 .SH "BUGS"
 299 .PP
 300 Reports lines it does not recognize, mainly error cases but some are legitimate lines the program needs to be taught about\&.
 301 .SH "SEE ALSO"
 302 .PP
 303 \fBamanda\fR(8),
 304 \fBamdump\fR(8),
 305 \fBgawk\fR(1),
 306 \fBnawk\fR(1),
 307 \fBawk\fR(1),
 308 \fBgnuplot\fR(1),
 309 \fBsh\fR(1),
 310 \fBcompress\fR(1),
 311 \fBgzip\fR(1),
 312 : http://wiki.zmanda.com
 313 .SH "Authors"
 314 .PP
 315 \fBOlafur Gudmundsson\fR <\&ogud@tis\&.com\&>
 316 .RS 4
 317 Trusted Information Systems
 318 .RE
 319 .PP
 320 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>