Bug 1796927

Summary:	Comments describing telemetry is missing
Product:	OpenShift Container Platform	Reporter:	Frederic Branczyk <fbranczy>
Component:	Monitoring	Assignee:	Frederic Branczyk <fbranczy>
Status:	CLOSED ERRATA	QA Contact:	Junqi Zhao <juzhao>
Severity:	low	Docs Contact:
Priority:	low
Version:	4.4	CC:	alegrand, anpicker, erooth, kakkoyun, lcosic, mloibl, pkrupa, surbania
Target Milestone:	---
Target Release:	4.4.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-05-04 11:28:32 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Frederic Branczyk 2020-01-31 14:17:53 UTC

Description of problem:

In 4.4 a new mechanism to configure telemetry was introduced, this silently dropped the comments that described what each metric represents. These descriptions should be available for transparency.

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 3 Junqi Zhao 2020-02-04 02:03:15 UTC

tested with 4.4.0-0.nightly-2020-02-03-163409, just some defects in the comments.
the following 3 metrics are not the same with that in the comments
    # job:ceph_pools_iops:total is the total iops (reads+writes) value in bytes for all the pools in ceph cluster
    - '{__name__="job:ceph_pools_iops_bytes:total"}'

    # cluster:network_attachment_definition_enabled_instance_up  informs (1 or 0) if the cluster has
    # at least max of one instance with  k8s.v1.cni.cncf.io/networks annotation, labelled by networks (any or sriov).
    - '{__name__="cluster:network_attachment_definition_enabled_instance_up:max"}'

    # insightsclient_request_send tracks the number of metrics sends.
    - '{__name__="insightsclient_request_send_total"}'

Comment 4 Lili Cosic 2020-02-04 09:26:08 UTC

This sounds like the problem with the metrics as we did not touch any of the recording rules, think we should verify to confirm this before these changes landed.

Comment 5 Frederic Branczyk 2020-02-04 09:36:39 UTC

I double checked and while not totally correct as you identified, those are the comments those entries had previously, see: https://github.com/openshift/telemeter/blob/de3c19e9675f55b22e53104094926c584c5a8a60/docs/data-collection.md

As this bug was about transferring the comments, I would call this verified, and we can open a bug against each component that is responsible for these metrics, to have them fix the comments.

Comment 8 errata-xmlrpc 2020-05-04 11:28:32 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:0581

Comment 9 Red Hat Bugzilla 2023-09-14 05:51:00 UTC

The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days