/* * Copyright The OpenTelemetry Authors * SPDX-License-Identifier: Apache-2.0 */ /* * DO NOT EDIT, this is an Auto-generated file from: * buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2 */ #pragma once #include "opentelemetry/common/macros.h" #include "opentelemetry/version.h" OPENTELEMETRY_BEGIN_NAMESPACE namespace semconv { namespace k8s { /** The name of the cluster. */ static constexpr const char *kK8sClusterName = "k8s.cluster.name"; /** A pseudo-ID for the cluster, set to the UID of the @code kube-system @endcode namespace.

K8s doesn't have support for obtaining a cluster ID. If this is ever added, we will recommend collecting the @code k8s.cluster.uid @endcode through the official APIs. In the meantime, we are able to use the @code uid @endcode of the @code kube-system @endcode 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 @code kube-system @endcode namespace is used by Kubernetes itself and will exist for the lifetime of the cluster. Using the @code uid @endcode of the @code kube-system @endcode 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. */ static constexpr const char *kK8sClusterUid = "k8s.cluster.uid"; /** The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (@code container.name @endcode). */ static constexpr const char *kK8sContainerName = "k8s.container.name"; /** Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. */ static constexpr const char *kK8sContainerRestartCount = "k8s.container.restart_count"; /** Last terminated reason of the Container. */ static constexpr const char *kK8sContainerStatusLastTerminatedReason = "k8s.container.status.last_terminated_reason"; /** The cronjob annotation placed on the CronJob, the @code @endcode being the annotation name, the value being the annotation value.

Examples:

*/ static constexpr const char *kK8sCronjobAnnotation = "k8s.cronjob.annotation"; /** The label placed on the CronJob, the @code @endcode being the label name, the value being the label value.

Examples:

*/ static constexpr const char *kK8sCronjobLabel = "k8s.cronjob.label"; /** The name of the CronJob. */ static constexpr const char *kK8sCronjobName = "k8s.cronjob.name"; /** The UID of the CronJob. */ static constexpr const char *kK8sCronjobUid = "k8s.cronjob.uid"; /** The annotation key-value pairs placed on the DaemonSet.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sDaemonsetAnnotation = "k8s.daemonset.annotation"; /** The label key-value pairs placed on the DaemonSet.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sDaemonsetLabel = "k8s.daemonset.label"; /** The name of the DaemonSet. */ static constexpr const char *kK8sDaemonsetName = "k8s.daemonset.name"; /** The UID of the DaemonSet. */ static constexpr const char *kK8sDaemonsetUid = "k8s.daemonset.uid"; /** The annotation key-value pairs placed on the Deployment.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sDeploymentAnnotation = "k8s.deployment.annotation"; /** The label key-value pairs placed on the Deployment.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sDeploymentLabel = "k8s.deployment.label"; /** The name of the Deployment. */ static constexpr const char *kK8sDeploymentName = "k8s.deployment.name"; /** The UID of the Deployment. */ static constexpr const char *kK8sDeploymentUid = "k8s.deployment.uid"; /** The name of the horizontal pod autoscaler. */ static constexpr const char *kK8sHpaName = "k8s.hpa.name"; /** The UID of the horizontal pod autoscaler. */ static constexpr const char *kK8sHpaUid = "k8s.hpa.uid"; /** The annotation key-value pairs placed on the Job.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sJobAnnotation = "k8s.job.annotation"; /** The label key-value pairs placed on the Job.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sJobLabel = "k8s.job.label"; /** The name of the Job. */ static constexpr const char *kK8sJobName = "k8s.job.name"; /** The UID of the Job. */ static constexpr const char *kK8sJobUid = "k8s.job.uid"; /** The annotation key-value pairs placed on the Namespace.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sNamespaceAnnotation = "k8s.namespace.annotation"; /** The label key-value pairs placed on the Namespace.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sNamespaceLabel = "k8s.namespace.label"; /** The name of the namespace that the pod is running in. */ static constexpr const char *kK8sNamespaceName = "k8s.namespace.name"; /** The phase of the K8s namespace.

This attribute aligns with the @code phase @endcode field of the K8s NamespaceStatus */ static constexpr const char *kK8sNamespacePhase = "k8s.namespace.phase"; /** The annotation placed on the Node, the @code @endcode being the annotation name, the value being the annotation value, even if the value is empty.

Examples:

*/ static constexpr const char *kK8sNodeAnnotation = "k8s.node.annotation"; /** The label placed on the Node, the @code @endcode being the label name, the value being the label value, even if the value is empty.

Examples:

*/ static constexpr const char *kK8sNodeLabel = "k8s.node.label"; /** The name of the Node. */ static constexpr const char *kK8sNodeName = "k8s.node.name"; /** The UID of the Node. */ static constexpr const char *kK8sNodeUid = "k8s.node.uid"; /** The annotation placed on the Pod, the @code @endcode being the annotation name, the value being the annotation value.

Examples:

  • An annotation @code kubernetes.io/enforce-mountable-secrets @endcode with value @code true @endcode SHOULD be recorded as the @code k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets @endcode attribute with value @code "true" @endcode.
  • An annotation @code mycompany.io/arch @endcode with value @code x64 @endcode SHOULD be recorded as the @code k8s.pod.annotation.mycompany.io/arch @endcode attribute with value @code "x64" @endcode.
  • An annotation @code data @endcode with empty string value SHOULD be recorded as the @code k8s.pod.annotation.data @endcode attribute with value @code "" @endcode.
*/ static constexpr const char *kK8sPodAnnotation = "k8s.pod.annotation"; /** The label placed on the Pod, the @code @endcode being the label name, the value being the label value.

Examples:

  • A label @code app @endcode with value @code my-app @endcode SHOULD be recorded as the @code k8s.pod.label.app @endcode attribute with value @code "my-app" @endcode.
  • A label @code mycompany.io/arch @endcode with value @code x64 @endcode SHOULD be recorded as the @code k8s.pod.label.mycompany.io/arch @endcode attribute with value @code "x64" @endcode.
  • A label @code data @endcode with empty string value SHOULD be recorded as the @code k8s.pod.label.data @endcode attribute with value @code "" @endcode.
*/ static constexpr const char *kK8sPodLabel = "k8s.pod.label"; /** Deprecated, use @code k8s.pod.label @endcode instead. @deprecated {"note": "Replaced by @code k8s.pod.label @endcode.", "reason": "renamed", "renamed_to": "k8s.pod.label"} */ OPENTELEMETRY_DEPRECATED static constexpr const char *kK8sPodLabels = "k8s.pod.labels"; /** The name of the Pod. */ static constexpr const char *kK8sPodName = "k8s.pod.name"; /** The UID of the Pod. */ static constexpr const char *kK8sPodUid = "k8s.pod.uid"; /** The annotation key-value pairs placed on the ReplicaSet.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sReplicasetAnnotation = "k8s.replicaset.annotation"; /** The label key-value pairs placed on the ReplicaSet.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sReplicasetLabel = "k8s.replicaset.label"; /** The name of the ReplicaSet. */ static constexpr const char *kK8sReplicasetName = "k8s.replicaset.name"; /** The UID of the ReplicaSet. */ static constexpr const char *kK8sReplicasetUid = "k8s.replicaset.uid"; /** The name of the replication controller. */ static constexpr const char *kK8sReplicationcontrollerName = "k8s.replicationcontroller.name"; /** The UID of the replication controller. */ static constexpr const char *kK8sReplicationcontrollerUid = "k8s.replicationcontroller.uid"; /** The name of the resource quota. */ static constexpr const char *kK8sResourcequotaName = "k8s.resourcequota.name"; /** The UID of the resource quota. */ static constexpr const char *kK8sResourcequotaUid = "k8s.resourcequota.uid"; /** The annotation key-value pairs placed on the StatefulSet.

The @code @endcode being the annotation name, the value being the annotation value, even if the value is empty. */ static constexpr const char *kK8sStatefulsetAnnotation = "k8s.statefulset.annotation"; /** The label key-value pairs placed on the StatefulSet.

The @code @endcode being the label name, the value being the label value, even if the value is empty. */ static constexpr const char *kK8sStatefulsetLabel = "k8s.statefulset.label"; /** The name of the StatefulSet. */ static constexpr const char *kK8sStatefulsetName = "k8s.statefulset.name"; /** The UID of the StatefulSet. */ static constexpr const char *kK8sStatefulsetUid = "k8s.statefulset.uid"; /** The name of the K8s volume. */ static constexpr const char *kK8sVolumeName = "k8s.volume.name"; /** The type of the K8s volume. */ static constexpr const char *kK8sVolumeType = "k8s.volume.type"; namespace K8sNamespacePhaseValues { /** Active namespace phase as described by K8s API */ static constexpr const char *kActive = "active"; /** Terminating namespace phase as described by K8s API */ static constexpr const char *kTerminating = "terminating"; } // namespace K8sNamespacePhaseValues namespace K8sVolumeTypeValues { /** A persistentVolumeClaim volume */ static constexpr const char *kPersistentVolumeClaim = "persistentVolumeClaim"; /** A configMap volume */ static constexpr const char *kConfigMap = "configMap"; /** A downwardAPI volume */ static constexpr const char *kDownwardApi = "downwardAPI"; /** An emptyDir volume */ static constexpr const char *kEmptyDir = "emptyDir"; /** A secret volume */ static constexpr const char *kSecret = "secret"; /** A local volume */ static constexpr const char *kLocal = "local"; } // namespace K8sVolumeTypeValues } // namespace k8s } // namespace semconv OPENTELEMETRY_END_NAMESPACE