CockroachDB includes metrics to monitor backup, restore, and scheduled backup jobs. You can use monitoring integrations to alert when there are anomalies, such as backups that have failed or restore jobs encountering a retryable error. We recommend setting up monitoring to alert when anomalies occur.
Depending on the tier of your CockroachDB Cloud cluster, you can use the following tools to monitor backup and restore metrics:
| CockroachDB Standard | CockroachDB Advanced | CockroachDB Basic | |
|---|---|---|---|
| Cloud Console Metrics page | ✔ | ✔ | ✔ |
| Prometheus | ✔ | ✔ | |
| Datadog | ✔ | ✔ |
You can then use the following SQL statements to inspect details relating to schedules, jobs, and backups:
For detail on managed backups that Cockroach Labs stores for your CockroachDB Cloud cluster, refer to the Backup and Restore page in the Cloud Console.
Metrics are reported per node. Therefore, it is necessary to retrieve metrics from every node in the cluster. For example, if you are monitoring whether a backup fails, it is necessary to track scheduled_backup_failed on each node.
Prometheus
This section outlines the available backup and restore job metrics with Prometheus. For instructions on accessing the metricexport endpoint for Prometheus, refer to:
- Export Metrics From a CockroachDB Advanced Cluster.
- Export Metrics From a CockroachDB Standard Cluster.
We recommend the following guidelines:
- Use the
schedules.BACKUP.last-completed-timemetric to monitor the specific backup job or jobs you would use to recover from a disaster. - Configure alerting on the
schedules.BACKUP.last-completed-timemetric to watch for cases where the timestamp has not moved forward as expected.
| Metric | Description |
|---|---|
schedules.BACKUP.failed |
The number of scheduled backup jobs that have failed. Note: A stuck scheduled job will not increment this metric. |
schedules.BACKUP.last-completed-time |
The Unix timestamp of the most recently completed scheduled backup specified as maintaining this metric. Note: This metric only updates if the schedule was created with the updates_cluster_last_backup_time_metric option. |
schedules.BACKUP.protected_age_sec |
The age of the oldest protected timestamp record protected by backup schedules. |
schedules.BACKUP.protected_record_count |
The number of protected timestamp records held by backup schedules. |
schedules.BACKUP.started |
The number of scheduled backup jobs that have started. |
schedules.BACKUP.succeeded |
The number of scheduled backup jobs that have succeeded. |
schedules.round.reschedule_skip |
The number of schedules that were skipped due to a currently running job. A value greater than 0 indicates that a previous backup was still running when a new scheduled backup was supposed to start. This corresponds to the on_previous_running=skip schedule option. |
schedules.round.reschedule_wait |
The number of schedules that were rescheduled due to a currently running job. A value greater than 0 indicates that a previous backup was still running when a new scheduled backup was supposed to start. This corresponds to the on_previous_running=wait schedule option. |
jobs.backup.currently_paused |
The number of backup jobs currently considered paused. |
jobs.backup.currently_running |
The number of backup jobs currently running in Resume or OnFailOrCancel state. |
jobs.backup.fail_or_cancel_retry_error |
The number of backup jobs that failed with a retryable error on their failure or cancelation process. |
jobs.backup.fail_or_cancel_completed |
The number of backup jobs that successfully completed their failure or cancelation process. |
jobs.backup.fail_or_cancel_failed |
The number of backup jobs that failed with a non-retryable error on their failure or cancelation process. |
jobs.backup.protected_age_sec |
The age of the oldest protected timestamp record protected by backup jobs. |
jobs.backup.protected_record_count |
The number of protected timestamp records held by backup jobs. |
jobs.backup.resume_failed |
The number of backup jobs that failed with a non-retryable error. |
jobs.backup.resume_retry_error |
The number of backup jobs that failed with a retryable error. |
jobs.restore.currently_paused |
The number of restore jobs currently considered paused. |
jobs.restore.currently_running |
The number of restore jobs currently running in Resume or OnFailOrCancel state. |
jobs.restore.fail_or_cancel_failed |
The number of restore jobs that failed with a non-retriable error on their failure or cancelation process. |
jobs.restore.fail_or_cancel_retry_error |
The number of restore jobs that failed with a retryable error on their failure or cancelation process. |
jobs.restore.protected_age_sec |
The age of the oldest protected timestamp record protected by restore jobs. |
jobs.restore.protected_record_count |
The number of protected timestamp records held by restore jobs. |
jobs.restore.resume_completed |
The number of restore jobs that successfully resumed to completion. |
jobs.restore.resume_failed |
The number of restore jobs that failed with a non-retryable error. |
jobs.restore.resume_retry_error |
The number of restore jobs that failed with a retryable error. |
Datadog
You can export the following schedule backup metrics to Datadog using the Cloud API, or access the Cloud Console Monitoring page to enable the integration.
For instructions, refer to:
- Export Metrics From a CockroachDB Advanced Cluster.
- Export Metrics From a CockroachDB Standard Cluster.
Available metrics in Datadog
| Metric | Description |
|---|---|
schedules.BACKUP.succeeded |
The number of scheduled backup jobs that have succeeded. |
schedules.BACKUP.started |
The number of scheduled backup jobs that have started. |
schedules.BACKUP.last_completed_time |
The Unix timestamp of the most recently completed backup by a schedule specified as maintaining this metric. |
schedules.BACKUP.failed |
The number of scheduled backup jobs that have failed. |
Was this helpful?
