Skip to content

Commit cf9d787

Browse files
shdeshpa07shdeshpa07
committed
changes in metrics list
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
1 parent 07a32de commit cf9d787

File tree

2 files changed

+55
-49
lines changed

2 files changed

+55
-49
lines changed

‎modules/oadp-list-of-metrics.adoc

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

9-
These are the list of metrics provided by the OADP together with their https://prometheus.io/docs/concepts/metric_types/[Types].
9+
These are the list of metrics provided by the {oap-short} together with their https://prometheus.io/docs/concepts/metric_types/[Types]:
1010

11-
|===
12-
|Metric name |Description |Type
13-
14-
|`kopia_content_cache_hit_bytes`
15-
|Number of bytes retrieved from the cache
16-
|Counter
17-
18-
|`kopia_content_cache_hit_count`
19-
|Number of times content was retrieved from the cache
20-
|Counter
21-
22-
|`kopia_content_cache_malformed`
23-
|Number of times malformed content was read from the cache
24-
|Counter
25-
26-
|`kopia_content_cache_miss_count`
27-
|Number of times content was not found in the cache and fetched
28-
|Counter
11+
* `Velero`: Use these for general Velero metrics.
12+
* `podVolume`: Use these for pod volume backup metrics.
2913
30-
|`kopia_content_cache_missed_bytes`
31-
|Number of bytes retrieved from the underlying storage
32-
|Counter
14+
Refer to the following tables for a list of `Velero` and `podVolume` metrics.
3315

34-
|`kopia_content_cache_miss_error_count`
35-
|Number of times content could not be found in the underlying storage
36-
|Counter
3716

38-
|`kopia_content_cache_store_error_count`
39-
|Number of times content could not be saved in the cache
40-
|Counter
17+
[id="list-of-velero-metrics_{context}"]
18+
== List of velero metrics
4119

42-
|`kopia_content_get_bytes`
43-
|Number of bytes retrieved using `GetContent()`
44-
|Counter
45-
46-
|`kopia_content_get_count`
47-
|Number of times `GetContent()` was called
48-
|Counter
49-
50-
|`kopia_content_get_error_count`
51-
|Number of times `GetContent()` was called and the result was an error
52-
|Counter
20+
.Velero metrics
21+
|===
22+
|Metric name |Description |Type
5323

54-
|`kopia_content_get_not_found_count`
55-
|Number of times `GetContent()` was called and the result was not found
56-
|Counter
24+
| `velero_backup_tarball_size_bytes` | Size, in bytes, of a backup | Gauge
25+
| `velero_backup_total` | Current number of existent backups | Gauge
26+
| `velero_backup_attempt_total` | Total number of attempted backups | Counter
27+
| `velero_backup_success_total` | Total number of successful backups | Counter
28+
| `velero_backup_partial_failure_total` | Total number of partially failed backups | Counter
29+
| `velero_backup_failure_total` | Total number of failed backups | Counter
30+
| `velero_backup_validation_failure_total` | Total number of validation failed backups | Counter
31+
| `velero_backup_duration_seconds` | Time taken to complete backup, in seconds | Histogram
32+
| `velero_backup_deletion_attempt_total` | Total number of attempted backup deletions | Counter
33+
| `velero_backup_deletion_success_total` | Total number of successful backup deletions | Counter
34+
| `velero_backup_deletion_failure_total` | Total number of failed backup deletions | Counter
35+
| `velero_backup_last_successful_timestamp` | Last time a backup ran successfully, Unix timestamp in seconds | Gauge
36+
| `velero_backup_items_total` | Total number of items backed up | Gauge
37+
| `velero_backup_items_errors` | Total number of errors encountered during backup | Gauge
38+
| `velero_backup_warning_total` | Total number of warned backups | Counter
39+
| `velero_backup_last_status` | Last status of the backup. A value of 1 is success, 0 is failure | Gauge
40+
| `velero_restore_total` | Current number of existent restores | Gauge
41+
| `velero_restore_attempt_total` | Total number of attempted restores | Counter
42+
| `velero_restore_validation_failed_total` | Total number of failed restores failing validations | Counter
43+
| `velero_restore_success_total` | Total number of successful restores | Counter
44+
| `velero_restore_partial_failure_total` | Total number of partially failed restores | Counter
45+
| `velero_restore_failed_total` | Total number of failed restores | Counter
46+
| `velero_volume_snapshot_attempt_total``| Total number of attempted volume snapshots | Counter
47+
| `velero_volume_snapshot_success_total` | Total number of successful volume snapshots | Counter
48+
| `velero_volume_snapshot_failure_total` | Total number of failed volume snapshots | Counter
49+
| `velero_csi_snapshot_attempt_total` | Total number of CSI attempted volume snapshots | Counter
50+
| `velero_csi_snapshot_success_total` | Total number of CSI successful volume snapshots | Counter
51+
| `velero_csi_snapshot_failure_total` | Total number of CSI failed volume snapshots | Counter
5752

58-
|`kopia_content_write_bytes`
59-
|Number of bytes passed to `WriteContent()`
60-
|Counter
53+
|===
6154

62-
|`kopia_content_write_count`
63-
|Number of times `WriteContent()` was called
64-
|Counter
55+
[id="list-of-pod-volume-metrics_{context}"]
56+
== List of pod volume backup metrics
6557

58+
.Pod volume backup metrics
6659
|===
60+
|Metric name |Description |Type
6761

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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ $ oc edit configmap cluster-monitoring-config -n openshift-monitoring
3535
[source,yaml]
3636
----
3737
apiVersion: v1
38+
kind: ConfigMap
3839
data:
3940
config.yaml: |
4041
enableUserWorkload: true <1>
41-
kind: ConfigMap
4242
metadata:
4343
# ...
4444
----

0 commit comments

Comments
 (0)