Mysql-zrm-reporter

From wiki.zmanda.com
Revision as of 22:20, 2 November 2006 by Paddy (talk | contribs) (→‎EXAMPLES)
Jump to navigation Jump to search

NAME

mysql-zrm-reporter - MySQL backup reporting tool.

SYNOPSIS

mysql-zrm-reporter [--fields <name1,name2,"name3, name4, name5" ....>]
                   [--destination <dir> ]
                   [--where  <fieldname=value>]
                   [--type  html]
                   [--output <filename>]
                   [--latest ]
                   [--show   <backup-method-info | backup-status-info  |
                     backup-retention-info | backup-performance-info |
                     restore-info |  selective-restore-info | 
                     replication-info | backup-app-performance-info > ]
                   [--help]

DESCRIPTION

This tool is part of Zmanda Recovery Manager for MySQL (MySQL ZRM). This tool can be used to provide reports about various MySQL database backup run parameters. Using mysql-zrm-reporter tool, administrator can generate pre-defined backup reports as well as user defined reports. The tool has a capability to generate backup reports in both HTML and text format. Backup reports are also available as RSS feed.

The format of parameters in the backup report can be configured using /etc/mysql-zrm/mysql-zrm-reporter.conf file. For supported formats, see mysql-zrm-reporter.conf(5).

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

html-report-directory
Directory location where text/HTML reports are written to. 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
URL of a directory under document root of the web server. Web server used for RSS feeds. If this value is not specified in the 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 webserver-url is specified. Example: /usr/share/mysql-zrm/plugins/RSS.header

BACKUP INFORMATION

The list of information available for each backup run:

backup-date
Date and time stamp of backup run.
mysql-version
MySQL server version.
backup-directory
The location of backup directory.
backup-level
Lists the backup-level of this backup. It will be 0 for a full backup and 1 for an incremental backup.
raw-databases
List of databases backed up using mysqlhotcopy. If raw-tables parameter is present, this will have only one database listed.
raw-tables
List of tables backed up using mysqlhotcopy. Refer to the raw-databases to find the name of the database these tables belongs to. This parameter will have valid values only if --tables parameter was specified for the backup run.
raw-databases-snapshot
List of databases backed up using lvm snapshots.
raw-tables-snapshot
List of tables backed up using mysqlhotcopy. Refer to the raw-databases-snapshot to find the name of the database these tables belongs to.
backup-time
Time taken for the complete backup run. Format is HH:MM:SS
read-locks-time
Time during which the read lock is held for each backup run. Format is HH:MM:SS
flush-logs-time
Time for flushing database pages to the disk. Format is HH:MM:SS
backup-size
The size of data (in megabytes) backed up in the backup run.
backup-status
Gives the status of the backup run. It can have 3 values. The values can be "Backup Failed" which indicates that there was a fatal error, "Backup done with errors" which indicates that there was some error during backup. Some of the databases and tables were probably backed up and "Backup succeeded" which indicates that the backup run was completed successfully.
logical-databases
List of databases backed up using mysqldump(1).
logical-tables
List of tables belonging to logical-databases backed up using mysqldump(1.
replication
List of names of the replication files backed up namely master.info and relay-log.info
slave-load-files
Names of SQL_LOAD* files that were backed up.
incremental
Names of the binary log files backed up.
backup-set
Lists the backup-set this backup belongs to.
comment
Comment about the backup added by the administrator in the mysql-zrm.conf(5) file.
retention-policy
Backup data retention policy. Backup image will be retained for the time specified as parameter. Time value can be in Days/Weeks/Months/Years. For example: if the value is "10D" means the backup image will be retained 10 days from the backup-date. 365 days in a year and 30 days in a month are assumed.
compress
Specifies that the backup is compressed. Default compression method is gzip program. The program used for compression is value for this parameter.
encrypt
Program used for encryption if the backups are encrypted.
host
Specifies the name of the host that was backed up.

OPTIONS

--destination <dir>
Specify the backup root directory. This parameter is optional and default value is /var/lib/mysql-zrm
--fields <name1,name2,name3...>
Specify list of backup parameters to display. List of valid field names are described in BACKUP INFORMATION section. This field is optional. If specific fields are not specified in the command line, backup-set, backup-date, backup-directory, backup-level, backup-status, comment are displayed by default. Spaces are not allowed in the list of names. If spaces (as in EXAMPLE 3), they should be in quotes.
--where <fieldname=value>
The tool will display the MySQL backup parameters where the field name matches value. This field is optional.
--type html
Output format of the report will be HTML.
--output <filename>
User should provide output file name to --output option, Tool creates HTML report(s) with name <filename> under "html" directory and text reports under "text" subdirectory. By default, these directories are created under the current working directory. The tool 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 tool will create "html-report-directoy" directory (if it does not exist) and output report with name file name will be written to "html" and/or "text" subdirectory under "html-report-directory" path.
--latest
Report about the most recent backup run.
--show <backup-method-info | backup-status-info | backup-retention-info | backup-performance-info | restore-info | selective-restore-info | replication-info | backup-app-performance-info>
This option displays predefined reports based on the option. The list of reports that are available are:
  • backup-status-info : backup-set,backup-date,backup-level,backup-status, backup comment
  • backup-method-info : backup-set,raw-databases,raw-databases,logical-databases
  • backup-retention-info : backup-set, backup-date, backup-level,backup-size,retention-policy
  • backup-performance-info : backup-set, backup-date, backup-level, backup-size, backup-size-compressed, backup-time
  • backup-app-performance-info : backup-set, backup-date, backup-level, backup-size, backup-time, read-locks-time, flush-logs-time
  • restore-info : backup-set, backup-date, backup-level,backup-directory
  • selective-restore-info : backup-set, backup-date, incremental
  • replication-info  : backup-set, backup-date, replication,slave-load-files
--help
Display help message and exit.

EXAMPLES

Following command displays backup date, location of backups, backup set name: 

mysql-zrm-reporter --destination /var/lib/mysql-zrm/backup \
                   --fields backup-date,backup-directory,backup-set

Following command displays size of backup, backup set name, and date of backup: 

mysql-zrm-reporter --destination /var/lib/mysql-zrm/backup \
                   --fields backup-date,backup-set,backup-size

Following command displays size of backup, backup set name, and date of backup for "config1" backup set: 

mysql-zrm-reporter --destination /var/lib/mysql-zrm/backup \
                   --fields "backup-date, backup-set, backup-size" \
                   --where backup-set=config1

Following command displays backup status report for "config1" backup set: 

mysql-zrm-reporter --destination /var/lib/mysql-zrm/backup \
                   --show backup-status-info \
                   --where backup-set=config1

Following command displays backup status report for "config1" backup set in HTML format and write the output to a file: 

mysql-zrm-reporter --destination /var/lib/mysql-zrm/backup \
                   --show backup-status-info --where backup-set=config1 \
                   --type html --output myreport.html

FILES

/var/lib/mysql-zrm
Directory under which all backup data is stored.
/etc/mysql-zrm/mysql-zrm-reporter.conf
Configuration file read by mysql-zrm-reporter tool.

RETURN VALUES

On success, zero is returned. On error,non-zero value is returned.

SEE ALSO

mysql-zrm(1), mysql-zrm-scheduler(1), mysql-zrm-reporter.conf(5), mysql(1), Zmanda Recovery Manager for MySQL

AUTHOR

Zmanda Inc. (http://www.zmanda.com)

Retrieved from ‘http://wiki.zmanda.com/index.php?title=Mysql-zrm-reporter&oldid=3609’