Skip to content

Restore metrics #1508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shlomi-noach merged 3 commits into from
Aug 13, 2023
Merged

Restore metrics #1508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16b0b37
metrics: add new restore metrics to docs
deepthi Jun 20, 2023
1cb6521
add metrics to 16.0 docs
deepthi Jun 20, 2023
4530410
restore metrics: add examples
deepthi Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/en/docs/16.0/reference/backup-and-restore/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
}
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/17.0/reference/backup-and-restore/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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
}
Expand Down
16 changes: 4 additions & 12 deletions content/en/docs/18.0/reference/backup-and-restore/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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",
}
```

Expand Down