Bug 1821446 - Documentation on each of the Prometheus data points that we ship
Summary: Documentation on each of the Prometheus data points that we ship
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.5
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.5.z
Assignee: Claire Bremble
QA Contact: Junqi Zhao
Claire Bremble
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-04-06 20:09 UTC by Courtney Ruhm
Modified: 2024-06-13 22:33 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-01-23 19:00:51 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-3456 0 None None None 2022-09-13 17:33:08 UTC

Description Courtney Ruhm 2020-04-06 20:09:03 UTC
Name: Prometheus

Describe the issue: Customer is requesting detailed documentation on each of the Prometheus data points that we ship

Comment 2 Courtney Ruhm 2020-06-01 16:32:20 UTC
Any update on this

Comment 7 milti leonard 2020-12-30 16:23:42 UTC
if were not willing to document these metrics ourselves, is there already documentation for them upstream or elsewhere that are an available resource? bcz the comment from the original cu is highly relevant: most users are NOT willing to trawl through code to understand what is being reported to them via these metrics nor should they be.

thnx, m

Comment 8 milti leonard 2020-12-30 16:30:18 UTC
to make myself sound less snotty, could we start by at least documenting those alerts that are OCP specific (if any) and not necessarily those that are inherited from the upstream community, as the point of the sheer number of alerts would be an issue.

Comment 15 Brian Burt 2022-09-13 17:33:08 UTC
Updated to add a link to the duplicate RHDEVDOCS Jira issue.

Comment 17 Lucas López Montero 2022-12-20 10:20:55 UTC
There is a way to check this information described on the following KCS solution:

https://access.redhat.com/solutions/6984824

Comment 19 Brian Burt 2023-01-23 17:35:52 UTC
As of OCP 4.12, we now include information in the core OCP docs about viewing a list of all available metrics for a cluster (including metadata):

https://docs.openshift.com/container-platform/4.12/monitoring/managing-metrics.html#viewing-a-list-of-available-metrics_managing-metrics

The linked Jira issue is already closed, so I think we can close this BZ as fixed.


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