Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions content/en/docs/16.0/reference/backup-and-restore/_index.md
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 content/en/docs/16.0/reference/backup-and-restore/metrics.md
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
}
```
2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/compatibility/_index.md
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
Copy link
Collaborator Author

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.

---

2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/errors/_index.md
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
---

2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/programs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: Programs
description: Reference documents for list of Vitess programs
notoc: true
weight: 2
weight: 4
---

2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/query-serving/_index.md
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
---
2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/vreplication/_index.md
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
---
1 change: 1 addition & 0 deletions content/en/docs/16.0/reference/vtadmin/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: VTAdmin
weight: 7
---

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
---

1 change: 1 addition & 0 deletions content/en/docs/16.0/reference/vtorc/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
title: VTOrc
weight: 9
---