mysql-zrm-reporter man page

mysql-zrm-reporter(1)                                    mysql-zrm-reporter(1)

NNAAMMEE
      mmyyssqqll--zzrrmm--rreeppoorrtteerr - ZRM for MySQL backup reporting utility.

SSYYNNOOPPSSIISS
      mmyyssqqll--zzrrmm--rreeppoorrtteerr [[----ffiieellddss _n_a_m_e_1, _n_a_m_e_2, name3, name4, name5 ....]
                      [----ddeessttiinnaattiioonn _d_i_r ]
                      [----wwhheerree  _f_i_e_l_d_n_a_m_e_=_v_a_l_u_e]
                      [----ttyyppee  _h_t_m_l]
                      [----oouuttppuutt _f_i_l_e_n_a_m_e]
                      [----llaatteesstt ]
                      [----nnoohheeaaddeerr ]
                      [----sshhooww  bbaacckkuupp--mmeetthhoodd--iinnffoo |
                               bbaacckkuupp--ssttaattuuss--iinnffoo |
                               bbaacckkuupp--rreetteennttiioonn--iinnffoo |
                               bbaacckkuupp--ppeerrffoorrmmaannccee--iinnffoo |
                               rreessttoorree--ffuullll--iinnffoo |
                               rreessttoorree--iinnccrr--iinnffoo |
                               rreepplliiccaattiioonn--iinnffoo |
                               bbaacckkuupp--aapppp--ppeerrffoorrmmaannccee--iinnffoo ]
                      [----hheellpp]

DDEESSCCRRIIPPTTIIOONN
      mmyyssqqll--zzrrmm--rreeppoorrtteerr   utility   provides  pre-defined  and  user-defined
      reports about various MySQL database backup runs. The reports can be in
      text or HTML format. Backup report can be sent as a RSS feed.

      Backup        reports        can        be       configured       using
      //eettcc//mmyyssqqll--zzrrmm//mmyyssqqll--zzrrmm--rreeppoorrtteerr..ccoonnff file parameters.  For  supported
      formats, see mysql-zrm-reporter.conf(5).

      ZRM  for MySQL configuration file, mysql-zrm.conf(5) file contains HTML
      configuration   and   RSS    feed    configuration    parameters    for
      mmyyssqqll--zzrrmm--rreeppoorrtteerr  utility.  The list of mmyyssqqll--zzrrmm--rreeppoorrtteerr parameters
      are:

      html-report-directory
             Set the directory where  text/HTML  reports  are  written.  This
             parameter is optional. Example: /var/www/html/mysql-zrm-reports/

      html-reports
             List of pre-defined report(s) to be  generated  after  a  backup
             run. Example: backup-status-info

      webserver-url
             RSS  feeds  URL  of  a  directory under document root of the web
             server. If this value is not specified in the  mysql-zrm.conf(5)
             configuration  file,  RSS  feeds will not be generated. Example:
             http://backupserver.company.com/reports/

      rss-header-location
             The location of RSS feed properties  file  containing  RSS  feed
             channel  and item properties. This parameter must be provided if
             _w_e_b_s_e_r_v_e_r_-_u_r_l is specified. Example: /etc/mysql-zrm/RSS.header

BBAACCKKUUPP IINNFFOORRMMAATTIIOONN
      Each backup run generates the following information about the backup:

      bbaacckkuupp--ddaattee
             Date and time stamp of backup run.

      mmyyssqqll--vveerrssiioonn
             MySQL server version.

      bbaacckkuupp--ddiirreeccttoorryy
             The location of backup directory.

      bbaacckkuupp--lleevveell
             Lists the backup-level - 0 for a  full  and  1  for  incremental
             backup.

      rraaww--ddaattaabbaasseess
             List  of  databases  backed up using mmyyssqqllhhoottccooppyy. If _r_a_w_-_t_a_b_l_e_s
             parameter is present, this will have only one database listed.

      rraaww--ttaabblleess
             List of tables backed up using mmyyssqqllhhoottccooppyy.  The  name  of  the
             database these tables belong to is found under _r_a_w_-_d_a_t_a_b_a_s_e_s.

      rraaww--ddaattaabbaasseess--ssnnaappsshhoott
             List of databases backed up using lvm snapshots. When _r_a_w_-_t_a_b_l_e_s
             parameter is specified, this will list only one database.

      rraaww--ttaabblleess--ssnnaappsshhoott
             List of tables backed up using mysqlhotcopy.  The  name  of  the
             database these tables belong to is found under rraaww--ddaattaabbaasseess.

      bbaacckkuupp--ttiimmee
             Time taken for the complete backup run. Format is HH:MM:SS

      rreeaadd--lloocckkss--ttiimmee
             Time  read  lock  was  held  during  the  backup  run. Format is
             HH:MM:SS

      fflluusshh--llooggss--ttiimmee
             Time for flushing database pages to the disk. Format is HH:MM:SS

      bbaacckkuupp--ssiizzee
             The size, in megabytes, of data backed up.

      bbaacckkuupp--ssttaattuuss
             Status  has three values. "Backup Failed" value means that there
             was a fatal error. "Backup done with errors" means  that  though
             there was some error during backup but some of the databases and
             tables were probably backed up. "Backup  succeeded"  means  that
             the backup run was completed successfully.

      llooggiiccaall--ddaattaabbaasseess
             List  of  databases  backed  up using mysqldump(1). When _-_t_a_b_l_e_s
             parameter is specified, this will only one database.

      llooggiiccaall--ttaabblleess
             List of tables belonging to _l_o_g_i_c_a_l_-_d_a_t_a_b_a_s_e_s  backed  up  using
             mysqldump(1). The name of the database these tables belong to is
             found under _-_d_a_t_a_b_a_s_e_s.

      rreepplliiccaattiioonn
             List of replication  files  backed  up  namely  master.info  and
             relay-log.info

      ssllaavvee--llooaadd--ffiilleess
             Names of SQL_LOAD* files that were backed up.

      iinnccrreemmeennttaall
             Names of the binary log files backed up.

      bbaacckkuupp--sseett
             Name of the backup set this backup belongs to.

      ccoommmmeenntt
             Comment  about  the  backup  added  by  the administrator in the
             mysql-zrm.conf(5) file.

      rreetteennttiioonn--ppoolliiccyy
             Backup image will be retained for the time specified as  parame-
             ter  in  Days/Weeks/Months/Years.  For  example: if the value is
             "10D" means the backup image will be retained 10 days  from  the
             _b_a_c_k_u_p_-_d_a_t_e.  This policy assumes 365 days in a year and 30 days
             in a month.

      ccoommpprreessss
             Specifies that the backup was  compressed.  Default  compression
             method  is  _g_z_i_p  program.  The  program used for compression is
             value for this parameter.

      eennccrryypptt
             Program used for encryption if the backups are encrypted.

      hhoosstt   Hostname of the MySQL server that was backed up.

      ccoommpprreessss--eennccrryypptt--ttiimmee
             Time taken  by  compression  and/or  encryption.  This  time  is
             included in the backup time

      iinnnnooddbb--ddaattaa
             List of InnoDB shared data files backed up.

      iinnnnooddbb--llooggss
             List of InnoDB logs backed up.

OOPPTTIIOONNSS
      --show  _b_a_c_k_u_p_-_m_e_t_h_o_d_-_i_n_f_o | backup-status-info | _b_a_c_k_u_p_-_r_e_t_e_n_t_i_o_n_-_i_n_f_o
      | _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  |  _s_e_l_e_c_t_i_v_e_-_r_e_s_t_o_r_e_-_i_n_f_o  |
      _r_e_p_l_i_c_a_t_i_o_n_-_i_n_f_o
             To  display  predefined  reports set this option. The predefined
             reports, and what they contain, are listed below:

             bbaacckkuupp--ssttaattuuss--iinnffoo  :  backup-set,  backup-date,   backup-level,
             backup-status,  backup  comment bbaacckkuupp--mmeetthhoodd--iinnffoo : backup-set,
             raw-databases, raw-databases, logical-databases

             bbaacckkuupp--rreetteennttiioonn--iinnffoo : backup-set,  backup-date,  backup-level,
             backup-size, retention-policy

             bbaacckkuupp--ppeerrffoorrmmaannccee--iinnffoo : backup-set, backup-date, backup-level,
             backup-size,    backup-size-compressed,    backup-time,     com-
             press-encrypt-time

             bbaacckkuupp--aapppp--ppeerrffoorrmmaannccee--iinnffoo     :    backup-set,    backup-date,
             backup-level,     backup-size,backup-time,      read-locks-time,
             flush-logs-time

             rreessttoorree--iinnffoo    :    backup-set,    backup-date,   backup-level,
             backup-directory, backup-status, comment

             sseelleeccttiivvee--rreessttoorree--iinnffoo :  backup-set,  backup-date,  incremental
             rreepplliiccaattiioonn--iinnffoo   :   backup-set,   backup-date,   replication,
             slave-load-files

      ----ddeessttiinnaattiioonn _d_i_r
             Set the backup  root  directory.  This  parameter  is  optional.
             Default value is //vvaarr//lliibb//mmyyssqqll--zzrrmm

      ----ffiieellddss _n_a_m_e_1_,_n_a_m_e_2_,_n_a_m_e_3_._._.
             Set  the  list  of  backup parameters to display.  List of valid
             field names are described in BACKUP  INFORMATION  section.  This
             field          is          optional.          By         default
             _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    are
             displayed.  Spaces  are  not  allowed with in the parameter name
             list. If spaces must be used, list must within quotes.

      ----wwhheerree _f_i_e_l_d_n_a_m_e_=_v_a_l_u_e
             The utility will display the MySQL backup parameters  where  the
             ffiieelldd nnaammee matches vvaalluuee. This field is optional.

      ----ttyyppee _h_t_m_l
             Report will be in HTML format.

      ----oouuttppuutt _f_i_l_e_n_a_m_e
             HTML  report  will be written to _f_i_l_e_n_a_m_e under "html" directory
             and text reports will be written to _f_i_l_e_n_a_m_e under "text" direc-
             tory.   By default, these directories are created under the cur-
             rent working directory.  The utility  allows  users  to  specify
             explicit  directory  location  for  reports in mysql-zrm.conf(5)
             using "html-report-directory" parameter. If  this  parameter  is
             set, then the utility will create "html-report-directory" direc-
             tory (if it does not exist) and output  report  with  name  _f_i_l_e
             _n_a_m_e  will be written to "html" and/or "text" subdirectory under
             "html-report-directory" path.

      ----llaatteesstt
             Report about the most recent backup run.

      ----nnoohheeaaddeerr
             Generate TEXT reports with no page header, This option  will  be
             ignored for HTML reports.

      ----hheellpp Displays help message and exits.

EEXXAAMMPPLLEESS
      To  display  backup date, location of backups, and backup set name use:
      mmyyssqqll--zzrrmm--rreeppoorrtteerr  ----ddeessttiinnaattiioonn  //vvaarr//lliibb//mmyyssqqll--zzrrmm//bbaacckkuupp   ----ffiieellddss
      bbaacckkuupp--ddaattee,,bbaacckkuupp--ddiirreeccttoorryy,,bbaacckkuupp--sseett

      To  display  backup  date,  backup  set  name,  and size of backup use:
      mmyyssqqll--zzrrmm--rreeppoorrtteerr  ----ddeessttiinnaattiioonn  //vvaarr//lliibb//mmyyssqqll--zzrrmm//bbaacckkuupp   ----ffiieellddss
      bbaacckkuupp--ddaattee,,bbaacckkuupp--sseett,,bbaacckkuupp--ssiizzee

      To  display  size  of  backup, backup set name, and date of backup  for
      "config1"   backup   set    use:    mmyyssqqll--zzrrmm--rreeppoorrtteerr    ----ddeessttiinnaattiioonn
      //vvaarr//lliibb//mmyyssqqll--zzrrmm//bbaacckkuupp ----ffiieellddss bbaacckkuupp--ddaattee,, bbaacckkuupp--sseett,, bbaacckkuupp--ssiizzee
      ----wwhheerree bbaacckkuupp--sseett==ccoonnffiigg11

      To  display  backup  status  report  for  "config1"  backup  set   use:
      mmyyssqqll--zzrrmm--rreeppoorrtteerr   ----ddeessttiinnaattiioonn   //vvaarr//lliibb//mmyyssqqll--zzrrmm//bbaacckkuupp   ----sshhooww
      bbaacckkuupp--ssttaattuuss--iinnffoo ----wwhheerree bbaacckkuupp--sseett==ccoonnffiigg11

      To display backup status report for "config1" backup set in HTML format
      and    write    a    file    use:    mmyyssqqll--zzrrmm--rreeppoorrtteerr   ----ddeessttiinnaattiioonn
      //vvaarr//lliibb//mmyyssqqll--zzrrmm//bbaacckkuupp     ----sshhooww     bbaacckkuupp--ssttaattuuss--iinnffoo     ----wwhheerree
      bbaacckkuupp--sseett==ccoonnffiigg11 ----ttyyppee hhttmmll ----oouuttppuutt mmyyrreeppoorrtt..hhttmmll

FFIILLEESS
      //vvaarr//lliibb//mmyyssqqll--zzrrmm
             Directory under which all backup data is stored.

      //eettcc//mmyyssqqll--zzrrmm//mmyyssqqll--zzrrmm--rreeppoorrtteerr..ccoonnff
             Configuration file read by mmyyssqqll--zzrrmm--rreeppoorrtteerr utility.

RREETTUURRNN VVAALLUUEESS
      On  success,  zero  is  returned. On error, non-zero value is returned.
      Output messages are written to STDOUT and error messages are to STDERR.

SSEEEE AALLSSOO AAUUTTHHOORR
      Zmanda Inc. (http://www.zmanda.com)

Zmanda, Inc.                    ZRM for MySQL            mysql-zrm-reporter(1)

Referenced By

mysql-zrm(1), mysql-zrm-abort-backup(1), mysql-zrm-backup(1), mysql-zrm-check(1), mysql-zrm.conf(5), mysql-zrm-extract-backup(1), mysql-zrm-list(1), mysql-zrm-parse-binlogs(1), mysql-zrm-purge(1), mysql-zrm-reporter.conf(5), mysql-zrm-restore(1), mysql-zrm-scheduler(1), mysql-zrm-verify-backup(1).