Skip to content

Commit 4340a62

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #72264 from sr1kar99/doc-improv-monitoring
OCPBUGS#30031: Doc improvements related to "Monitoring" section
2 parents ae46819 + d4f0e0c commit 4340a62

File tree

3 files changed

+42
-24
lines changed

3 files changed

+42
-24
lines changed

‎modules/lvms-download-log-files-and-diagnostics.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88

99
When {lvms} is unable to automatically resolve a problem, use the must-gather tool to collect the log files and diagnostic information so that you or the Red Hat Support can review the problem and determine a solution.
1010

11-
* Run the must-gather command from the client connected to {lvms} cluster by running the following command:
11+
.Procedure
12+
* Run the `must-gather` command from the client connected to the {lvms} cluster:
1213
+
1314
[source,terminal,subs="attributes+"]
1415
----
15-
$ oc adm must-gather --image=registry.redhat.io/lvms4/lvms-must-gather-rhel9:v{product-version} --dest-dir=<directory-name>
16+
$ oc adm must-gather --image=registry.redhat.io/lvms4/lvms-must-gather-rhel9:v{product-version} --dest-dir=<directory_name>
1617
----

‎modules/lvms-monitoring-logical-volume-manager-operator.adoc

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,56 @@
66
[id="lvms-monitoring-using-lvms_{context}"]
77
= Monitoring {lvms}
88

9-
When you use {rh-rhacm} to install {lvms}, you must configure {rh-rhacm} Observability to monitor all the clusters from one place.
9+
To enable cluster monitoring, you must add the following label in the namespace where you have installed {lvms}:
10+
[source,text]
11+
----
12+
openshift.io/cluster-monitoring=true
13+
----
14+
15+
[IMPORTANT]
16+
====
17+
For information about enabling cluster monitoring in {rh-rhacm}, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html-single/observability/index[Observability] and link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html-single/observability/index#adding-custom-metrics[Adding custom metrics].
18+
====
1019

1120
[id="lvms-monitoring-using-lvms-metrics_{context}"]
1221
== Metrics
1322

14-
You can monitor {lvms} by viewing the metrics exported by the Operator on the {rh-rhacm} dashboards and the alerts that are triggered.
23+
You can monitor {lvms} by viewing the metrics.
1524

16-
* Add the following `topolvm` metrics to the `allow` list:
17-
+
18-
[source,terminal]
19-
----
20-
topolvm_thinpool_data_percent
21-
topolvm_thinpool_metadata_percent
22-
topolvm_thinpool_size_bytes
23-
----
25+
The following table describes the `topolvm` metrics:
26+
27+
.`topolvm` metrics
28+
[%autowidth,options="header"]
29+
|===
30+
|Alert | Description
31+
|`topolvm_thinpool_data_percent` | Indicates the percentage of data space used in the LVM thinpool.
32+
|`topolvm_thinpool_metadata_percent` | Indicates the percentage of metadata space used in the LVM thinpool.
33+
|`topolvm_thinpool_size_bytes` | Indicates the size of the LVM thin pool in bytes.
34+
|`topolvm_volumegroup_available_bytes` | Indicates the available space in the LVM volume group in bytes.
35+
|`topolvm_volumegroup_size_bytes` | Indicates the size of the LVM volume group in bytes.
36+
|`topolvm_thinpool_overprovisioned_available` | Indicates the available over-provisioned size of the LVM thin pool in bytes.
37+
|===
2438

2539
[NOTE]
2640
====
27-
Metrics are updated every 10 minutes or when there is a change in the thin pool, such as a new logical volume creation.
41+
Metrics are updated every 10 minutes or when there is a change, such as a new logical volume creation, in the thin pool.
2842
====
2943

3044
[id="lvms-monitoring-using-lvms-alerts_{context}"]
3145
== Alerts
3246

33-
When the thin pool and volume group are filled up, further operations fail and might lead to data loss.
34-
{lvms} sends the following alerts about the usage of the thin pool and volume group when utilization crosses a certain value:
47+
When the thin pool and volume group reach maximum storage capacity, further operations fail. This can lead to data loss.
48+
49+
{lvms} sends the following alerts when the usage of the thin pool and volume group exceeds a certain value:
3550

36-
.Alerts for Logical Volume Manager cluster in {rh-rhacm}
37-
[[alerts_for_LVMCluster_in_{rh-rhacm}]]
38-
[%autowidth,frame="topbot",options="header"]
51+
.LVM Storage alerts
52+
[%autowidth, options="header"]
3953
|===
4054
|Alert| Description
41-
|`VolumeGroupUsageAtThresholdNearFull`|This alert is triggered when both the volume group and thin pool utilization cross 75% on nodes. Data deletion or volume group expansion is required.
42-
|`VolumeGroupUsageAtThresholdCritical`|This alert is triggered when both the volume group and thin pool utilization cross 85% on nodes. `VolumeGroup` is critically full. Data deletion or volume group expansion is required.
43-
|`ThinPoolDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool data utilization in the volume group crosses 75% on nodes. Data deletion or thin pool expansion is required.
44-
|`ThinPoolDataUsageAtThresholdCritical`|This alert is triggered when the thin pool data utilization in the volume group crosses 85% on nodes. Data deletion or thin pool expansion is required.
45-
|`ThinPoolMetaDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool metadata utilization in the volume group crosses 75% on nodes. Data deletion or thin pool expansion is required.
46-
|`ThinPoolMetaDataUsageAtThresholdCritical`|This alert is triggered when the thin pool metadata utilization in the volume group crosses 85% on nodes. Data deletion or thin pool expansion is required.
55+
|`VolumeGroupUsageAtThresholdNearFull`|This alert is triggered when both the volume group and thin pool usage exceeds 75% on nodes. Data deletion or volume group expansion is required.
56+
|`VolumeGroupUsageAtThresholdCritical`|This alert is triggered when both the volume group and thin pool usage exceeds 85% on nodes. In this case, the volume group is critically full. Data deletion or volume group expansion is required.
57+
|`ThinPoolDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool data uusage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
58+
|`ThinPoolDataUsageAtThresholdCritical`|This alert is triggered when the thin pool data usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
59+
|`ThinPoolMetaDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
60+
|`ThinPoolMetaDataUsageAtThresholdCritical`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
4761
|===

‎storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,9 @@ include::modules/lvms-monitoring-logical-volume-manager-operator.adoc[leveloffse
155155
156156
* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html-single/observability/index#adding-custom-metrics[Adding custom metrics]
157157
158+
//Monitoring
159+
include::modules/lvms-monitoring-logical-volume-manager-operator.adoc[leveloffset=+1]
160+
158161
//Must-gather
159162
include::modules/lvms-download-log-files-and-diagnostics.adoc[leveloffset=+1]
160163

0 commit comments

Comments
 (0)