diff --git a/receiver/kubeletstatsreceiver/README.md b/receiver/kubeletstatsreceiver/README.md index a250ba5dff378..d392a860f0351 100644 --- a/receiver/kubeletstatsreceiver/README.md +++ b/receiver/kubeletstatsreceiver/README.md @@ -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.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. \ No newline at end of file diff --git a/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics.go b/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics.go index f083f5b6de838..37230be5856c8 100644 --- a/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics.go +++ b/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics.go @@ -3094,13 +3094,13 @@ func WithStartTime(startTime pcommon.Timestamp) metricBuilderOption { func NewMetricsBuilder(mbc MetricsBuilderConfig, settings receiver.Settings, options ...metricBuilderOption) *MetricsBuilder { if mbc.Metrics.ContainerCPUUtilization.Enabled { - settings.Logger.Warn("[WARNING] `container.cpu.utilization` should not be enabled: WARNING: This metric will be disabled in a future release. Use metric container.cpu.usage instead.") + settings.Logger.Warn("[WARNING] `container.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric container.cpu.usage instead.") } if mbc.Metrics.K8sNodeCPUUtilization.Enabled { - settings.Logger.Warn("[WARNING] `k8s.node.cpu.utilization` should not be enabled: WARNING: This metric will be disabled in a future release. Use metric k8s.node.cpu.usage instead.") + settings.Logger.Warn("[WARNING] `k8s.node.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric k8s.node.cpu.usage instead.") } if mbc.Metrics.K8sPodCPUUtilization.Enabled { - settings.Logger.Warn("[WARNING] `k8s.pod.cpu.utilization` should not be enabled: This metric will be disabled in a future release. Use metric k8s.pod.cpu.usage instead.") + settings.Logger.Warn("[WARNING] `k8s.pod.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric k8s.pod.cpu.usage instead.") } mb := &MetricsBuilder{ config: mbc, diff --git a/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics_test.go b/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics_test.go index 1fd14d7c86f22..7516e44838ef5 100644 --- a/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics_test.go +++ b/receiver/kubeletstatsreceiver/internal/metadata/generated_metrics_test.go @@ -63,15 +63,15 @@ func TestMetricsBuilder(t *testing.T) { expectedWarnings := 0 if test.metricsSet == testDataSetDefault || test.metricsSet == testDataSetAll { - assert.Equal(t, "[WARNING] `container.cpu.utilization` should not be enabled: WARNING: This metric will be disabled in a future release. Use metric container.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) + assert.Equal(t, "[WARNING] `container.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric container.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) expectedWarnings++ } if test.metricsSet == testDataSetDefault || test.metricsSet == testDataSetAll { - assert.Equal(t, "[WARNING] `k8s.node.cpu.utilization` should not be enabled: WARNING: This metric will be disabled in a future release. Use metric k8s.node.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) + assert.Equal(t, "[WARNING] `k8s.node.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric k8s.node.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) expectedWarnings++ } if test.metricsSet == testDataSetDefault || test.metricsSet == testDataSetAll { - assert.Equal(t, "[WARNING] `k8s.pod.cpu.utilization` should not be enabled: This metric will be disabled in a future release. Use metric k8s.pod.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) + assert.Equal(t, "[WARNING] `k8s.pod.cpu.utilization` should not be enabled: This metric will be removed starting in v0.111.0 release. Use metric k8s.pod.cpu.usage instead.", observedLogs.All()[expectedWarnings].Message) expectedWarnings++ } diff --git a/receiver/kubeletstatsreceiver/metadata.yaml b/receiver/kubeletstatsreceiver/metadata.yaml index 67b7c362221aa..37c6f1a2a7b5f 100644 --- a/receiver/kubeletstatsreceiver/metadata.yaml +++ b/receiver/kubeletstatsreceiver/metadata.yaml @@ -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 @@ -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 @@ -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