Bug 2106362 - job:kube_pv:count documentation wrong
Summary: job:kube_pv:count documentation wrong
Keywords:
Status: NEW
Alias: None
Product: Red Hat OpenShift Container Storage
Classification: Red Hat Storage
Component: ocs-operator
Version: unspecified
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Nobody
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-07-12 13:06 UTC by Chris Blum
Modified: 2023-08-03 08:28 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Embargoed:


Attachments (Terms of Use)

Description Chris Blum 2022-07-12 13:06:56 UTC
Description of problem:
The documentation for the metric job:kube_pv:count is wrong. It only counts ODF PVs.

The metric is created by ODF here:
https://github.com/red-hat-storage/ocs-operator/blob/main/controllers/storagecluster/prometheus/localcephrules.yaml#L24-L26

I've already opened a Github issue about this a while ago... it has become rotten by now
https://github.com/openshift/cluster-monitoring-operator/issues/1586

Version-Release number of selected component (if applicable):
OCP & ODF 4 (has been that way for a while now)

How reproducible:
Always when reading metric documentation at https://github.com/openshift/cluster-monitoring-operator

Comment 1 Jan Fajerski 2022-07-12 14:00:13 UTC
Thanks for filing a BZ. The documentation is certainly incorrect, I would argue so is the metric/recording rule name.

A better name would indicate that the PVs are ceph based, e.g. job:kube_ceph_pv:count.

Assigning to the ODF team as they own this rule.

Comment 8 Junqi Zhao 2023-06-21 11:17:45 UTC
issue is fixed in 4.12, see: 
https://github.com/openshift/cluster-monitoring-operator/blob/release-4.12/manifests/0000_50_cluster-monitoring-operator_04-config.yaml#L343-L352

"job:kube_pv:count" is deprecated in ODF 4.12, does that also mean we could remove it since OCP 4.13?

Comment 9 Chris Blum 2023-06-21 11:21:34 UTC
I would vote to remove the old metric


Note You need to log in before you can comment on or make changes to this bug.