Kubernetes

Status: Development

Useful resources to understand Kubernetes objects and metadata:

• Namespace
• Names and UIDs.
• Pods
• Controllers

The “name” of a Kubernetes object is unique for that type of object within a “namespace” and only at a specific moment of time (names can be reused over time). The “uid” is unique across your whole cluster, and very likely across time. Because of this it is recommended to always set the UID for every Kubernetes object, but “name” is usually more user friendly so can be also set.

Cluster

Status:

type: k8s.cluster

Description: A Kubernetes Cluster.

Attribute	Type	Description	Examples	Requirement Level	Stability
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

[1] k8s.cluster.uid: 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.

Node

Status:

type: k8s.node

Description: A Kubernetes Node object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.node.annotation.<key>	string	The annotation placed on the Node, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	0; ``	Opt-In
k8s.node.label.<key>	string	The label placed on the Node, the <key> being the label name, the value being the label value, even if the value is empty. [2]	arm64; ``	Opt-In

[1] k8s.node.annotation.<key>: 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 "".

[2] k8s.node.label.<key>: 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 "".

Namespace

Namespaces provide a scope for names. Names of objects need to be unique within a namespace, but not across namespaces.

Status:

type: k8s.namespace

Description: A Kubernetes Namespace.

Attribute	Type	Description	Examples	Requirement Level	Stability
k8s.namespace.name	string	The name of the namespace that the pod is running in.	default	Recommended
k8s.namespace.annotation.<key>	string	The annotation placed on the Namespace, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	0; ``	Opt-In
k8s.namespace.label.<key>	string	The label placed on the Namespace, the <key> being the label name, the value being the label value, even if the value is empty. [2]	default; ``	Opt-In

[1] k8s.namespace.annotation.<key>: Examples:

• A label ttl with value 0 SHOULD be recorded as the k8s.namespace.annotation.ttl attribute with value "0".
• A label data with empty string value SHOULD be recorded as the k8s.namespace.annotation.data attribute with value "".

[2] k8s.namespace.label.<key>: Examples:

• A label kubernetes.io/metadata.name with value default SHOULD be recorded as the k8s.namespace.label.kubernetes.io/metadata.name attribute with value "default".
• A label data with empty string value SHOULD be recorded as the k8s.namespace.label.data attribute with value "".

Pod

The smallest and simplest Kubernetes object. A Pod represents a set of running containers on your cluster.

Status:

type: k8s.pod

Description: A Kubernetes Pod object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.pod.annotation.<key>	string	The annotation placed on the Pod, the <key> being the annotation name, the value being the annotation value. [1]	true; x64; ``	Opt-In
k8s.pod.label.<key>	string	The label placed on the Pod, the <key> being the label name, the value being the label value. [2]	my-app; x64; ``	Opt-In

[1] k8s.pod.annotation.<key>: 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".
• An annotation mycompany.io/arch with value x64 SHOULD be recorded as the k8s.pod.annotation.mycompany.io/arch attribute with value "x64".
• An annotation data with empty string value SHOULD be recorded as the k8s.pod.annotation.data attribute with value "".

[2] k8s.pod.label.<key>: Examples:

• A label app with value my-app SHOULD be recorded as the k8s.pod.label.app attribute with value "my-app".
• A label mycompany.io/arch with value x64 SHOULD be recorded as the k8s.pod.label.mycompany.io/arch attribute with value "x64".
• A label data with empty string value SHOULD be recorded as the k8s.pod.label.data attribute with value "".

Container

A container specification in a Pod template. This type is intended to be used to capture information such as name of a container in a Pod template which is different from the name of the running container.

Note: This type is different from container, which corresponds to a running container.

Status:

type: k8s.container

Description: A container in a PodTemplate.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.		Recommended
k8s.container.status.last_terminated_reason	string	Last terminated reason of the Container.	Evicted; Error	Recommended

ReplicaSet

Status:

type: k8s.replicaset

Description: A Kubernetes ReplicaSet object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.replicaset.annotation.<key>	string	The annotation placed on the ReplicaSet, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	0; ``	Opt-In
k8s.replicaset.label.<key>	string	The label placed on the ReplicaSet, the <key> being the label name, the value being the label value, even if the value is empty. [2]	guestbook; ``	Opt-In

[1] k8s.replicaset.annotation.<key>: Examples:

• A label replicas with value 0 SHOULD be recorded as the k8s.replicaset.annotation.replicas attribute with value "0".
• A label data with empty string value SHOULD be recorded as the k8s.replicaset.annotation.data attribute with value "".

[2] k8s.replicaset.label.<key>: Examples:

• A label app with value guestbook SHOULD be recorded as the k8s.replicaset.label.app attribute with value "guestbook".
• A label injected with empty string value SHOULD be recorded as the k8s.replicaset.label.injected attribute with value "".

Deployment

An API object that manages a replicated application, typically by running Pods with no local state. Each replica is represented by a Pod, and the Pods are distributed among the nodes of a cluster.

Status:

type: k8s.deployment

Description: A Kubernetes Deployment object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.deployment.annotation.<key>	string	The annotation placed on the Deployment, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	1; ``	Opt-In
k8s.deployment.label.<key>	string	The label placed on the Deployment, the <key> being the label name, the value being the label value, even if the value is empty. [2]	guestbook; ``	Opt-In

[1] k8s.deployment.annotation.<key>: Examples:

• A label replicas with value 1 SHOULD be recorded as the k8s.deployment.annotation.replicas attribute with value "1".
• A label data with empty string value SHOULD be recorded as the k8s.deployment.annotation.data attribute with value "".

[2] k8s.deployment.label.<key>: Examples:

• A label replicas with value 0 SHOULD be recorded as the k8s.deployment.label.app attribute with value "guestbook".
• A label injected with empty string value SHOULD be recorded as the k8s.deployment.label.injected attribute with value "".

StatefulSet

Manages the deployment and scaling of a set of Pods, and provides guarantees about the ordering and uniqueness of these Pods.

Status:

type: k8s.statefulset

Description: A Kubernetes StatefulSet object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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
k8s.statefulset.annotation.<key>	string	The annotation placed on the StatefulSet, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	1; ``	Opt-In
k8s.statefulset.label.<key>	string	The label placed on the StatefulSet, the <key> being the label name, the value being the label value, even if the value is empty. [2]	guestbook; ``	Opt-In

[1] k8s.statefulset.annotation.<key>: Examples:

• A label replicas with value 1 SHOULD be recorded as the k8s.statefulset.annotation.replicas attribute with value "1".
• A label data with empty string value SHOULD be recorded as the k8s.statefulset.annotation.data attribute with value "".

[2] k8s.statefulset.label.<key>: Examples:

• A label replicas with value 0 SHOULD be recorded as the k8s.statefulset.label.app attribute with value "guestbook".
• A label injected with empty string value SHOULD be recorded as the k8s.statefulset.label.injected attribute with value "".

DaemonSet

A DaemonSet ensures that all (or some) Nodes run a copy of a Pod.

Status:

type: k8s.daemonset

Description: A Kubernetes DaemonSet object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.daemonset.annotation.<key>	string	The annotation placed on the DaemonSet, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	1; ``	Opt-In
k8s.daemonset.label.<key>	string	The label placed on the DaemonSet, the <key> being the label name, the value being the label value, even if the value is empty. [2]	guestbook; ``	Opt-In

[1] k8s.daemonset.annotation.<key>: Examples:

• A label replicas with value 1 SHOULD be recorded as the k8s.daemonset.annotation.replicas attribute with value "1".
• A label data with empty string value SHOULD be recorded as the k8s.daemonset.annotation.data attribute with value "".

[2] k8s.daemonset.label.<key>: Examples:

• A label app with value guestbook SHOULD be recorded as the k8s.daemonset.label.app attribute with value "guestbook".
• A label data with empty string value SHOULD be recorded as the k8s.daemonset.label.injected attribute with value "".

Job

A Job creates one or more Pods and ensures that a specified number of them successfully terminate.

Status:

type: k8s.job

Description: A Kubernetes Job object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.job.annotation.<key>	string	The annotation placed on the Job, the <key> being the annotation name, the value being the annotation value, even if the value is empty. [1]	1; ``	Opt-In
k8s.job.label.<key>	string	The label placed on the Job, the <key> being the label name, the value being the label value, even if the value is empty. [2]	ci; ``	Opt-In

[1] k8s.job.annotation.<key>: Examples:

• A label number with value 1 SHOULD be recorded as the k8s.job.annotation.number attribute with value "1".
• A label data with empty string value SHOULD be recorded as the k8s.job.annotation.data attribute with value "".

[2] k8s.job.label.<key>: Examples:

• A label jobtype with value ci SHOULD be recorded as the k8s.job.label.jobtype attribute with value "ci".
• A label data with empty string value SHOULD be recorded as the k8s.job.label.automated attribute with value "".

CronJob

A CronJob creates Jobs on a repeating schedule.

Status:

type: k8s.cronjob

Description: A Kubernetes CronJob object.

Attribute	Type	Description	Examples	Requirement Level	Stability
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.cronjob.annotation.<key>	string	The cronjob annotation placed on the CronJob, the <key> being the annotation name, the value being the annotation value. [1]	4; ``	Opt-In
k8s.cronjob.label.<key>	string	The label placed on the CronJob, the <key> being the label name, the value being the label value. [2]	weekly; ``	Opt-In

[1] k8s.cronjob.annotation.<key>: Examples:

• An annotation retries with value 4 SHOULD be recorded as the k8s.cronjob.annotation.retries attribute with value "4".
• An annotation data with empty string value SHOULD be recorded as the k8s.cronjob.annotation.data attribute with value "".

[2] k8s.cronjob.label.<key>: Examples:

• A label type with value weekly SHOULD be recorded as the k8s.cronjob.label.type attribute with value "weekly".
• A label automated with empty string value SHOULD be recorded as the k8s.cronjob.label.automated attribute with value "".

ReplicationController

A ReplicationController ensures that a specified number of pod replicas are running at any one time.

Status:

type: k8s.replicationcontroller

Description: A Kubernetes ReplicationController object.

Attribute	Type	Description	Examples	Requirement Level	Stability
k8s.replicationcontroller.name	string	The name of the replication controller.	opentelemetry	Recommended
k8s.replicationcontroller.uid	string	The UID of the replication controller.	275ecb36-5aa8-4c2a-9c47-d8bb681b9aff	Recommended

HorizontalPodAutoscaler

A HorizontalPodAutoscaler (HPA for short) automatically updates a workload resource (such as a Deployment or StatefulSet), with the aim of automatically scaling the workload to match demand.

Status:

type: k8s.hpa

Description: A Kubernetes HorizontalPodAutoscaler object.

Attribute	Type	Description	Examples	Requirement Level	Stability
k8s.hpa.name	string	The name of the horizontal pod autoscaler.	opentelemetry	Recommended
k8s.hpa.scaletargetref.api_version	string	The API version of the target resource to scale for the HorizontalPodAutoscaler. [1]	apps/v1; autoscaling/v2	Recommended
k8s.hpa.scaletargetref.kind	string	The kind of the target resource to scale for the HorizontalPodAutoscaler. [2]	Deployment; StatefulSet	Recommended
k8s.hpa.scaletargetref.name	string	The name of the target resource to scale for the HorizontalPodAutoscaler. [3]	my-deployment; my-statefulset	Recommended
k8s.hpa.uid	string	The UID of the horizontal pod autoscaler.	275ecb36-5aa8-4c2a-9c47-d8bb681b9aff	Recommended

[1] k8s.hpa.scaletargetref.api_version: This maps to the apiVersion field in the scaleTargetRef of the HPA spec.

[2] k8s.hpa.scaletargetref.kind: This maps to the kind field in the scaleTargetRef of the HPA spec.

[3] k8s.hpa.scaletargetref.name: This maps to the name field in the scaleTargetRef of the HPA spec.

ResourceQuota

A ResourceQuota provides constraints that limit aggregate resource consumption per namespace.

Status:

type: k8s.resourcequota

Description: A Kubernetes ResourceQuota object.

Attribute	Type	Description	Examples	Requirement Level	Stability
k8s.resourcequota.name	string	The name of the resource quota.	opentelemetry	Recommended
k8s.resourcequota.uid	string	The UID of the resource quota.	275ecb36-5aa8-4c2a-9c47-d8bb681b9aff	Recommended

Kubernetes specific guidelines

The following guidelines are specific to Kubernetes:

• Service attributes
• Naming known exceptions