1AMREPORT(8)             System Administration Commands             AMREPORT(8)
2
3
4

NAME

6       amreport - generate a formatted output of statistics for an Amanda run
7

SYNOPSIS

9       amreport [-o configoption...] [(1) command-line options | (2) script
10                options] [config]
11
12       (1) [--log=logfile] [--format=MODULE:DEST,DEST-ARG] [--ps=filename]
13           [--text=filename] [--xml=filename] [--print=printer]
14           [--mail-text=recipient]
15       (2) [-i] [-M address] [-l logfile] [-f outputfile] [-p postscriptfile]
16           [--from-amdump]
17

DESCRIPTION

19       Amreport generates a summary report of an Amanda backup run.
20
21       See the amanda(8) man page for more details about Amanda.
22

OPTIONS

24       config
25           Name of the configuration to process. If no configuration name is
26           specified, amanda.conf is read from the current directory.
27
28       -o configoption
29           See the "CONFIGURATION OVERRIDE" section in amanda(8).
30
31       Amreport operates in two distinct modes. Command-line mode is intended
32       for use by an administrator from the command line, and uses long
33       command-line options for clarity. Script mode is intended for use from
34       scripts such as amdump, and has a lot of non-obvious default behaviors
35       to suit that need.
36
37       Unless a script-mode option is given, amreport defaults to command-line
38       mode. If no options are given, amreport writes a report for the most
39       recent logfile to stdout.
40
41   Command-Line Mode Options
42       --log=logfile
43           Use this logfile as the basis for the report. If this option is
44           given, then the report is a "historical" report and will not
45           include current state from e.g., holding disk and curinfo. If this
46           option is not specified, then the most recent logfile will be used.
47
48       --format=MODULE:DEST,DEST-ARG
49           Use the given perl module to format the report and send it to DEST
50           with the given DEST-ARG.
51
52           Valid module provided with amanda are: human, json, json_raw, ps
53           and xml, valid destination are file, mail and print, the DEST-ARG
54           depend on the destination.
55
56           The default destination is file.
57
58           The default arg for file destination is '-' (stdout).
59
60           The default arg for mail destination is the MAILTO configuration
61           option.
62
63           The default arg for print destination is the PRINTER configuration
64           option.
65
66           Examples:
67             --format=human
68             --format=human:mail
69             --format=human:mail:root
70             --format=human:file:/tmp/report.text
71             --format=xml:file:/tmp/report.xml
72             --format=ps:file:/tmp/report.ps
73             --format=ps:print:lp
74
75       --ps=filename
76           Write a postscript label to filename. See "LABEL PRINTING" below.
77           If filename is not specified, then the label is written to stdout.
78
79           Same as --format=ps, --format=ps:file:filename
80
81       --text=filename
82           Write a human-readable text report to filename. If filename is not
83           specified, then the report is written to stdout.
84
85           Same as --format=human, --format=human:file:filename
86
87       --xml=filename
88           Write an XML-formatted report to filename. If filename is not
89           specified, then the report is written to stdout.
90
91           Same as --format=xml, --format=xml:file:filename
92
93       --print=printer
94           Pipe a postscript label to lp or lpr, specifying the given printer.
95           If the printer is not specified, uses the default from the Amanda
96           configuration, or the system default printer.
97
98           Same as --format=ps:print, --format=ps:print:printer
99
100       --mail-text=recipient
101           Send a human-readable text report to the given recipient via the
102           mailer specified in the Amanda configuration. If the recipient is
103           not specified, this uses the mailto from the Amanda configuration.
104
105           Same as --format=human:mail, --format=human:mail:recipient
106
107   Script Mode Options
108       -i
109           Don't email the report.
110
111       -M address
112           Mail the report to address instead of the mailto value from
113           amanda.conf.
114
115       -l logfile
116           Name of the log file to parse to generate the report. If a log file
117           is not specified, it defaults to the file $logdir/log, where
118           $logdir is the log directory defined in amanda.conf.
119
120       -f outputfile
121           Normally, amreport sends the report via e-mail to the mailto user
122           as defined in the amanda.conf file. If outputfile is specified,
123           then the report is put in outputfile.
124
125       -p postscriptfile
126           Send the postscript output to the file postscriptfile instead of to
127           the lpr(1) command. This option has an effect only if the lbl-templ
128           directive is specified in amanda.conf.
129
130       --from-amdump
131           Force script mode. Has no other effect.
132

TEXT REPORT FORMAT

134       Amanda's text report format is divided into several sections. Some of
135       these sections only appear if they are not empty.
136
137       Although newer versions of Amanda try to use the term "volume" to refer
138       to a unit of storage, amreport still uses the term "tape", even if
139       backups are done to non-tape devices, to allow scripts which parse
140       amreport's output to continue to function.
141
142   Summary
143       Hostname: bkserver
144       Org     : DailySet1
145       Config  : Daily
146       Date    : February 25, 2009
147
148       These dumps were to tape Daily-103.
149       The next tape Amanda expects to use is: Daily-142
150
151       FAILURE DUMP SUMMARY:
152          jamon.slikon.local /var lev 0  FAILED [/bin/tar exited with status 2]
153
154       The summary section describes the run in broad terms, giving the server
155       hostname, organization (from the org configuration parameter),
156       configuration name, and dump date. This is followed by a description of
157       the volumes and holding disk used, and an rough estimate of the
158       volume(s) Amanda will use on the next run.
159
160       Brief notices of any unusual circumstances will also be included here.
161
162   Statistics
163       STATISTICS:
164                                 Total       Full      Incr.
165                               --------   --------   --------
166       Estimate Time (hrs:min)    0:00
167       Run Time (hrs:min)         0:01
168       Dump Time (hrs:min)        0:00       0:00       0:00
169       Output Size (meg)           1.6        0.0        1.6
170       Original Size (meg)         1.6        0.0        1.6
171       Avg Compressed Size (%)   100.0      100.0      100.0   (level:#disks ...)
172       Filesystems Dumped            4          1          3   (1:3)
173       Avg Dump Rate (k/s)      1555.1      134.2     1787.3
174
175       Tape Time (hrs:min)        0:00       0:00       0:00
176       Tape Size (meg)             1.6        0.0        1.6
177       Tape Used (%)               5.5        0.1        5.4   (level:#disks ...)
178       Filesystems Taped             4          1          3   (1:3)
179                                                               (level:#parts ...)
180       Parts Taped                   4          1          3   (1:3)
181       Avg Tp Write Rate (k/s)  143966    27624.3     151811
182
183       USAGE BY TAPE:
184         Label            Time      Size      %  DLEs Parts
185         metals-013       0:00     1650k    5.4     4     4
186
187       This section contains aggregate statistics for the entire run. The
188       three columns break down the results into a total for all data handled,
189       only full dumps, and only incremental dumps. In the right margin,
190       amreport indicates the breakdown of dump levels at the dumper and the
191       taper.
192
193       The rows have the following meanings:
194
195       Estimate Time
196           The time used by the planner to estimate dump sizes.
197
198       Run Time
199           Total runtime, from the invocation of amdump to its completion.
200
201       Dump Time
202           Total time spent dumping clients.
203
204       Output Size
205           Total quantity of data dumped, after compression.
206
207       Original Size
208           Total quantity of data dumped, before compression.
209
210       Avg Compressed Size
211           Compression ratio, calculated from the previous two rows.
212
213       Filesystems Dumped
214           Number of DLEs dumped.
215
216       Avg Dump Rate
217           Average speed at which clients produced data. Note that, for dumps
218           done directly to a slow device, rather than to holding disk, this
219           rate may reflect a write speed constrained by the device speed.
220
221       Tape Time
222           Total time spent writing to storage volumes. This includes time
223           spent changing tapes, including time spent waiting for flush
224           thresholds to be met.
225
226       Tape Size
227           Total quantity of data written to storage volumes.
228
229       Tape Used
230           Fraction of the total allocated storage (tapetype length times
231           runtapes) actually used.
232
233       Filesystems Taped
234           Number of filesystems written to storage. This may be larger or
235           smaller than the number of filesystems dumped, due to flushes or
236           dumps left on holding disk.
237
238       Parts Taped
239           Number of split parts writtten to storage. If this number is very
240           large, then the split size may be too small.
241
242       Avg Tp Write Rate
243           Taper speed, based on the tape time and tape size, above. Note
244           that, because the tape time includes time spent on tasks other than
245           writing to tape, this does not necessary reflect the device's real
246           write speed. However, the value is useful for capacity planning, as
247           it reflects a realistic estimate of how quickly Amanda can write
248           data to storage.
249
250   Usage by Tape
251       USAGE BY TAPE:
252         Label          Time      Size      %  DLEs Parts
253         Conf-001       0:00    20320k   66.2     1     4
254         Conf-002       0:00     6470k   21.1     0     2
255
256       This short section gives per-volume statistics: time spent writing to
257       the volume; bytes written to the volume; portion of the expected tape
258       length used; number of DLEs started, and total number of split parts
259       written.
260
261   Notes
262       NOTES:
263         taper: tape DAILY-37 kb 30720 fm 3 [OK]
264
265       This section contains any informational log messages from the run. Most
266       messages are self-explanatory. The taper message shown in the example
267       is always present, and is redundant to the previous section. It
268       indicates that 30720 kb were written to "DAILY-37" in 3 files.
269
270   Failure and Strange Details
271       FAILED DUMP DETAILS:
272
273       /--  jamon.slikon.local /var lev 0 FAILED [/bin/tar exited with status 2]
274       sendbackup: info BACKUP=APPLICATION
275       sendbackup: info APPLICATION=amgtar
276       sendbackup: info RECOVER_CMD=/usr/bin/gzip -dc |amgtar -f... -
277       sendbackup: info COMPRESS_SUFFIX=.gz
278       sendbackup: info end
279       ? /bin/tar: ./gdm: Cannot savedir: Permission denied
280       | Total bytes written: 943831040 (901MiB, 4.9MiB/s)
281       | /bin/tar: Error exit delayed from previous errors
282       sendbackup: error [/bin/tar exited with status 2]
283       sendbackup: size 921710
284       sendbackup: end
285       \\--------
286
287       STRANGE DUMP DETAILS:
288
289       /--  bsdfw.slikon.local / lev 0 STRANGE
290       sendbackup: info BACKUP=APPLICATION
291       sendbackup: info APPLICATION=amgtar
292       sendbackup: info RECOVER_CMD=/usr/bin/gzip -dc |amgtar -f... -
293       sendbackup: info COMPRESS_SUFFIX=.gz
294       sendbackup: info end
295       | /bin/tar: ./tmp/.X11-unix/X0: socket ignored
296       | Total bytes written: 5530869760 (5.2GiB, 3.0MiB/s)
297       sendbackup: size 5401240
298       sendbackup: end
299       \\--------
300
301       This section expands on failures and strange results indicated in
302       earlier sections. In both cases, the details contain a messages
303       produced by the underlying backup tool - GNU tar, in this example.
304       Failed dumps have actually failed, and the reasons are usually clear.
305       Strange dumps, however, are regarded as successful by Amanda, but
306       contain messages that Amanda did not recognize and which may be of
307       interest to the operator.
308
309   Dump Summary
310       DUMP SUMMARY:
311                                              DUMPER STATS                TAPER STATS
312       HOSTNAME     DISK        L ORIG-kB  OUT-kB  COMP%  MMM:SS   KB/s MMM:SS     KB/s
313       -------------------------- ------------------------------------- ---------------
314       strontium    /etc        1     270     270    --     0:00 1146.3   0:00 140918.6
315       strontium    -me/elantra 1      10      10    --     0:00   65.6   0:00   9033.4
316       strontium    /local      0      20      20    --     0:00  133.9   0:00  27624.3
317       strontium    -ository_13 1    1350    1350    --     0:01 2568.5   0:00 175006.5
318
319       The dump summary table has one row for each DLE processed during the
320       run. The "L" column gives the level of the dump. The remaining colums
321       are divided into dumper stats and taper stats.
322
323       The dumper stats give the original (before compression) and output
324       (after compression) size of each dump, as well as a compression ratio,
325       if applicable. The column labeled "MMM:SS" gives the time spent on that
326       dump, and the next column is the calculated dump rate.
327
328       The taper stats give the time and speed with which the dump was written
329       to storage. This value is the sum of the times for each part, and as
330       such does not include time spent switching volumes.
331

LABEL PRINTING

333       Amanda can print postscript labels describing the contents of tape(s)
334       written in a run. The labels are designed to be folded and inserted
335       into the tape case along with the tape or hole punched and put in a
336       3-ring binder. Various label templates are provided to format data for
337       different tape sizes.
338
339       The information printed varies slightly between label templates due to
340       size constraints. Labels contain one line for each host/file-system
341       pair and may also contain the file number on the tape, the level of the
342       dump, the original size of the dump and the size of the (possibly
343       compressed) tape file.
344
345       Add the lbl-templ parameter to the tapetype definition in amanda.conf
346       to enable labels. If you don't add this line to your tapetype
347       definition, amreport will not print tape labels.
348
349       You may use the printer keyword in amanda.conf to print to other than
350       the system default printer.
351

TEMPLATES

353       Amanda provides label templates for the following tape types. These are
354       pretty generic labels and should be easy to customize for other tape
355       types or particular site needs.
356
357           * ExaByte 8mm tapes
358           * DAT 4mm tapes
359           * DLT tapes
360           * 3-ring binder
361
362       The 3-ring binder type is the most generic. It may be used to make a
363       hardcopy log of the tapes.
364

EXIT CODE

366       The exit code of amreport is the ORed value of:
367        0  = success
368        1  = error
369        2  = a dle give strange message
370        4  = a dle failed
371        8  = Don't know the status of a dle (RESULT_MISSING in the report)
372        16 = tape error or no more tape
373

SEE ALSO

375       amanda(8), amflush(8)
376
377       The Amanda Wiki: : http://wiki.zmanda.com/
378

AUTHOR

380       Stefan G. Weichinger <sgw@amanda.org>
381
382
383
384Amanda 3.5.4                      07/27/2023                       AMREPORT(8)
Impressum