1mysql‐zrm‐reporter(1) mysql‐
2zrm‐reporter(1)
3
4
5
6NNAAMMEE
7 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr ‐ ZRM for MySQL backup reporting utili‐
8ty.
9
10SSYYNNOOPPSSIISS
11 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr [[‐‐‐‐ffiieellddss _n_a_m_e_1, _n_a_m_e_2, name3, name4,
12name5 ....]
13 [‐‐‐‐ddeessttiinnaattiioonn _d_i_r ]
14 [‐‐‐‐wwhheerree _f_i_e_l_d_n_a_m_e_=_v_a_l_u_e]
15 [‐‐‐‐ttyyppee _h_t_m_l]
16 [‐‐‐‐oouuttppuutt _f_i_l_e_n_a_m_e]
17 [‐‐‐‐llaatteesstt ]
18 [‐‐‐‐nnoohheeaaddeerr ]
19 [‐‐‐‐sshhooww bbaacckkuupp‐‐mmeetthhoodd‐‐iinnffoo |
20 bbaacckkuupp‐‐ssttaattuuss‐‐iinnffoo |
21 bbaacckkuupp‐‐rreetteennttiioonn‐‐iinnffoo |
22 bbaacckkuupp‐‐ppeerrffoorrmmaannccee‐‐iinnffoo |
23 rreessttoorree‐‐ffuullll‐‐iinnffoo |
24 rreessttoorree‐‐iinnccrr‐‐iinnffoo |
25 rreepplliiccaattiioonn‐‐iinnffoo |
26 bbaacckkuupp‐‐aapppp‐‐ppeerrffoorrmmaannccee‐‐iinnffoo ]
27 [‐‐‐‐hheellpp]
28
29
30DDEESSCCRRIIPPTTIIOONN
31 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr utility provides pre‐defined and
32user‐defined
33 reports about various MySQL database backup runs. The re‐
34ports can be in
35 text or HTML format. Backup report can be sent as a RSS
36feed.
37
38 Backup reports can be config‐
39ured using
40 //eettcc//mmyyssqqll‐‐zzrrmm//mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr..ccoonnff file parameters.
41For supported
42 formats, see mysql‐zrm‐reporter.conf(5).
43
44 ZRM for MySQL configuration file, mysql‐zrm.conf(5) file
45contains HTML
46 configuration and RSS feed configuration pa‐
47rameters for
48 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr utility. The list of
49mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr parameters
50 are:
51
52 html‐report‐directory
53 Set the directory where text/HTML reports are
54written. This
55 parameter is optional. Example:
56/var/www/html/mysql‐zrm‐reports/
57
58 html‐reports
59 List of pre‐defined report(s) to be generated af‐
60ter a backup
61 run. Example: backup‐status‐info
62
63 webserver‐url
64 RSS feeds URL of a directory under document
65root of the web
66 server. If this value is not specified in the
67mysql‐zrm.conf(5)
68 configuration file, RSS feeds will not be gener‐
69ated. Example:
70 http://backupserver.company.com/reports/
71
72 rss‐header‐location
73 The location of RSS feed properties file contain‐
74ing RSS feed
75 channel and item properties. This parameter must
76be provided if
77 _w_e_b_s_e_r_v_e_r_‐_u_r_l is specified. Example: /etc/mysql‐
78zrm/RSS.header
79
80
81BBAACCKKUUPP IINNFFOORRMMAATTIIOONN
82 Each backup run generates the following information about
83the backup:
84
85 bbaacckkuupp‐‐ddaattee
86 Date and time stamp of backup run.
87
88 mmyyssqqll‐‐vveerrssiioonn
89 MySQL server version.
90
91 bbaacckkuupp‐‐ddiirreeccttoorryy
92 The location of backup directory.
93
94 bbaacckkuupp‐‐lleevveell
95 Lists the backup‐level ‐ 0 for a full and 1 for
96incremental
97 backup.
98
99 rraaww‐‐ddaattaabbaasseess
100 List of databases backed up using mmyyssqqllhhoottccooppyy.
101If _r_a_w_‐_t_a_b_l_e_s
102 parameter is present, this will have only one data‐
103base listed.
104
105 rraaww‐‐ttaabblleess
106 List of tables backed up using mmyyssqqllhhoottccooppyy. The
107name of the
108 database these tables belong to is found under
109_r_a_w_‐_d_a_t_a_b_a_s_e_s.
110
111 rraaww‐‐ddaattaabbaasseess‐‐ssnnaappsshhoott
112 List of databases backed up using lvm snapshots.
113When _r_a_w_‐_t_a_b_l_e_s
114 parameter is specified, this will list only one
115database.
116
117 rraaww‐‐ttaabblleess‐‐ssnnaappsshhoott
118 List of tables backed up using mysqlhotcopy. The
119name of the
120 database these tables belong to is found under
121rraaww‐‐ddaattaabbaasseess.
122
123 bbaacckkuupp‐‐ttiimmee
124 Time taken for the complete backup run. Format is
125HH:MM:SS
126
127 rreeaadd‐‐lloocckkss‐‐ttiimmee
128 Time read lock was held during the backup
129run. Format is
130 HH:MM:SS
131
132 fflluusshh‐‐llooggss‐‐ttiimmee
133 Time for flushing database pages to the disk. For‐
134mat is HH:MM:SS
135
136 bbaacckkuupp‐‐ssiizzee
137 The size, in megabytes, of data backed up.
138
139 bbaacckkuupp‐‐ssttaattuuss
140 Status has three values. "Backup Failed" value
141means that there
142 was a fatal error. "Backup done with errors" means
143that though
144 there was some error during backup but some of the
145databases and
146 tables were probably backed up. "Backup succeeded"
147means that
148 the backup run was completed successfully.
149
150 llooggiiccaall‐‐ddaattaabbaasseess
151 List of databases backed up using mysqldump(1).
152When _‐_t_a_b_l_e_s
153 parameter is specified, this will only one data‐
154base.
155
156 llooggiiccaall‐‐ttaabblleess
157 List of tables belonging to _l_o_g_i_c_a_l_‐_d_a_t_a_b_a_s_e_s
158backed up using
159 mysqldump(1). The name of the database these tables
160belong to is
161 found under _‐_d_a_t_a_b_a_s_e_s.
162
163 rreepplliiccaattiioonn
164 List of replication files backed up namely
165master.info and
166 relay‐log.info
167
168 ssllaavvee‐‐llooaadd‐‐ffiilleess
169 Names of SQL_LOAD* files that were backed up.
170
171 iinnccrreemmeennttaall
172 Names of the binary log files backed up.
173
174 bbaacckkuupp‐‐sseett
175 Name of the backup set this backup belongs to.
176
177 ccoommmmeenntt
178 Comment about the backup added by the admin‐
179istrator in the
180 mysql‐zrm.conf(5) file.
181
182 rreetteennttiioonn‐‐ppoolliiccyy
183 Backup image will be retained for the time speci‐
184fied as parame‐
185 ter in Days/Weeks/Months/Years. For example: if
186the value is
187 "10D" means the backup image will be retained 10
188days from the
189 _b_a_c_k_u_p_‐_d_a_t_e. This policy assumes 365 days in a
190year and 30 days
191 in a month.
192
193 ccoommpprreessss
194 Specifies that the backup was compressed. Default
195compression
196 method is _g_z_i_p program. The program used for
197compression is
198 value for this parameter.
199
200 eennccrryypptt
201 Program used for encryption if the backups are en‐
202crypted.
203
204 hhoosstt Hostname of the MySQL server that was backed up.
205
206 ccoommpprreessss‐‐eennccrryypptt‐‐ttiimmee
207 Time taken by compression and/or encryption.
208This time is
209 included in the backup time
210
211 iinnnnooddbb‐‐ddaattaa
212 List of InnoDB shared data files backed up.
213
214 iinnnnooddbb‐‐llooggss
215 List of InnoDB logs backed up.
216
217
218OOPPTTIIOONNSS
219 ‐‐show _b_a_c_k_u_p_‐_m_e_t_h_o_d_‐_i_n_f_o | backup‐status‐info |
220_b_a_c_k_u_p_‐_r_e_t_e_n_t_i_o_n_‐_i_n_f_o
221 | _b_a_c_k_u_p_‐_p_e_r_f_o_r_m_a_n_c_e_‐_i_n_f_o | _r_e_s_t_o_r_e_‐_i_n_f_o |
222_s_e_l_e_c_t_i_v_e_‐_r_e_s_t_o_r_e_‐_i_n_f_o |
223 _r_e_p_l_i_c_a_t_i_o_n_‐_i_n_f_o
224 To display predefined reports set this option.
225The predefined
226 reports, and what they contain, are listed below:
227
228 bbaacckkuupp‐‐ssttaattuuss‐‐iinnffoo : backup‐set, backup‐date,
229backup‐level,
230 backup‐status, backup comment bbaacckkuupp‐‐mmeetthhoodd‐‐iinnffoo
231: backup‐set,
232 raw‐databases, raw‐databases, logical‐databases
233
234 bbaacckkuupp‐‐rreetteennttiioonn‐‐iinnffoo : backup‐set, backup‐date,
235backup‐level,
236 backup‐size, retention‐policy
237
238 bbaacckkuupp‐‐ppeerrffoorrmmaannccee‐‐iinnffoo : backup‐set, backup‐date,
239backup‐level,
240 backup‐size, backup‐size‐compressed, backup‐
241time, com‐
242 press‐encrypt‐time
243
244 bbaacckkuupp‐‐aapppp‐‐ppeerrffoorrmmaannccee‐‐iinnffoo : backup‐set,
245backup‐date,
246 backup‐level, backup‐size,backup‐time,
247read‐locks‐time,
248 flush‐logs‐time
249
250 rreessttoorree‐‐iinnffoo : backup‐set, backup‐date,
251backup‐level,
252 backup‐directory, backup‐status, comment
253
254 sseelleeccttiivvee‐‐rreessttoorree‐‐iinnffoo : backup‐set, backup‐date,
255incremental
256 rreepplliiccaattiioonn‐‐iinnffoo : backup‐set, backup‐date,
257replication,
258 slave‐load‐files
259
260
261 ‐‐‐‐ddeessttiinnaattiioonn _d_i_r
262 Set the backup root directory. This parameter
263is optional.
264 Default value is //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm
265
266 ‐‐‐‐ffiieellddss _n_a_m_e_1_,_n_a_m_e_2_,_n_a_m_e_3_._._.
267 Set the list of backup parameters to display.
268List of valid
269 field names are described in BACKUP INFORMATION
270section. This
271 field is optional. By
272default
273 _b_a_c_k_u_p_‐_s_e_t_,_b_a_c_k_u_p_‐_d_a_t_e_,_b_a_c_k_u_p_‐_l_e_v_e_l_,_b_a_c_k_u_p_‐_s_t_a_t_u_s_,_c_o_m_m_e_n_t
274are
275 displayed. Spaces are not allowed with in the
276parameter name
277 list. If spaces must be used, list must within
278quotes.
279
280 ‐‐‐‐wwhheerree _f_i_e_l_d_n_a_m_e_=_v_a_l_u_e
281 The utility will display the MySQL backup parame‐
282ters where the
283 ffiieelldd nnaammee matches vvaalluuee. This field is optional.
284
285 ‐‐‐‐ttyyppee _h_t_m_l
286 Report will be in HTML format.
287
288 ‐‐‐‐oouuttppuutt _f_i_l_e_n_a_m_e
289 HTML report will be written to _f_i_l_e_n_a_m_e under
290"html" directory
291 and text reports will be written to _f_i_l_e_n_a_m_e under
292"text" direc‐
293 tory. By default, these directories are created
294under the cur‐
295 rent working directory. The utility allows users
296to specify
297 explicit directory location for reports in
298mysql‐zrm.conf(5)
299 using "html‐report‐directory" parameter. If this
300parameter is
301 set, then the utility will create "html‐report‐di‐
302rectory" direc‐
303 tory (if it does not exist) and output report
304with name _f_i_l_e
305 _n_a_m_e will be written to "html" and/or "text" sub‐
306directory under
307 "html‐report‐directory" path.
308
309 ‐‐‐‐llaatteesstt
310 Report about the most recent backup run.
311
312 ‐‐‐‐nnoohheeaaddeerr
313 Generate TEXT reports with no page header, This op‐
314tion will be
315 ignored for HTML reports.
316
317 ‐‐‐‐hheellpp Displays help message and exits.
318
319EEXXAAMMPPLLEESS
320 To display backup date, location of backups, and backup
321set name use:
322 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr ‐‐‐‐ddeessttiinnaattiioonn
323//vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//bbaacckkuupp ‐‐‐‐ffiieellddss
324 bbaacckkuupp‐‐ddaattee,,bbaacckkuupp‐‐ddiirreeccttoorryy,,bbaacckkuupp‐‐sseett
325
326 To display backup date, backup set name, and size
327of backup use:
328 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr ‐‐‐‐ddeessttiinnaattiioonn
329//vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//bbaacckkuupp ‐‐‐‐ffiieellddss
330 bbaacckkuupp‐‐ddaattee,,bbaacckkuupp‐‐sseett,,bbaacckkuupp‐‐ssiizzee
331
332 To display size of backup, backup set name, and date
333of backup for
334 "config1" backup set use: mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr
335‐‐‐‐ddeessttiinnaattiioonn
336 //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//bbaacckkuupp ‐‐‐‐ffiieellddss bbaacckkuupp‐‐ddaattee,,
337bbaacckkuupp‐‐sseett,, bbaacckkuupp‐‐ssiizzee
338 ‐‐‐‐wwhheerree bbaacckkuupp‐‐sseett==ccoonnffiigg11
339
340 To display backup status report for "config1" back‐
341up set use:
342 mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr ‐‐‐‐ddeessttiinnaattiioonn
343//vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//bbaacckkuupp ‐‐‐‐sshhooww
344 bbaacckkuupp‐‐ssttaattuuss‐‐iinnffoo ‐‐‐‐wwhheerree bbaacckkuupp‐‐sseett==ccoonnffiigg11
345
346 To display backup status report for "config1" backup set
347in HTML format
348 and write a file use: mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr
349‐‐‐‐ddeessttiinnaattiioonn
350 //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm//bbaacckkuupp ‐‐‐‐sshhooww
351bbaacckkuupp‐‐ssttaattuuss‐‐iinnffoo ‐‐‐‐wwhheerree
352 bbaacckkuupp‐‐sseett==ccoonnffiigg11 ‐‐‐‐ttyyppee hhttmmll ‐‐‐‐oouuttppuutt mmyyrreeppoorrtt..hhttmmll
353
354
355FFIILLEESS
356 //vvaarr//lliibb//mmyyssqqll‐‐zzrrmm
357 Directory under which all backup data is stored.
358
359
360 //eettcc//mmyyssqqll‐‐zzrrmm//mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr..ccoonnff
361 Configuration file read by mmyyssqqll‐‐zzrrmm‐‐rreeppoorrtteerr util‐
362ity.
363
364
365RREETTUURRNN VVAALLUUEESS
366 On success, zero is returned. On error, non‐zero value
367is returned.
368 Output messages are written to STDOUT and error messages
369are to STDERR.
370
371
372SSEEEE AALLSSOO AAUUTTHHOORR
373 Zmanda Inc. (http://www.zmanda.com)
374
375
376
377Zmanda, Inc. ZRM for MySQL mysql‐
378zrm‐reporter(1)
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396