Skip to content

Commit 062a3a9

Browse files
shdeshpa07shdeshpa07
authored
Merge pull request #96651 from shdeshpa07/oadp-prometheus-4.15
oadp-prometheus-4.15
2 parents b027bbc + 61dc081 commit 062a3a9

File tree

3 files changed

+42
-167
lines changed

3 files changed

+42
-167
lines changed

‎modules/oadp-creating-service-monitor.adoc‎

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

6767
.Verification
6868

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

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

Lines changed: 33 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -6,174 +6,42 @@
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+
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]:
1010

11+
.Velero metrics
1112
|===
1213
|Metric name |Description |Type
1314

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
29-
30-
|`kopia_content_cache_missed_bytes`
31-
|Number of bytes retrieved from the underlying storage
32-
|Counter
33-
34-
|`kopia_content_cache_miss_error_count`
35-
|Number of times content could not be found in the underlying storage
36-
|Counter
37-
38-
|`kopia_content_cache_store_error_count`
39-
|Number of times content could not be saved in the cache
40-
|Counter
41-
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
53-
54-
|`kopia_content_get_not_found_count`
55-
|Number of times `GetContent()` was called and the result was not found
56-
|Counter
57-
58-
|`kopia_content_write_bytes`
59-
|Number of bytes passed to `WriteContent()`
60-
|Counter
61-
62-
|`kopia_content_write_count`
63-
|Number of times `WriteContent()` was called
64-
|Counter
65-
66-
|`velero_backup_attempt_total`
67-
|Total number of attempted backups
68-
|Counter
69-
70-
|`velero_backup_deletion_attempt_total`
71-
|Total number of attempted backup deletions
72-
|Counter
73-
74-
|`velero_backup_deletion_failure_total`
75-
|Total number of failed backup deletions
76-
|Counter
77-
78-
|`velero_backup_deletion_success_total`
79-
|Total number of successful backup deletions
80-
|Counter
81-
82-
|`velero_backup_duration_seconds`
83-
|Time taken to complete backup, in seconds
84-
|Histogram
85-
86-
|`velero_backup_failure_total`
87-
|Total number of failed backups
88-
|Counter
89-
90-
|`velero_backup_items_errors`
91-
|Total number of errors encountered during backup
92-
|Gauge
93-
94-
|`velero_backup_items_total`
95-
|Total number of items backed up
96-
|Gauge
97-
98-
|`velero_backup_last_status`
99-
|Last status of the backup. A value of 1 is success, 0.
100-
|Gauge
101-
102-
|`velero_backup_last_successful_timestamp`
103-
|Last time a backup ran successfully, Unix timestamp in seconds
104-
|Gauge
105-
106-
|`velero_backup_partial_failure_total`
107-
|Total number of partially failed backups
108-
|Counter
109-
110-
|`velero_backup_success_total`
111-
|Total number of successful backups
112-
|Counter
113-
114-
|`velero_backup_tarball_size_bytes`
115-
|Size, in bytes, of a backup
116-
|Gauge
117-
118-
|`velero_backup_total`
119-
|Current number of existent backups
120-
|Gauge
121-
122-
|`velero_backup_validation_failure_total`
123-
|Total number of validation failed backups
124-
|Counter
125-
126-
|`velero_backup_warning_total`
127-
|Total number of warned backups
128-
|Counter
129-
130-
|`velero_csi_snapshot_attempt_total`
131-
|Total number of CSI attempted volume snapshots
132-
|Counter
133-
134-
|`velero_csi_snapshot_failure_total`
135-
|Total number of CSI failed volume snapshots
136-
|Counter
137-
138-
|`velero_csi_snapshot_success_total`
139-
|Total number of CSI successful volume snapshots
140-
|Counter
141-
142-
|`velero_restore_attempt_total`
143-
|Total number of attempted restores
144-
|Counter
145-
146-
|`velero_restore_failed_total`
147-
|Total number of failed restores
148-
|Counter
149-
150-
|`velero_restore_partial_failure_total`
151-
|Total number of partially failed restores
152-
|Counter
153-
154-
|`velero_restore_success_total`
155-
|Total number of successful restores
156-
|Counter
157-
158-
|`velero_restore_total`
159-
|Current number of existent restores
160-
|Gauge
161-
162-
|`velero_restore_validation_failed_total`
163-
|Total number of failed restores failing validations
164-
|Counter
165-
166-
|`velero_volume_snapshot_attempt_total`
167-
|Total number of attempted volume snapshots
168-
|Counter
169-
170-
|`velero_volume_snapshot_failure_total`
171-
|Total number of failed volume snapshots
172-
|Counter
173-
174-
|`velero_volume_snapshot_success_total`
175-
|Total number of successful volume snapshots
176-
|Counter
15+
| `velero_backup_tarball_size_bytes` | Size, in bytes, of a backup | Gauge
16+
| `velero_backup_total` | Current number of existent backups | Gauge
17+
| `velero_backup_attempt_total` | Total number of attempted backups | Counter
18+
| `velero_backup_success_total` | Total number of successful backups | Counter
19+
| `velero_backup_partial_failure_total` | Total number of partially failed backups | Counter
20+
| `velero_backup_failure_total` | Total number of failed backups | Counter
21+
| `velero_backup_validation_failure_total` | Total number of validation failed backups | Counter
22+
| `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
26+
| `velero_backup_deletion_attempt_total` | Total number of attempted backup deletions | Counter
27+
| `velero_backup_deletion_success_total` | Total number of successful backup deletions | Counter
28+
| `velero_backup_deletion_failure_total` | Total number of failed backup deletions | Counter
29+
| `velero_backup_last_successful_timestamp` | Last time a backup ran successfully, Unix timestamp in seconds | Gauge
30+
| `velero_backup_items_total` | Total number of items backed up | Gauge
31+
| `velero_backup_items_errors` | Total number of errors encountered during backup | Gauge
32+
| `velero_backup_warning_total` | Total number of warned backups | Counter
33+
| `velero_backup_last_status` | Last status of the backup. A value of 1 is success, 0 is failure | Gauge
34+
| `velero_restore_total` | Current number of existent restores | Gauge
35+
| `velero_restore_attempt_total` | Total number of attempted restores | Counter
36+
| `velero_restore_validation_failed_total` | Total number of failed restores failing validations | Counter
37+
| `velero_restore_success_total` | Total number of successful restores | Counter
38+
| `velero_restore_partial_failure_total` | Total number of partially failed restores | Counter
39+
| `velero_restore_failed_total` | Total number of failed restores | Counter
40+
| `velero_volume_snapshot_attempt_total` | Total number of attempted volume snapshots | Counter
41+
| `velero_volume_snapshot_success_total` | Total number of successful volume snapshots | Counter
42+
| `velero_volume_snapshot_failure_total` | Total number of failed volume snapshots | Counter
43+
| `velero_csi_snapshot_attempt_total` | Total number of CSI attempted volume snapshots | Counter
44+
| `velero_csi_snapshot_success_total` | Total number of CSI successful volume snapshots | Counter
45+
| `velero_csi_snapshot_failure_total` | Total number of CSI failed volume snapshots | Counter
17746

17847
|===
179-

‎modules/oadp-monitoring-setup.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ With enabled User Workload Monitoring, it is possible to configure and use any P
1212

1313
Monitoring metrics requires enabling monitoring for the user-defined projects and creating a `ServiceMonitor` resource to scrape those metrics from the already enabled OADP service endpoint that resides in the `openshift-adp` namespace.
1414

15+
[NOTE]
16+
====
17+
The {oadp-short} support for Prometheus metrics is offered on a best-effort basis and is not fully supported.
18+
====
19+
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+
1522
.Prerequisites
1623
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
1724
* You have created a cluster monitoring config map.
@@ -30,10 +37,10 @@ $ oc edit configmap cluster-monitoring-config -n openshift-monitoring
3037
[source,yaml]
3138
----
3239
apiVersion: v1
40+
kind: ConfigMap
3341
data:
3442
config.yaml: |
3543
enableUserWorkload: true <1>
36-
kind: ConfigMap
3744
metadata:
3845
# ...
3946
----

0 commit comments

Comments
 (0)