Package io.opentelemetry.semconv.incubating

Class K8sIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.K8sIncubatingAttributes
public final class K8sIncubatingAttributes extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_CLUSTER_NAME
    The name of the cluster.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_CLUSTER_UID
    A pseudo-ID for the cluster, set to the UID of the kube-system namespace.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_CONTAINER_NAME
    The name of the Container from Pod specification, must be unique within a Pod.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    K8S_CONTAINER_RESTART_COUNT
    Number of times the container was restarted.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_CRONJOB_NAME
    The name of the CronJob.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_CRONJOB_UID
    The UID of the CronJob.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_DAEMONSET_NAME
    The name of the DaemonSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_DAEMONSET_UID
    The UID of the DaemonSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_DEPLOYMENT_NAME
    The name of the Deployment.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_DEPLOYMENT_UID
    The UID of the Deployment.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_JOB_NAME
    The name of the Job.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_JOB_UID
    The UID of the Job.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_NAMESPACE_NAME
    The name of the namespace that the pod is running in.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_NODE_NAME
    The name of the Node.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_NODE_UID
    The UID of the Node.
    static final io.opentelemetry.semconv.AttributeKeyTemplate<String>
    K8S_POD_ANNOTATION
    The annotation key-value pairs placed on the Pod, the <key> being the annotation name, the value being the annotation value.
    static final io.opentelemetry.semconv.AttributeKeyTemplate<String>
    K8S_POD_LABEL
    The label key-value pairs placed on the Pod, the <key> being the label name, the value being the label value.
    static final io.opentelemetry.semconv.AttributeKeyTemplate<String>
    K8S_POD_LABELS
    Deprecated.
    Deprecated, use `k8s.pod.label` instead.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_POD_NAME
    The name of the Pod.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_POD_UID
    The UID of the Pod.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_REPLICASET_NAME
    The name of the ReplicaSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_REPLICASET_UID
    The UID of the ReplicaSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_STATEFULSET_NAME
    The name of the StatefulSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    K8S_STATEFULSET_UID
    The UID of the StatefulSet.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • K8S_CLUSTER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CLUSTER_NAME
      The name of the cluster.

    • K8S_CLUSTER_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CLUSTER_UID
      A pseudo-ID for the cluster, set to the UID of the kube-system namespace.

      Notes:

      • 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_CONTAINER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CONTAINER_NAME
      The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (container.name).

    • K8S_CONTAINER_RESTART_COUNT

      public static final io.opentelemetry.api.common.AttributeKey<Long> K8S_CONTAINER_RESTART_COUNT
      Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec.

    • K8S_CRONJOB_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CRONJOB_NAME
      The name of the CronJob.

    • K8S_CRONJOB_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CRONJOB_UID
      The UID of the CronJob.

    • K8S_DAEMONSET_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_DAEMONSET_NAME
      The name of the DaemonSet.

    • K8S_DAEMONSET_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_DAEMONSET_UID
      The UID of the DaemonSet.

    • K8S_DEPLOYMENT_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_DEPLOYMENT_NAME
      The name of the Deployment.

    • K8S_DEPLOYMENT_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_DEPLOYMENT_UID
      The UID of the Deployment.

    • K8S_JOB_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_JOB_NAME
      The name of the Job.

    • K8S_JOB_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_JOB_UID
      The UID of the Job.

    • K8S_NAMESPACE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_NAMESPACE_NAME
      The name of the namespace that the pod is running in.

    • K8S_NODE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_NODE_NAME
      The name of the Node.

    • K8S_NODE_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_NODE_UID
      The UID of the Node.

    • K8S_POD_ANNOTATION

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> K8S_POD_ANNOTATION
      The annotation key-value pairs placed on the Pod, the <key> being the annotation name, the value being the annotation value.

    • K8S_POD_LABEL

      public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> K8S_POD_LABEL
      The label key-value pairs placed on the Pod, the <key> being the label name, the value being the label value.

    • K8S_POD_LABELS

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<String> K8S_POD_LABELS
      Deprecated.
      Deprecated, use `k8s.pod.label` instead.
      Deprecated, use k8s.pod.label instead.

    • K8S_POD_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_POD_NAME
      The name of the Pod.

    • K8S_POD_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_POD_UID
      The UID of the Pod.

    • K8S_REPLICASET_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_REPLICASET_NAME
      The name of the ReplicaSet.

    • K8S_REPLICASET_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_REPLICASET_UID
      The UID of the ReplicaSet.

    • K8S_STATEFULSET_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_STATEFULSET_NAME
      The name of the StatefulSet.

    • K8S_STATEFULSET_UID

      public static final io.opentelemetry.api.common.AttributeKey<String> K8S_STATEFULSET_UID
      The UID of the StatefulSet.