This is the documentation for Vitess v16.0, an older release. See the v24.0 documentation for the latest release.

Metrics

Metrics related to backup and restore functionality

Backup and restore operations export several metrics using the expvars interface. These are available at the /debug/vars endpoint of Vtbackup's and VTTablet's http status pages. More details can be found here.

Backup metrics #

backup_duration_seconds #

backup_duration_seconds times the duration of a backup.

Restore metrics #

RestoredBackupTime, RestorePosition #

RestoredBackupTime captures the timestamp associated with the backup from which the current process was restored. RestorePosition captures the GTID position associated with that backup.

restore_duration_seconds #

restore_duration_seconds times the duration of a restore.

Example #

A snippet of vtbackup metrics after running it against the local example after creating the initial cluster

(Processed with jq for readability.)

{
  "RestorePosition": "MySQL56/f00e54ca-0fbf-11ee-ad84-eddb850690bf:1-61",
  "RestoredBackupTime": "2023-06-21T00:39:00Z",
  "backup_duration_seconds": 4,
  "restore_duration_seconds": 6
}