[receiver/kubeletstats] Add note about metrics deprecation on specific release #34602
Conversation
ChrsMark
force-pushed
the
advertise_more_the_utilization_deprecation
branch
from
469324e
to
c087824
Compare
|
Note this is just my suggestion for the target release. We should wait for confirmation at #27885 (comment). |
…c release Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
ChrsMark
force-pushed
the
advertise_more_the_utilization_deprecation
branch
from
c087824
to
49accc7
Compare
| Users can use the following metrics instead: | ||
| - `k8s.node.usage` | ||
| - `k8s.pod.usage` | ||
| - `container.usage` |
There was a problem hiding this comment.
Out of ignorance, what's the relevance of this section? The comment above shares which metrics are being removed, and what metric they're being replaced by. This appears to be somewhat duplicating the "replaced by" message, but with different metrics. (I very well may be missing something, just want to check.)
There was a problem hiding this comment.
Good catch! Actually there was a *.cpu.* part missing by mistake there. Thank's for spotting this!
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
| ### Warning about metrics' deprecation | ||
|
|
||
| The following metrics will be removed in `v0.111.0` version: | ||
| - `k8s.node.cpu.utilization` (replaced by `k8s.node.cpu.usage`) | ||
| - `k8s.pod.cpu.utilization` (replaced by `k8s.pod.cpu.usage`) | ||
| - `container.cpu.utilization` (replaced by `container.cpu.usage`) | ||
|
|
||
| Users can use the following metrics instead: | ||
| - `k8s.node.cpu.usage` | ||
| - `k8s.pod.cpu.usage` | ||
| - `container.cpu.usage` | ||
|
|
||
| More information about the deprecation plan and | ||
| the background reasoning can be found at https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27885. |
There was a problem hiding this comment.
I like the idea of adding something that explicitly stated "this is a rename, the values are exactly the same as before, only the metric name has changed to be in alignment with the OpenTelemetry specification".
|
Marked it as draft while we wait for a decision at #27885. |
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
Description:
Addresses #27885 (comment).
Link to tracking Issue:
Testing:
Documentation: