K8s Attributes

Kubernetes resource attributes.

k8s.cluster.namestringThe name of the cluster.opentelemetry-clusterExperimental
k8s.cluster.uidstringA pseudo-ID for the cluster, set to the UID of the kube-system namespace. [1]218fc5a9-a5f1-4b54-aa05-46717d0ab26dExperimental
k8s.container.namestringThe name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (container.name).redisExperimental
k8s.container.restart_countintNumber of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec.Experimental
k8s.container.status.last_terminated_reasonstringLast terminated reason of the Container.Evicted; ErrorExperimental
k8s.cronjob.namestringThe name of the CronJob.opentelemetryExperimental
k8s.cronjob.uidstringThe UID of the CronJob.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.daemonset.namestringThe name of the DaemonSet.opentelemetryExperimental
k8s.daemonset.uidstringThe UID of the DaemonSet.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.deployment.namestringThe name of the Deployment.opentelemetryExperimental
k8s.deployment.uidstringThe UID of the Deployment.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.job.namestringThe name of the Job.opentelemetryExperimental
k8s.job.uidstringThe UID of the Job.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.namespace.namestringThe name of the namespace that the pod is running in.defaultExperimental
k8s.node.namestringThe name of the Node.node-1Experimental
k8s.node.uidstringThe UID of the Node.1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2Experimental
k8s.pod.annotation.<key>stringThe 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=Experimental
k8s.pod.label.<key>stringThe label key-value pairs placed on the Pod, the <key> being the label name, the value being the label value.k8s.pod.label.app=my-app; k8s.pod.label.mycompany.io/arch=x64; k8s.pod.label.data=Experimental
k8s.pod.namestringThe name of the Pod.opentelemetry-pod-autoconfExperimental
k8s.pod.uidstringThe UID of the Pod.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.replicaset.namestringThe name of the ReplicaSet.opentelemetryExperimental
k8s.replicaset.uidstringThe UID of the ReplicaSet.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental
k8s.statefulset.namestringThe name of the StatefulSet.opentelemetryExperimental
k8s.statefulset.uidstringThe UID of the StatefulSet.275ecb36-5aa8-4c2a-9c47-d8bb681b9affExperimental

[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 official APIs. In the meantime, we are able to use the uid of the kube-system namespace as a proxy for cluster ID. Read on for the rationale.

Every object created in a K8s cluster is assigned a distinct UID. The kube-system namespace is used by Kubernetes itself and will exist for the lifetime of the cluster. Using the uid of the kube-system namespace is a reasonable proxy for the K8s ClusterID as it will only change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are UUIDs as standardized by ISO/IEC 9834-8 and ITU-T X.667. Which states:

If generated according to one of the mechanisms defined in Rec. ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be different from all other UUIDs generated before 3603 A.D., or is extremely likely to be different (depending on the mechanism chosen).

Therefore, UIDs between clusters should be extremely unlikely to conflict.

K8s Deprecated Attributes

Describes deprecated k8s attributes.

k8s.pod.labels.<key>stringDeprecated, use k8s.pod.label instead.k8s.pod.label.app=my-appDeprecated
Replaced by k8s.pod.label.