From 394be4d906912938baafc1bce9304c6cc9f2ecc2 Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Thu, 5 Dec 2024 19:01:12 +0200 Subject: [PATCH] Add Collector breaking changes in migration guide Signed-off-by: ChrsMark --- docs/non-normative/k8s-migration.md | 95 +++++++++++++++++++++++++++-- 1 file changed, 90 insertions(+), 5 deletions(-) diff --git a/docs/non-normative/k8s-migration.md b/docs/non-normative/k8s-migration.md index 8a8f305dac..aaf68df43f 100644 --- a/docs/non-normative/k8s-migration.md +++ b/docs/non-normative/k8s-migration.md @@ -43,6 +43,10 @@ and one for disabling the old schema called `semconv.k8s.disableLegacy`. Then: - [Summary of changes](#summary-of-changes) - [K8s network metrics](#k8s-network-metrics) + - [K8s Deployment metrics](#k8s-deployment-metrics) + - [K8s ReplicaSet metrics](#k8s-replicaset-metrics) + - [K8s ReplicationController metrics](#k8s-replicationcontroller-metrics) + - [K8s HorizontalPodAutoscaler metrics](#k8s-horizontalpodautoscaler-metrics) @@ -56,13 +60,94 @@ to bring the conventions to stable (TODO: link to specific version once it exist The K8s network metrics implemented by the Collector and specifically the [kubeletstats](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.112.0/receiver/kubeletstatsreceiver/documentation.md) -receiver were introduced as semantic conventions in [v1.29.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.29.0/docs/system/k8s-metrics.md). +receiver were introduced as semantic conventions +in [v1.29.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.29.0/docs/system/k8s-metrics.md). The changes in their attributes are the following: -| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | -|------------------------------------------------------------------------------------|---------------------------| -| `interface` | `network.interface.name` | -| `direction` | `network.io.direction` | + +| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | +|------------------------------------------------------------------------------------|--------------------------| +| `interface` | `network.interface.name` | +| `direction` | `network.io.direction` | + + + +### K8s Deployment metrics + +The K8s Deployment metrics implemented by the Collector and specifically the +[k8scluster](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.115.0/receiver/k8sclusterreceiver/documentation.md) +receiver were introduced as semantic conventions in +[#1636](https://github.com/open-telemetry/semantic-conventions/pull/1636) (TODO: replace with SemConv version once +available). + +The changes in their metric names are the following: + + + +| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | +|------------------------------------------------------------------------------------|---------------------------------| +| `k8s.deployment.desired` | `k8s.deployment.desired_pods` | +| `k8s.deployment.available` | `k8s.deployment.available_pods` | + + + +### K8s ReplicaSet metrics + +The K8s ReplicaSet metrics implemented by the Collector and specifically the +[k8scluster](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.115.0/receiver/k8sclusterreceiver/documentation.md) +receiver were introduced as semantic conventions in +[#1636](https://github.com/open-telemetry/semantic-conventions/pull/1636) (TODO: replace with SemConv version once +available). + +The changes in their metric names are the following: + + + +| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | +|------------------------------------------------------------------------------------|---------------------------------| +| `k8s.replicaset.desired` | `k8s.replicaset.desired_pods` | +| `k8s.replicaset.available` | `k8s.replicaset.available_pods` | + + + +### K8s ReplicationController metrics + +The K8s ReplicationController metrics implemented by the Collector and specifically the +[k8scluster](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.115.0/receiver/k8sclusterreceiver/documentation.md) +receiver were introduced as semantic conventions in +[#1636](https://github.com/open-telemetry/semantic-conventions/pull/1636) (TODO: replace with SemConv version once +available). + +The changes in their metric names are the following: + + + +| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | +|------------------------------------------------------------------------------------|---------------------------------------------| +| `k8s.replication_controller.desired` | `k8s.replication_controller.desired_pods` | +| `k8s.replication_controller.available` | `k8s.replication_controller.available_pods` | + + + +### K8s HorizontalPodAutoscaler metrics + +The K8s HorizontalPodAutoscaler metrics implemented by the Collector and specifically the +[k8scluster](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.115.0/receiver/k8sclusterreceiver/documentation.md) +receiver were introduced as semantic conventions in +[#1636](https://github.com/open-telemetry/semantic-conventions/pull/1636) (TODO: replace with SemConv version once +available). + +The changes in their metric names are the following: + + + +| Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New | +|------------------------------------------------------------------------------------|------------------------| +| `k8s.hpa.desired_replicas` | `k8s.hpa.desired_pods` | +| `k8s.hpa.current_replicas` | `k8s.hpa.current_pods` | +| `k8s.hpa.max_replicas` | `k8s.hpa.max_pods` | +| `k8s.hpa.min_replicas` | `k8s.hpa.min_pods` | +