-
Notifications
You must be signed in to change notification settings - Fork 225
content/en/docs/16.0: document backup/restore metrics #1354
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: Backup and Restore | ||
| description: "Backup and Restore Reference" | ||
| weight: 10 | ||
| aliases: ['/docs/reference/backup-and-restore/'] | ||
| skip_sections: true | ||
| --- |
31 changes: 31 additions & 0 deletions
31
content/en/docs/16.0/reference/backup-and-restore/metrics.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: Metrics | ||
| description: Metrics related to backup and restore functionality | ||
| weight: 10 | ||
| --- | ||
|
|
||
| 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](../../features/monitoring/#3-push-based-metrics-system). | ||
|
|
||
| ## Backup metrics | ||
|
|
||
| #### backup_duration_seconds | ||
|
|
||
| _backup_duration_seconds_ times the duration of a backup. | ||
|
|
||
| ## Restore metrics | ||
|
|
||
| #### 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.) | ||
|
|
||
| ``` | ||
| { | ||
| "backup_duration_seconds": 4, | ||
| "restore_duration_seconds": 6 | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: Compatibility | ||
| description: Reference documents for MySQL compatibility with Vitess | ||
| weight: 4 | ||
| weight: 5 | ||
| --- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: Errors | ||
| description: Detailed information about errors that the user might run into | ||
| weight: 5 | ||
| weight: 6 | ||
| --- | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,6 @@ | |
| title: Programs | ||
| description: Reference documents for list of Vitess programs | ||
| notoc: true | ||
| weight: 2 | ||
| weight: 4 | ||
| --- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: Query Serving | ||
| description: Query Serving related reference docs | ||
| weight: 1 | ||
| weight: 2 | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| title: VReplication | ||
| description: "VReplication vtctl commands" | ||
| weight: 1 | ||
| weight: 3 | ||
| aliases: ['/docs/reference/vreplication/v2/'] | ||
| skip_sections: true | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| --- | ||
| title: VTAdmin | ||
| weight: 7 | ||
| --- | ||
|
|
1 change: 1 addition & 0 deletions
1
content/en/docs/16.0/reference/vtctldclient-transition/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: vtctldclient Transition | ||
| description: Reference material for transitioning from `vtctlclient` to `vtctldclient` | ||
| weight: 8 | ||
| --- | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| --- | ||
| title: VTOrc | ||
| weight: 9 | ||
| --- | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rest of the changes in this PR are to preserve the current ordering of pages, and to ensure the new page added in this PR is at the bottom of the list.