Restore metrics (#1508)

* metrics: add new restore metrics to docs Signed-off-by: deepthi <[email protected]> * add metrics to 16.0 docs Signed-off-by: deepthi <[email protected]> * restore metrics: add examples Signed-off-by: deepthi <[email protected]> --------- Signed-off-by: deepthi <[email protected]>
vitessio · Aug 13, 2023 · f6d4f32 · f6d4f32
1 parent 1657711
commit f6d4f32
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/content/en/docs/16.0/reference/backup-and-restore/metrics.md b/content/en/docs/16.0/reference/backup-and-restore/metrics.md
@@ -14,6 +14,10 @@ _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.
@@ -25,6 +29,8 @@ _restore_duration_seconds_ times the duration of a restore.
 
 ```
 {
+  "RestorePosition": "MySQL56/f00e54ca-0fbf-11ee-ad84-eddb850690bf:1-61",
+  "RestoredBackupTime": "2023-06-21T00:39:00Z",
   "backup_duration_seconds": 4,
   "restore_duration_seconds": 6
 }

diff --git a/content/en/docs/17.0/reference/backup-and-restore/metrics.md b/content/en/docs/17.0/reference/backup-and-restore/metrics.md
@@ -40,6 +40,10 @@ Depending on the Backup Engine and Backup Storage in-use, a restore may be a com
 
 These operations are counted and timed, and the number of bytes consumed or produced by each stage of the pipeline are counted as well.
 
+#### 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
 
 **Deprecated**
@@ -123,6 +127,8 @@ _DurationByPhaseSeconds_ exports timings for these individual phases.
     "BackupEngine.Builtin.Destination:Close": 26954624,
     "BackupStorage.File.File:Read": 102416075
   },
+  "RestorePosition": "MySQL56/f00e54ca-0fbf-11ee-ad84-eddb850690bf:1-61",
+  "RestoredBackupTime": "2023-06-21T00:39:00Z",
   "backup_duration_seconds": 4,
   "restore_duration_seconds": 6
 }

diff --git a/content/en/docs/18.0/reference/backup-and-restore/metrics.md b/content/en/docs/18.0/reference/backup-and-restore/metrics.md
@@ -20,12 +20,6 @@ Depending on the Backup Engine and Backup Storage in-use, a backup may be a comp
 
 These operations are counted and timed, and the number of bytes consumed or produced by each stage of the pipeline are counted as well.
 
-#### backup_duration_seconds
-
-**Deprecated**
-
-_backup_duration_seconds_ times the duration of a backup. This metric is deprecated and will be removed in a future release. Use _BackupDurationNanoseconds_ instead.
-
 ## Restore metrics
 
 Metrics related to restore operations are available in both Vtbackup and VTTablet.
@@ -40,11 +34,9 @@ Depending on the Backup Engine and Backup Storage in-use, a restore may be a com
 
 These operations are counted and timed, and the number of bytes consumed or produced by each stage of the pipeline are counted as well.
 
-#### restore_duration_seconds
-
-**Deprecated**
+#### RestoredBackupTime, RestorePosition
 
-_restore_duration_seconds_ times the duration of a restore. This metric is deprecated and will be removed in a future release. Use _RestoreDurationNanoseconds_ instead.
+_RestoredBackupTime_ captures the timestamp associated with the backup from which the current process was restored. _RestorePosition_ captures the GTID position associated with that backup.
 
 ## Vtbackup metrics
 
@@ -123,8 +115,8 @@ _DurationByPhaseSeconds_ exports timings for these individual phases.
     "BackupEngine.Builtin.Destination:Close": 26954624,
     "BackupStorage.File.File:Read": 102416075
   },
-  "backup_duration_seconds": 4,
-  "restore_duration_seconds": 6
+  "RestorePosition": "MySQL56/f00e54ca-0fbf-11ee-ad84-eddb850690bf:1-61",
+  "RestoredBackupTime": "2023-06-21T00:39:00Z",
 }
 ```