Skip to content

Commit

Permalink
Added the schedules page docs for the DB Console (cockroachdb#15462)
Browse files Browse the repository at this point in the history
  • Loading branch information
kathancox authored Nov 11, 2022
1 parent eb3fa50 commit aef7e6f
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 12 deletions.
7 changes: 7 additions & 0 deletions _includes/v22.2/backups/view-scheduled-backups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following:

- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories).
- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory).
- Use the [Schedules page](ui-schedules-page.html) in the [DB Console](ui-overview.html) to view a list of created backup schedules and their individual details.

For more details, see [`SHOW BACKUP`](show-backup.html).
6 changes: 6 additions & 0 deletions _includes/v22.2/sidebar-data/reference.json
Original file line number Diff line number Diff line change
Expand Up @@ -1817,6 +1817,12 @@
"/${VERSION}/ui-jobs-page.html"
]
},
{
"title": "Schedules Page",
"urls": [
"/${VERSION}/ui-schedules-page.html"
]
},
{
"title": "Advanced Debug Page",
"urls": [
Expand Down
Binary file added images/v22.2/schedule-id-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/v22.2/schedules-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions v22.2/create-schedule-for-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,12 +237,7 @@ Because the [`FULL BACKUP` clause](#full-backup-clause) was not included, Cockro

### View scheduled backup details

When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following:

- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories).
- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory).

For more details, see [`SHOW BACKUP`](show-backup.html).
{% include {{ page.version.version }}/backups/view-scheduled-backups.md %}

## See also

Expand Down
7 changes: 1 addition & 6 deletions v22.2/manage-a-backup-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,7 @@ For a tutorial on how to use Prometheus to set up monitoring and alerting, see [

## View scheduled backup details

When a [backup is created by a schedule](create-schedule-for-backup.html), it is stored within a collection of backups in the given location. To view details for a backup created by a schedule, you can use the following:

- `SHOW BACKUPS IN collectionURI` statement to [view a list of the full backup's subdirectories](show-backup.html#view-a-list-of-the-available-full-backup-subdirectories).
- `SHOW BACKUP FROM subdirectory IN collectionURI` statement to [view a list of the full and incremental backups that are stored in a specific full backup's subdirectory](show-backup.html#view-a-list-of-the-full-and-incremental-backups-in-a-specific-full-backup-subdirectory).

For more details, see [`SHOW BACKUP`](show-backup.html).
{% include {{ page.version.version }}/backups/view-scheduled-backups.md %}

## View and control the backup schedule

Expand Down
54 changes: 54 additions & 0 deletions v22.2/ui-schedules-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Schedules Page
summary: The Schedules page of the DB Console provides details about scheduled tasks performed by your cluster.
toc: true
docs_area: reference.db_console
---

{% include_cached new-in.html version="v22.2" %} The **Schedules** page of the DB Console provides details about the scheduled tasks performed by your cluster. These can include:

- [Scheduled backups](manage-a-backup-schedule.html)
- [Scheduled auto statistics compaction](cost-based-optimizer.html#table-statistics)
- [Row-level TTL](row-level-ttl.html)

To view these details, [access the DB console](ui-overview.html#db-console-access) and click **Schedules** in the left-hand navigation.

## Filter schedules

- Use the **Status** menu to filter schedules by schedule status, displaying all schedules, only active schedules, or only paused schedules.
- Use the **Show** menu to toggle displaying the latest 50 schedules or all schedules on the cluster.

## Schedules list

Use the **Schedules** list to see your active and paused schedules.

- To view schedule details click the schedule ID.
- If you drop a schedule, it will no longer be listed.

The following screenshot shows a list of backups and automated statistics compaction schedules:

<img src="{{ 'images/v22.2/schedules-page.png' | relative_url }}" alt="Schedules Page UI in the DB Console showing a list of schedules" style="border:1px solid #eee;max-width:100%" />

Column | Description
---------------------+--------------
Schedule ID | The unique ID for the schedule. This is used to [pause](pause-schedules.html), [resume](resume-schedules.html), and [drop](drop-schedules.html) schedules.
Label | The label given to the schedule on creation.
Status | The current status of the schedule, **Active** or **Paused**.
Next Execution Time (UTC) | The next time at which the scheduled task will run.
Recurrence | How often the schedule will run.
Jobs Running | The number of jobs currently running for that schedule.
Owner | The user that created the schedule.
Creation Time (UTC) | The time at which the user originally created the schedule.

## Schedule details

Click on a schedule ID to view the full SQL statement that the schedule runs. For example, the following screenshot shows the resulting [`BACKUP`](backup.html) statement for a full cluster backup recurring every day:

<img src="{{ 'images/v22.2/schedule-id-screen.png' | relative_url }}" alt="UI for each individual schedule ID displaying the CREATE SCHEDULE SQL statement" style="border:1px solid #eee;max-width:100%" />

You may also view a `protected_timestamp_record` on this page. This indicates that the schedule is actively managing its own [protected timestamp](architecture/storage-layer.html#protected-timestamps) records independently of [GC TTL](configure-replication-zones.html#gc-ttlseconds). See [Protected timestamps and scheduled backups](create-schedule-for-backup.html#protected-timestamps-and-scheduled-backups) for more detail.

## See also

- [`CREATE SCHEDULE FOR BACKUP`](create-schedule-for-backup.html)
- [Take Full and Incremental Backups](take-full-and-incremental-backups.html)

0 comments on commit aef7e6f

Please sign in to comment.