Add attribute for k8s pod annotations (open-telemetry#573)

Signed-off-by: ChrsMark <chrismarkou92@gmail.com> Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
pyohannes · Jan 17, 2024 · 7a2a6a8 · 7a2a6a8
1 parent 7a5a6b8
commit 7a2a6a8
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,8 @@ release.
 
 - Adds `labels` attribute to `k8s.pod` resource
  ([#494](https://github.com/open-telemetry/semantic-conventions/pull/494))
+- Adds `annotation` attribute to `k8s.pod` resource
+ ([#494](https://github.com/open-telemetry/semantic-conventions/pull/573))
 - Add `code.stacktrace` attribute
  ([#435](https://github.com/open-telemetry/semantic-conventions/pull/435))
 - Add `http.flavor` and `http.user_agent` to list of deprecated attributes

diff --git a/docs/attributes-registry/k8s.md b/docs/attributes-registry/k8s.md
@@ -2,31 +2,32 @@
 
 ## Kubernetes Resource Attributes
 
-<!-- semconv registry.k8s -->
-| Attribute | Type | Description | Examples | Requirement Level |
-|---|---|---|---|---|
-| `k8s.cluster.name` | string | The name of the cluster. | `opentelemetry-cluster` | Recommended |
-| `k8s.cluster.uid` | string | A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | Recommended |
-| `k8s.container.name` | string | The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). | `redis` | Recommended |
-| `k8s.container.restart_count` | int | Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. | `0`; `2` | Recommended |
-| `k8s.cronjob.name` | string | The name of the CronJob. | `opentelemetry` | Recommended |
-| `k8s.cronjob.uid` | string | The UID of the CronJob. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.daemonset.name` | string | The name of the DaemonSet. | `opentelemetry` | Recommended |
-| `k8s.daemonset.uid` | string | The UID of the DaemonSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.deployment.name` | string | The name of the Deployment. | `opentelemetry` | Recommended |
-| `k8s.deployment.uid` | string | The UID of the Deployment. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.job.name` | string | The name of the Job. | `opentelemetry` | Recommended |
-| `k8s.job.uid` | string | The UID of the Job. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.namespace.name` | string | The name of the namespace that the pod is running in. | `default` | Recommended |
-| `k8s.node.name` | string | The name of the Node. | `node-1` | Recommended |
-| `k8s.node.uid` | string | The UID of the Node. | `1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2` | Recommended |
-| `k8s.pod.labels.<key>` | string | The labels placed on the Pod, the `<key>` being the label name, the value being the label value. | `k8s.pod.labels.app=my-app`; `k8s.pod.labels.mycompany.io/arch=x64`; `k8s.pod.labels.data=` | Recommended |
-| `k8s.pod.name` | string | The name of the Pod. | `opentelemetry-pod-autoconf` | Recommended |
-| `k8s.pod.uid` | string | The UID of the Pod. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.replicaset.name` | string | The name of the ReplicaSet. | `opentelemetry` | Recommended |
-| `k8s.replicaset.uid` | string | The UID of the ReplicaSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
-| `k8s.statefulset.name` | string | The name of the StatefulSet. | `opentelemetry` | Recommended |
-| `k8s.statefulset.uid` | string | The UID of the StatefulSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
+<!-- semconv registry.k8s(omit_requirement_level) -->
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `k8s.cluster.name` | string | The name of the cluster. | `opentelemetry-cluster` |
+| `k8s.cluster.uid` | string | A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` |
+| `k8s.container.name` | string | The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). | `redis` |
+| `k8s.container.restart_count` | int | Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. | `0`; `2` |
+| `k8s.cronjob.name` | string | The name of the CronJob. | `opentelemetry` |
+| `k8s.cronjob.uid` | string | The UID of the CronJob. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.daemonset.name` | string | The name of the DaemonSet. | `opentelemetry` |
+| `k8s.daemonset.uid` | string | The UID of the DaemonSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.deployment.name` | string | The name of the Deployment. | `opentelemetry` |
+| `k8s.deployment.uid` | string | The UID of the Deployment. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.job.name` | string | The name of the Job. | `opentelemetry` |
+| `k8s.job.uid` | string | The UID of the Job. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.namespace.name` | string | The name of the namespace that the pod is running in. | `default` |
+| `k8s.node.name` | string | The name of the Node. | `node-1` |
+| `k8s.node.uid` | string | The UID of the Node. | `1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2` |
+| `k8s.pod.annotation.<key>` | string | The annotation key-value pairs placed on the Pod, the `<key>` being the annotation name, the value being the annotation value. | `k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true`; `k8s.pod.annotation.mycompany.io/arch=x64`; `k8s.pod.annotation.data=` |
+| `k8s.pod.labels.<key>` | string | The labels placed on the Pod, the `<key>` being the label name, the value being the label value. | `k8s.pod.labels.app=my-app`; `k8s.pod.labels.mycompany.io/arch=x64`; `k8s.pod.labels.data=` |
+| `k8s.pod.name` | string | The name of the Pod. | `opentelemetry-pod-autoconf` |
+| `k8s.pod.uid` | string | The UID of the Pod. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.replicaset.name` | string | The name of the ReplicaSet. | `opentelemetry` |
+| `k8s.replicaset.uid` | string | The UID of the ReplicaSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
+| `k8s.statefulset.name` | string | The name of the StatefulSet. | `opentelemetry` |
+| `k8s.statefulset.uid` | string | The UID of the StatefulSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` |
 
 **[1]:** K8s doesn't have support for obtaining a cluster ID. If this is ever
 added, we will recommend collecting the `k8s.cluster.uid` through the

diff --git a/docs/resource/k8s.md b/docs/resource/k8s.md
@@ -91,6 +91,7 @@ containers on your cluster.
 <!-- semconv k8s.pod -->
 | Attribute | Type | Description | Examples | Requirement Level |
 |---|---|---|---|---|
+| [`k8s.pod.annotation.<key>`](../attributes-registry/k8s.md) | string | The annotation key-value pairs placed on the Pod, the `<key>` being the annotation name, the value being the annotation value. | `k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true`; `k8s.pod.annotation.mycompany.io/arch=x64`; `k8s.pod.annotation.data=` | Opt-In |
 | [`k8s.pod.labels.<key>`](../attributes-registry/k8s.md) | string | The labels placed on the Pod, the `<key>` being the label name, the value being the label value. | `k8s.pod.labels.app=my-app`; `k8s.pod.labels.mycompany.io/arch=x64`; `k8s.pod.labels.data=` | Recommended |
 | [`k8s.pod.name`](../attributes-registry/k8s.md) | string | The name of the Pod. | `opentelemetry-pod-autoconf` | Recommended |
 | [`k8s.pod.uid`](../attributes-registry/k8s.md) | string | The UID of the Pod. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |

diff --git a/model/registry/k8s.yaml b/model/registry/k8s.yaml
@@ -69,6 +69,11 @@ groups:
  brief: >
  The labels placed on the Pod, the `<key>` being the label name, the value being the label value.
  examples: ['k8s.pod.labels.app=my-app', 'k8s.pod.labels.mycompany.io/arch=x64', 'k8s.pod.labels.data=']
+ - id: pod.annotation
+ type: template[string]
+ brief: >
+ The annotation key-value pairs placed on the Pod, the `<key>` being the annotation name, the value being the annotation value.
+ examples: [ 'k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true', 'k8s.pod.annotation.mycompany.io/arch=x64', 'k8s.pod.annotation.data=' ]
  - id: container.name
  type: string
  brief: >

diff --git a/model/resource/k8s.yaml b/model/resource/k8s.yaml
@@ -34,6 +34,8 @@ groups:
  - ref: k8s.pod.uid
  - ref: k8s.pod.name
  - ref: k8s.pod.labels
+ - ref: k8s.pod.annotation
+ requirement_level: opt_in
 
  - id: k8s.container
  prefix: k8s.container