Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[receiver/kubeletstats] Add note about metrics deprecation on specific release #34602

Closed
wants to merge 2 commits into from
Closed

[receiver/kubeletstats] Add note about metrics deprecation on specific release #34602

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49accc7
[receiver/kubeletstats] Add note about metrics deprecation on specifi…
ChrsMark Aug 12, 2024
d378fd6
fix metrics' names
ChrsMark Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions receiver/kubeletstatsreceiver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,3 +285,18 @@ rules:
resources: ["nodes/proxy"]
verbs: ["get"]
```

### 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.usage`
- `k8s.pod.usage`
- `container.usage`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Actually there was a *.cpu.* part missing by mistake there. Thank's for spotting this!


More information about the deprecation plan and
the background reasoning can be found at https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/27885.
6 changes: 3 additions & 3 deletions receiver/kubeletstatsreceiver/internal/metadata/generated_metrics.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions receiver/kubeletstatsreceiver/internal/metadata/generated_metrics_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions receiver/kubeletstatsreceiver/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ metrics:
enabled: true
description: "Node CPU utilization"
warnings:
if_enabled: "WARNING: This metric will be disabled in a future release. Use metric k8s.node.cpu.usage instead."
if_enabled: "This metric will be removed starting in v0.111.0 release. Use metric k8s.node.cpu.usage instead."
unit: "1"
gauge:
value_type: double
Expand Down Expand Up @@ -207,7 +207,7 @@ metrics:
enabled: true
description: "Pod CPU utilization"
warnings:
if_enabled: "This metric will be disabled in a future release. Use metric k8s.pod.cpu.usage instead."
if_enabled: "This metric will be removed starting in v0.111.0 release. Use metric k8s.pod.cpu.usage instead."
unit: "1"
gauge:
value_type: double
Expand Down Expand Up @@ -364,7 +364,7 @@ metrics:
enabled: true
description: "Container CPU utilization"
warnings:
if_enabled: "WARNING: This metric will be disabled in a future release. Use metric container.cpu.usage instead."
if_enabled: "This metric will be removed starting in v0.111.0 release. Use metric container.cpu.usage instead."
unit: "1"
gauge:
value_type: double
Expand Down