User Defined Reports

User defined reports can be obtained using mysql-zrm-reporter utility. Following command produces report containing MySQL server host name, MySQL version and Backup time.

# mysql-zrm-reporter --fields host,mysql-version,backup-time
          backup_set  host                 mysql_version       backup_time
   ---------------------------------------------------------------------------
             Daily   localhost             5.0.24-standard-lo  00:05:05
                                           g
            Weekly   host2.company.com     4.0.24-standard-lo  00:22:06
                                           g

All backup parameter field names can be passed as parameters to fields argument to display select set of fields.

These parameters are listed below Individual field's display can be controlled by format parameters specified below. Reports as a whole, can be formatted in HTML or TEXT formats.

User defined reports are also automatically generated when backup takes place. Email notification can be sent about the report. HTML reports can be configured to be available as RSS feed.

Backup parameters

backup-set

Name of the Backup set

backup-date

Date and time stamp of when the backup was done.

backup-level

Backup level (full or incremental). Full backup is 0. Incremental backup is level 1.

backup-type

Backup type - regular or quick (snapshot).

backup-directory

The location of backup directory on the machine where ZRM for MySQL is running.

retention-policy

Retention time for the backup image.

mysql-version

Version of the MySQL server used to backup the backup set. When MySQL server is being upgraded to a newer version, this field can be used to check the MySQL version of the backup images.

compress

Compression program used for backup data compression.

encrypt

Encryption program used for backup data encryption.

comment

Comments about the backup set or the backup run

Tables/Databases that were backed up

host

Host name of the MySQL server.

raw-databases

List of databases that have raw backups - backups done using the mysqlhotcopy command. If the raw-tables field is present, all the tables listed in raw-tables belong to the database in this parameter.

raw-databases-snapshot

List of databases backed up using snapshots.

raw-tables

List of tables backed up using the mysqlhotcopy command. All the tables listed in this parameter belong to the database in the raw-databases field. This parameter will have valid values only if --tables parameter was specified for the backup run in the mysql-zrm.conf configuration file.

raw-tables-snapshot

List of tables backed up using snapshots. All the tables listed in this parameter belong to the database in the raw-tables-snapshot field.

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

Names of replication files that were backed up - namely master.info and relay-log.info

slave-load-files

Names of SQL_LOAD* files that were backed up

incremental

Names of Binary log files that are part of incremental backup.

Status and performance of backup run

backup-time

Time taken by the backup run. The time includes the time for compression and encryption if these features were used during backup run. Format is HH:MM:SS

read-locks-time

During backups, the mysql-zrm utility holds the read lock on the database(s) or the table(s) that being backed up. The option reports that time.Format is HH:MM:SS.

flush-logs-time

The time taken to flush database pages from memory to disk. All modified database pages written from memory to the disk during backup for some backup methods. Format is HH:MM:SS.

backup-size

Size of backup image in MB.

backup-size-compressed

Gives the size of backup data after compression and encryption

backup-status

Status of the backup run. The values can be Backup Failed, Backup done with errors, and Backup succeeded.

• Backup Failed means there was a fatal error and backup was not completed.
• Backup done with errors means there were errors during backup, not all tables/databases in the backup set were not backed up. To find out which databases or tables were backed up successfully, see mysql-zrm log file.
• Backup succeeded means the backup was successful.