From 3f9f8f26f5e7c12d2c0f658bb3b05ff98d790fdf Mon Sep 17 00:00:00 2001 From: odubajDT <93584209+odubajDT@users.noreply.github.com> Date: Wed, 30 Apr 2025 16:21:03 +0200 Subject: [PATCH] [k8s] Introduce semantic conventions for k8s Namespace labels and annotations (#2166) Signed-off-by: odubajDT --- .chloggen/namespaces-labels-annotations.yaml | 22 +++++++++++++++++ docs/attributes-registry/k8s.md | 26 ++++++++++++-------- docs/resource/k8s.md | 6 +++++ model/k8s/registry.yaml | 16 ++++++++++++ model/k8s/resources.yaml | 4 +++ 5 files changed, 64 insertions(+), 10 deletions(-) create mode 100644 .chloggen/namespaces-labels-annotations.yaml diff --git a/.chloggen/namespaces-labels-annotations.yaml b/.chloggen/namespaces-labels-annotations.yaml new file mode 100644 index 000000000..b860ac628 --- /dev/null +++ b/.chloggen/namespaces-labels-annotations.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: k8s + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: "Introduce semantic conventions for k8s Namespace labels and annotations" + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [2131] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/attributes-registry/k8s.md b/docs/attributes-registry/k8s.md index 04797285c..63b4075dd 100644 --- a/docs/attributes-registry/k8s.md +++ b/docs/attributes-registry/k8s.md @@ -31,14 +31,16 @@ Kubernetes resource attributes. | `k8s.job.label.` | string | The label key-value pairs placed on the Job. [5] | `k8s.job.label.jobtype=ci`; `k8s.job.label.automated=` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.job.name` | string | The name of the Job. | `opentelemetry` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.job.uid` | string | The UID of the Job. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.namespace.annotation.` | string | The annotation key-value pairs placed on the Namespace. [6] | `k8s.namespace.annotation.ttl=0`; `k8s.namespace.annotation.data=` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.namespace.label.` | string | The label key-value pairs placed on the Namespace. [7] | `k8s.namespace.label.kubernetes.io/metadata.name=default`; `k8s.namespace.label.data=` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.namespace.name` | string | The name of the namespace that the pod is running in. | `default` | ![Development](https://img.shields.io/badge/-development-blue) | -| `k8s.namespace.phase` | string | The phase of the K8s namespace. [6] | `active`; `terminating` | ![Development](https://img.shields.io/badge/-development-blue) | -| `k8s.node.annotation.` | string | The annotation placed on the Node, the `` being the annotation name, the value being the annotation value, even if the value is empty. [7] | `0`; `` | ![Development](https://img.shields.io/badge/-development-blue) | -| `k8s.node.label.` | string | The label placed on the Node, the `` being the label name, the value being the label value, even if the value is empty. [8] | `arm64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.namespace.phase` | string | The phase of the K8s namespace. [8] | `active`; `terminating` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.node.annotation.` | string | The annotation placed on the Node, the `` being the annotation name, the value being the annotation value, even if the value is empty. [9] | `0`; `` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.node.label.` | string | The label placed on the Node, the `` being the label name, the value being the label value, even if the value is empty. [10] | `arm64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.node.name` | string | The name of the Node. | `node-1` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.node.uid` | string | The UID of the Node. | `1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2` | ![Development](https://img.shields.io/badge/-development-blue) | -| `k8s.pod.annotation.` | string | The annotation placed on the Pod, the `` being the annotation name, the value being the annotation value. [9] | `true`; `x64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | -| `k8s.pod.label.` | string | The label placed on the Pod, the `` being the label name, the value being the label value. [10] | `my-app`; `x64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.pod.annotation.` | string | The annotation placed on the Pod, the `` being the annotation name, the value being the annotation value. [11] | `true`; `x64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | +| `k8s.pod.label.` | string | The label placed on the Pod, the `` being the label name, the value being the label value. [12] | `my-app`; `x64`; `` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.pod.name` | string | The name of the Pod. | `opentelemetry-pod-autoconf` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.pod.uid` | string | The UID of the Pod. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | ![Development](https://img.shields.io/badge/-development-blue) | | `k8s.replicaset.name` | string | The name of the ReplicaSet. | `opentelemetry` | ![Development](https://img.shields.io/badge/-development-blue) | @@ -93,24 +95,28 @@ conflict. **[5] `k8s.job.label`:** The `` being the label name, the value being the label value, even if the value is empty. -**[6] `k8s.namespace.phase`:** This attribute aligns with the `phase` field of the +**[6] `k8s.namespace.annotation`:** The `` being the annotation name, the value being the annotation value, even if the value is empty. + +**[7] `k8s.namespace.label`:** The `` being the label name, the value being the label value, even if the value is empty. + +**[8] `k8s.namespace.phase`:** This attribute aligns with the `phase` field of the [K8s NamespaceStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#namespacestatus-v1-core) -**[7] `k8s.node.annotation`:** Examples: +**[9] `k8s.node.annotation`:** Examples: - An annotation `node.alpha.kubernetes.io/ttl` with value `0` SHOULD be recorded as the `k8s.node.annotation.node.alpha.kubernetes.io/ttl` attribute with value `"0"`. - An annotation `data` with empty string value SHOULD be recorded as the `k8s.node.annotation.data` attribute with value `""`. -**[8] `k8s.node.label`:** Examples: +**[10] `k8s.node.label`:** Examples: - A label `kubernetes.io/arch` with value `arm64` SHOULD be recorded as the `k8s.node.label.kubernetes.io/arch` attribute with value `"arm64"`. - A label `data` with empty string value SHOULD be recorded as the `k8s.node.label.data` attribute with value `""`. -**[9] `k8s.pod.annotation`:** Examples: +**[11] `k8s.pod.annotation`:** Examples: - An annotation `kubernetes.io/enforce-mountable-secrets` with value `true` SHOULD be recorded as the `k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets` attribute with value `"true"`. @@ -119,7 +125,7 @@ conflict. - An annotation `data` with empty string value SHOULD be recorded as the `k8s.pod.annotation.data` attribute with value `""`. -**[10] `k8s.pod.label`:** Examples: +**[12] `k8s.pod.label`:** Examples: - A label `app` with value `my-app` SHOULD be recorded as the `k8s.pod.label.app` attribute with value `"my-app"`. diff --git a/docs/resource/k8s.md b/docs/resource/k8s.md index 9d8d17b0f..57e3ee972 100644 --- a/docs/resource/k8s.md +++ b/docs/resource/k8s.md @@ -128,6 +128,12 @@ a namespace, but not across namespaces. | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| | [`k8s.namespace.name`](/docs/attributes-registry/k8s.md) | string | The name of the namespace that the pod is running in. | `default` | `Recommended` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`k8s.namespace.annotation.`](/docs/attributes-registry/k8s.md) | string | The annotation key-value pairs placed on the Namespace. [1] | `k8s.namespace.annotation.ttl=0`; `k8s.namespace.annotation.data=` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) | +| [`k8s.namespace.label.`](/docs/attributes-registry/k8s.md) | string | The label key-value pairs placed on the Namespace. [2] | `k8s.namespace.label.kubernetes.io/metadata.name=default`; `k8s.namespace.label.data=` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1] `k8s.namespace.annotation`:** The `` being the annotation name, the value being the annotation value, even if the value is empty. + +**[2] `k8s.namespace.label`:** The `` being the label name, the value being the label value, even if the value is empty. diff --git a/model/k8s/registry.yaml b/model/k8s/registry.yaml index 0b5830192..b9c535a59 100644 --- a/model/k8s/registry.yaml +++ b/model/k8s/registry.yaml @@ -85,6 +85,22 @@ groups: brief: > The name of the namespace that the pod is running in. examples: ['default'] + - id: k8s.namespace.label + type: template[string] + stability: development + brief: > + The label key-value pairs placed on the Namespace. + note: | + The `` being the label name, the value being the label value, even if the value is empty. + examples: ['k8s.namespace.label.kubernetes.io/metadata.name=default', 'k8s.namespace.label.data='] + - id: k8s.namespace.annotation + type: template[string] + stability: development + brief: > + The annotation key-value pairs placed on the Namespace. + note: | + The `` being the annotation name, the value being the annotation value, even if the value is empty. + examples: [ 'k8s.namespace.annotation.ttl=0', 'k8s.namespace.annotation.data=' ] - id: k8s.pod.uid type: string stability: development diff --git a/model/k8s/resources.yaml b/model/k8s/resources.yaml index f9aca64ca..d3466cc6c 100644 --- a/model/k8s/resources.yaml +++ b/model/k8s/resources.yaml @@ -31,6 +31,10 @@ groups: A Kubernetes Namespace. attributes: - ref: k8s.namespace.name + - ref: k8s.namespace.label + requirement_level: opt_in + - ref: k8s.namespace.annotation + requirement_level: opt_in - id: resource.k8s.pod type: resource