Skip to content

Commit 60e2539

Browse files
committed
dev review
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
1 parent 55ce7bd commit 60e2539

File tree

3 files changed

+7
-31
lines changed

3 files changed

+7
-31
lines changed

modules/oadp-creating-service-monitor.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ servicemonitor.monitoring.coreos.com/oadp-service-monitor created
6464

6565
.Verification
6666

67-
* Confirm that the new service monitor is in an *Up* state by using the *Administrator* perspective of the {product-title} web console:
67+
* Confirm that the new service monitor is in an *Up* state by using the *Administrator* perspective of the {product-title} web console. It takes a few minutes for the service monitor to be in the *Up* state.
6868
.. Navigate to the *Observe* -> *Targets* page.
6969
.. Ensure the *Filter* is unselected or that the *User* source is selected and type `openshift-adp` in the `Text` search field.
7070
.. Verify that the status for the *Status* for the service monitor is *Up*.

modules/oadp-list-of-metrics.adoc

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,7 @@
66
[id="list-of-metrics_{context}"]
77
= List of available metrics
88

9-
These are the list of metrics provided by {oadp-short} together with their https://prometheus.io/docs/concepts/metric_types/[Types]:
10-
11-
* `Velero`: Use these for general Velero metrics.
12-
* `podVolume`: Use these for pod volume backup metrics.
13-
14-
Refer to the following tables for a list of `Velero` and `podVolume` metrics.
15-
16-
17-
[id="list-of-velero-metrics_{context}"]
18-
== List of velero metrics
9+
Refer to the following table for a list of `Velero` metrics provided by {oadp-short} together with their https://prometheus.io/docs/concepts/metric_types/[Types]:
1910

2011
.Velero metrics
2112
|===
@@ -29,6 +20,9 @@ Refer to the following tables for a list of `Velero` and `podVolume` metrics.
2920
| `velero_backup_failure_total` | Total number of failed backups | Counter
3021
| `velero_backup_validation_failure_total` | Total number of validation failed backups | Counter
3122
| `velero_backup_duration_seconds` | Time taken to complete backup, in seconds | Histogram
23+
| `velero_backup_duration_seconds_bucket` | Total count of observations for a bucket in the histogram for the metric `velero_backup_duration_seconds` | Counter
24+
| `velero_backup_duration_seconds_count` | Total count of observations for the metric `velero_backup_duration_seconds` | Counter
25+
| `velero_backup_duration_seconds_sum` | Total sum of observations for the metric `velero_backup_duration_seconds` | Counter
3226
| `velero_backup_deletion_attempt_total` | Total number of attempted backup deletions | Counter
3327
| `velero_backup_deletion_success_total` | Total number of successful backup deletions | Counter
3428
| `velero_backup_deletion_failure_total` | Total number of failed backup deletions | Counter
@@ -51,23 +45,3 @@ Refer to the following tables for a list of `Velero` and `podVolume` metrics.
5145
| `velero_csi_snapshot_failure_total` | Total number of CSI failed volume snapshots | Counter
5246

5347
|===
54-
55-
[id="list-of-pod-volume-metrics_{context}"]
56-
== List of pod volume backup metrics
57-
58-
.Pod volume backup metrics
59-
|===
60-
|Metric name |Description |Type
61-
62-
| `podVolume_pod_volume_backup_enqueue_count` | Total number of pod_volume_backup objects en-queued | Counter
63-
| `podVolume_pod_volume_backup_dequeue_count` | Total number of pod_volume_backup objects de-queued | Counter
64-
| `podVolume_pod_volume_operation_latency_seconds` | Time taken to complete pod volume operations, in seconds | Histogram
65-
| `podVolume_pod_volume_operation_latency_seconds_gauge` | Gauge metric indicating time taken, in seconds, to perform pod volume operations | Gauge
66-
| `podVolume_data_upload_success_total` | Total number of successful uploaded snapshots | Counter
67-
| `podVolume_data_upload_failure_total` | Total number of failed uploaded snapshots | Counter
68-
| `podVolume_data_upload_cancel_total` | Total number of canceled uploaded snapshots | Counter
69-
| `podVolume_data_download_success_total` | Total number of successful downloaded snapshots | Counter
70-
| `podVolume_data_download_failure_total` | Total number of failed downloaded snapshots | Counter
71-
| `podVolume_data_download_cancel_total` | Total number of canceled downloaded snapshots | Counter
72-
73-
|===

modules/oadp-monitoring-setup.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Monitoring metrics requires enabling monitoring for the user-defined projects an
1717
The {oadp-short} support for Prometheus metrics is offered on a best-effort basis and is not fully supported.
1818
====
1919

20+
For more information about setting up the monitoring stack, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{product-version}/html/monitoring/configuring-user-workload-monitoring[Configuring user workload monitoring].
21+
2022
.Prerequisites
2123

2224
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.

0 commit comments

Comments
 (0)