3 .\" Author: Stefan G. Weichinger <sgw@amanda.org>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.1
10 .TH "AMREPORT" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 amreport \- generate a formatted output of statistics for an Amanda run
33 .HP \w'\fBamreport\fR\ 'u
34 \fBamreport\fR [\fB\-o\fR\ \fIconfigoption\fR...] [(1)\ \fIcommand\-line options\fR | (2)\ \fIscript options\fR] [\fIconfig\fR]
36 .nr an-no-space-flag 1
40 (1)\ [\-\-log=\fIlogfile\fR] [\-\-ps=\fIfilename\fR] [\-\-text=\fIfilename\fR] [\-\-xml=\fIfilename\fR] [\-\-print=\fIprinter\fR] [\-\-mail\-text=\fIrecipient\fR]
42 (2)\ [\-i] [\-M\ \fIaddress\fR] [\-l\ \fIlogfile\fR] [\-f\ \fIoutputfile\fR] [\-p\ \fIpostscriptfile\fR] [\-\-from\-amdump]
46 generates a summary report of an Amanda backup run\&.
50 man page for more details about Amanda\&.
55 Name of the configuration to process\&. If no configuration name is specified, amanda\&.conf is read from the current directory\&.
58 \fB\-o \fR\fB\fIconfigoption\fR\fR
60 See the "CONFIGURATION OVERRIDE" section in
64 Amreport operates in two distinct modes\&. Command\-line mode is intended for use by an administrator from the command line, and uses long command\-line options for clarity\&. Script mode is intended for use from scripts such as amdump, and has a lot of non\-obvious default behaviors to suit that need\&.
66 Unless a script\-mode option is given, amreport defaults to command\-line mode\&. If no options are given, amreport writes a report for the most recent logfile to stdout\&.
67 .SS "Command\-Line Mode Options"
69 \fB\-\-log=\fR\fB\fIlogfile\fR\fR
71 Use this logfile as the basis for the report\&. If this option is given, then the report is a "historical" report and will not include current state from e\&.g\&., holding disk and curinfo\&. If this option is not specified, then the most recent logfile will be used\&.
74 \fB\-\-ps=\fR\fB\fIfilename\fR\fR
76 Write a postscript label to
77 \fIfilename\fR\&. See "LABEL PRINTING" below\&. If filename is not specified, then the label is written to stdout\&.
80 \fB\-\-text=\fR\fB\fIfilename\fR\fR
82 Write a human\-readable text report to
83 \fIfilename\fR\&. If filename is not specified, then the report is written to stdout\&.
86 \fB\-\-xml=\fR\fB\fIfilename\fR\fR
88 Write an XML\-formatted report to
89 \fIfilename\fR\&. If filename is not specified, then the report is written to stdout\&.
92 \fB\-\-print=\fR\fB\fIprinter\fR\fR
94 Pipe a postscript label to
97 \fBlpr\fR, specifying the given
98 \fIprinter\fR\&. If the printer is not specified, uses the default from the Amanda configuration, or the system default printer\&.
101 \fB\-\-mail\-text=\fR\fB\fIrecipient\fR\fR
103 Send a human\-readable text report to the given
105 via the mailer specified in the Amanda configuration\&. If the recipient is not specified, this uses the
107 from the Amanda configuration\&.
109 .SS "Script Mode Options"
113 Don\*(Aqt email the report\&.
116 \fB\-M\fR \fIaddress\fR
123 \fIamanda\&.conf\fR\&.
126 \fB\-l\fR \fIlogfile\fR
128 Name of the log file to parse to generate the report\&. If a log file is not specified, it defaults to the file
131 is the log directory defined in amanda\&.conf\&.
134 \fB\-f\fR \fIoutputfile\fR
138 sends the report via e\-mail to the
140 user as defined in the amanda\&.conf file\&. If
142 is specified, then the report is put in
146 \fB\-p\fR \fIpostscriptfile\fR
148 Send the postscript output to the file
152 command\&. This option has an effect only if the
154 directive is specified in amanda\&.conf\&.
157 \fB\-\-from\-amdump\fR
159 Force script mode\&. Has no other effect\&.
161 .SH "TEXT REPORT FORMAT"
163 Amanda\*(Aqs text report format is divided into several sections\&. Some of these sections only appear if they are not empty\&.
165 Although newer versions of Amanda try to use the term "volume" to refer to a unit of storage, amreport still uses the term "tape", even if backups are done to non\-tape devices, to allow scripts which parse amreport\*(Aqs output to continue to function\&.
171 Date : February 25, 2009
173 These dumps were to tape Daily\-103\&.
174 The next tape Amanda expects to use is: Daily\-142
176 FAILURE DUMP SUMMARY:
177 jamon\&.slikon\&.local /var lev 0 FAILED [/bin/tar exited with status 2]
180 The summary section describes the run in broad terms, giving the server hostname, organization (from the
182 configuration parameter), configuration name, and dump date\&. This is followed by a description of the volumes and holding disk used, and an rough estimate of the volume(s) Amanda will use on the next run\&.
184 Brief notices of any unusual circumstances will also be included here\&.
189 \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-
190 Estimate Time (hrs:min) 0:00
191 Run Time (hrs:min) 0:01
192 Dump Time (hrs:min) 0:00 0:00 0:00
193 Output Size (meg) 1\&.6 0\&.0 1\&.6
194 Original Size (meg) 1\&.6 0\&.0 1\&.6
195 Avg Compressed Size (%) 100\&.0 100\&.0 100\&.0 (level:#disks \&.\&.\&.)
196 Filesystems Dumped 4 1 3 (1:3)
197 Avg Dump Rate (k/s) 1555\&.1 134\&.2 1787\&.3
199 Tape Time (hrs:min) 0:00 0:00 0:00
200 Tape Size (meg) 1\&.6 0\&.0 1\&.6
201 Tape Used (%) 5\&.5 0\&.1 5\&.4 (level:#disks \&.\&.\&.)
202 Filesystems Taped 4 1 3 (1:3)
203 (level:#parts \&.\&.\&.)
204 Parts Taped 4 1 3 (1:3)
205 Avg Tp Write Rate (k/s) 143966 27624\&.3 151811
208 Label Time Size % DLEs Parts
209 metals\-013 0:00 1650k 5\&.4 4 4
212 This section contains aggregate statistics for the entire run\&. The three columns break down the results into a total for all data handled, only full dumps, and only incremental dumps\&. In the right margin, amreport indicates the breakdown of dump levels at the dumper and the taper\&.
214 The rows have the following meanings:
218 The time used by the planner to estimate dump sizes\&.
223 Total runtime, from the invocation of amdump to its completion\&.
228 Total time spent dumping clients\&.
233 Total quantity of data dumped, after compression\&.
238 Total quantity of data dumped, before compression\&.
243 Compression ratio, calculated from the previous two rows\&.
248 Number of DLEs dumped\&.
253 Average speed at which clients produced data\&. Note that, for dumps done directly to a slow device, rather than to holding disk, this rate may reflect a write speed constrained by the device speed\&.
258 Total time spent writing to storage volumes\&. This includes time spent changing tapes, including time spent waiting for flush thresholds to be met\&.
263 Total quantity of data written to storage volumes\&.
268 Fraction of the total allocated storage (tapetype length times runtapes) actually used\&.
273 Number of filesystems written to storage\&. This may be larger or smaller than the number of filesystems dumped, due to flushes or dumps left on holding disk\&.
278 Number of split parts writtten to storage\&. If this number is very large, then the split size may be too small\&.
283 Taper speed, based on the tape time and tape size, above\&. Note that, because the tape time includes time spent on tasks other than writing to tape, this does not necessary reflect the device\*(Aqs real write speed\&. However, the value is useful for capacity planning, as it reflects a realistic estimate of how quickly Amanda can write data to storage\&.
288 Label Time Size % DLEs Parts
289 Conf\-001 0:00 20320k 66\&.2 1 4
290 Conf\-002 0:00 6470k 21\&.1 0 2
293 This short section gives per\-volume statistics: time spent writing to the volume; bytes written to the volume; portion of the expected tape length used; number of DLEs started, and total number of split parts written\&.
297 taper: tape DAILY\-37 kb 30720 fm 3 [OK]
300 This section contains any informational log messages from the run\&. Most messages are self\-explanatory\&. The taper message shown in the example is always present, and is redundant to the previous section\&. It indicates that 30720 kb were written to "DAILY\-37" in 3 files\&.
301 .SS "Failure and Strange Details"
305 /\-\- jamon\&.slikon\&.local /var lev 0 FAILED [/bin/tar exited with status 2]
306 sendbackup: info BACKUP=APPLICATION
307 sendbackup: info APPLICATION=amgtar
308 sendbackup: info RECOVER_CMD=/usr/bin/gzip \-dc |amgtar \-f\&.\&.\&. \-
309 sendbackup: info COMPRESS_SUFFIX=\&.gz
311 ? /bin/tar: \&./gdm: Cannot savedir: Permission denied
312 | Total bytes written: 943831040 (901MiB, 4\&.9MiB/s)
313 | /bin/tar: Error exit delayed from previous errors
314 sendbackup: error [/bin/tar exited with status 2]
315 sendbackup: size 921710
319 STRANGE DUMP DETAILS:
321 /\-\- bsdfw\&.slikon\&.local / lev 0 STRANGE
322 sendbackup: info BACKUP=APPLICATION
323 sendbackup: info APPLICATION=amgtar
324 sendbackup: info RECOVER_CMD=/usr/bin/gzip \-dc |amgtar \-f\&.\&.\&. \-
325 sendbackup: info COMPRESS_SUFFIX=\&.gz
327 | /bin/tar: \&./tmp/\&.X11\-unix/X0: socket ignored
328 | Total bytes written: 5530869760 (5\&.2GiB, 3\&.0MiB/s)
329 sendbackup: size 5401240
334 This section expands on failures and strange results indicated in earlier sections\&. In both cases, the details contain a messages produced by the underlying backup tool \- GNU tar, in this example\&. Failed dumps have actually failed, and the reasons are usually clear\&. Strange dumps, however, are regarded as successful by Amanda, but contain messages that Amanda did not recognize and which may be of interest to the operator\&.
338 DUMPER STATS TAPER STATS
339 HOSTNAME DISK L ORIG\-kB OUT\-kB COMP% MMM:SS KB/s MMM:SS KB/s
340 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
341 strontium /etc 1 270 270 \-\- 0:00 1146\&.3 0:00 140918\&.6
342 strontium \-me/elantra 1 10 10 \-\- 0:00 65\&.6 0:00 9033\&.4
343 strontium /local 0 20 20 \-\- 0:00 133\&.9 0:00 27624\&.3
344 strontium \-ository_13 1 1350 1350 \-\- 0:01 2568\&.5 0:00 175006\&.5
347 The dump summary table has one row for each DLE processed during the run\&. The "L" column gives the level of the dump\&. The remaining colums are divided into dumper stats and taper stats\&.
349 The dumper stats give the original (before compression) and output (after compression) size of each dump, as well as a compression ratio, if applicable\&. The column labeled "MMM:SS" gives the time spent on that dump, and the next column is the calculated dump rate\&.
351 The taper stats give the time and speed with which the dump was written to storage\&. This value is the sum of the times for each part, and as such does not include time spent switching volumes\&.
354 Amanda can print postscript labels describing the contents of tape(s) written in a run\&. The labels are designed to be folded and inserted into the tape case along with the tape or hole punched and put in a 3\-ring binder\&. Various label templates are provided to format data for different tape sizes\&.
356 The information printed varies slightly between label templates due to size constraints\&. Labels contain one line for each host/file\-system pair and may also contain the file number on the tape, the level of the dump, the original size of the dump and the size of the (possibly compressed) tape file\&.
360 parameter to the tapetype definition in amanda\&.conf to enable labels\&. If you don\*(Aqt add this line to your tapetype definition,
362 will not print tape labels\&.
366 keyword in amanda\&.conf to print to other than the system default printer\&.
369 Amanda provides label templates for the following tape types\&. These are pretty generic labels and should be easy to customize for other tape types or particular site needs\&.
384 The 3\-ring binder type is the most generic\&. It may be used to make a hardcopy log of the tapes\&.
387 The exit code of \fBamreport\fR is the ORed value of:
391 2 = a dle give strange message
393 8 = Don\*(Aqt know the status of a dle (RESULT_MISSING in the report)
394 16 = tape error or no more tape
402 : http://wiki.zmanda.com/
405 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>