Class ResourceAttributes

java.lang.Object
io.opentelemetry.semconv.ResourceAttributes

public final class ResourceAttributes extends Object
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
     
    static final class 
     
    static final class 
     
    static final class 
     
    static final class 
     
    static final class 
     
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.opentelemetry.api.common.AttributeKey<String>
    Uniquely identifies the framework API revision offered by a version (os.version) of the android operating system.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The ARN of an ECS cluster.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The Amazon Resource Name (ARN) of an ECS container instance.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The launch type for an ECS task.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The ARN of an ECS task definition.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The task definition family this task definition is a member of.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The revision for this task definition.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The ARN of an EKS cluster.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    The Amazon Resource Name(s) (ARN) of the AWS log group(s).
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    The name(s) of the AWS log group(s) an application is writing to.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    The ARN(s) of the AWS log stream(s).
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    The name(s) of the AWS log stream(s) an application is writing to.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    Array of brand name and version separated by a space
    static final io.opentelemetry.api.common.AttributeKey<String>
    Preferred language of the user using the browser
    static final io.opentelemetry.api.common.AttributeKey<Boolean>
    A boolean that is true if the browser is running on a mobile device
    static final io.opentelemetry.api.common.AttributeKey<String>
    The platform on which the browser is running
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    This item has been renamed in 1.19.0 version of the semantic conventions.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The cloud account ID the resource is assigned to.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Cloud regions often have multiple, isolated locations known as zones to increase availability.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The cloud platform in use.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Name of the cloud provider.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The geographical region the resource is running.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Cloud provider-specific native identifier of the monitored cloud resource (e.g. an ARN on AWS, a fully qualified resource ID on Azure, a full resource name on GCP)
    static final io.opentelemetry.api.common.AttributeKey<String>
    The command used to run the container (i.e. the command name).
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    All the command arguments (including the command/executable itself) run by the container. [2]
    static final io.opentelemetry.api.common.AttributeKey<String>
    The full command run by the container as a single string representing the full command. [2]
    static final io.opentelemetry.api.common.AttributeKey<String>
    Container ID.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Runtime specific image identifier.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Name of the image the container was built on.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    Repo digests of the container image as provided by the container runtime.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    This item has been renamed in 1.22.0 of the semantic conventions.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    Container image tags.
    Container labels, <key> being the label name, the value being the label value.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Container name used by container runtime.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The container runtime managing this container.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Name of the deployment environment (aka deployment tier).
    static final io.opentelemetry.api.common.AttributeKey<String>
    A unique identifier representing the device
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the device manufacturer
    static final io.opentelemetry.api.common.AttributeKey<String>
    The model identifier for the device
    static final io.opentelemetry.api.common.AttributeKey<String>
    The marketing name for the device model
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    This item has been removed in 1.19.0 version of the semantic conventions.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    The amount of memory available to the serverless function converted to Bytes.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the single function that this runtime instance executes.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The immutable version of the function being executed.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION environment variable.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX environment variable.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The hostname of a GCE instance.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The instance name of a GCE instance.
    static final String
    Deprecated.
    This item has been removed as of 1.18.0 of the semantic conventions.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Unique identifier for the application
    static final io.opentelemetry.api.common.AttributeKey<String>
    Commit hash for the current release
    static final io.opentelemetry.api.common.AttributeKey<String>
    Time and date the release was created
    static final io.opentelemetry.api.common.AttributeKey<String>
    The CPU architecture the host system is running on.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    The amount of level 2 memory cache available to the processor (in Bytes).
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Numeric value specifying the family or generation of the CPU.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Model identifier.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Model designation of the processor.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Stepping or core revisions.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Processor manufacturer identifier.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Unique host ID.
    static final io.opentelemetry.api.common.AttributeKey<String>
    VM image ID or host OS image ID.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Name of the VM image or OS install the host was instantiated from.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version string of the VM image or host OS as defined in Version Attributes.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    Available IP addresses of the host, excluding loopback interfaces.
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    Available MAC addresses of the host, excluding loopback interfaces.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Name of the host.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Type of host.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the cluster.
    static final io.opentelemetry.api.common.AttributeKey<String>
    A pseudo-ID for the cluster, set to the UID of the kube-system namespace.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Container from Pod specification, must be unique within a Pod.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Number of times the container was restarted.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the CronJob.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the CronJob.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the DaemonSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the DaemonSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Deployment.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the Deployment.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Job.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the Job.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the namespace that the pod is running in.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Node.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the Node.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the Pod.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the Pod.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the ReplicaSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the ReplicaSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the StatefulSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The UID of the StatefulSet.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The digest of the OCI image manifest.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Unique identifier for a particular build or compilation of the operating system.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Human readable operating system name.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The operating system type.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version string of the operating system as defined in Version Attributes.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    Deprecated, use the `otel.scope.name` attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    Deprecated, use the `otel.scope.version` attribute.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the instrumentation scope - (InstrumentationScope.Name in OTLP).
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version of the instrumentation scope - (InstrumentationScope.Version in OTLP).
    static final io.opentelemetry.api.common.AttributeKey<String>
    The command used to launch the process (i.e. the command name).
    static final io.opentelemetry.api.common.AttributeKey<List<String>>
    All the command arguments (including the command/executable itself) as received by the process.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The full command used to launch the process as a single string representing the full command.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the process executable.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The full path to the process executable.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The username of the user that owns the process.
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Parent Process identifier (PID).
    static final io.opentelemetry.api.common.AttributeKey<Long>
    Process identifier (PID).
    static final io.opentelemetry.api.common.AttributeKey<String>
    An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the runtime of this process.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version of the runtime of this process, as returned by the runtime without modification.
    static final String
    The URL of the OpenTelemetry schema for these keys and values.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The string ID of the service instance.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Logical name of the service.
    static final io.opentelemetry.api.common.AttributeKey<String>
    A namespace for service.name.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version string of the service API or implementation.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Deprecated.
    This item has been renamed in 1.22.0 of the semantic conventions.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the auto instrumentation agent or distribution, if used.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version string of the auto instrumentation agent or distribution, if used.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The language of the telemetry SDK.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the telemetry SDK as defined above.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version string of the telemetry SDK.
    static final io.opentelemetry.api.common.AttributeKey<String>
    Additional description of the web engine (e.g. detailed version and edition information).
    static final io.opentelemetry.api.common.AttributeKey<String>
    The name of the web engine.
    static final io.opentelemetry.api.common.AttributeKey<String>
    The version of the web engine.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • SCHEMA_URL

      public static final String SCHEMA_URL
      The URL of the OpenTelemetry schema for these keys and values.
      See Also:
    • CLOUD_ACCOUNT_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_ACCOUNT_ID
      The cloud account ID the resource is assigned to.
    • CLOUD_AVAILABILITY_ZONE

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_AVAILABILITY_ZONE
      Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running.

      Notes:

      • Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
    • CLOUD_PLATFORM

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_PLATFORM
      The cloud platform in use.

      Notes:

      • The prefix of the service SHOULD match the one specified in cloud.provider.
    • CLOUD_PROVIDER

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_PROVIDER
      Name of the cloud provider.
    • CLOUD_REGION

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_REGION
      The geographical region the resource is running.

      Notes:

    • CLOUD_RESOURCE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_RESOURCE_ID
      Cloud provider-specific native identifier of the monitored cloud resource (e.g. an ARN on AWS, a fully qualified resource ID on Azure, a full resource name on GCP)

      Notes:

      • On some cloud providers, it may not be possible to determine the full ID at startup, so it may be necessary to set cloud.resource_id as a span attribute instead.
      • The exact value to use for cloud.resource_id depends on the cloud provider. The following well-known definitions MUST be used if you set this attribute and they apply:
      • AWS Lambda: The function ARN. Take care not to use the "invoked ARN" directly but replace any alias suffix with the resolved function version, as the same runtime instance may be invokable with multiple different aliases.
      • GCP: The URI of the resource
      • Azure: The Fully Qualified Resource ID of the invoked function, not the function app, having the form /subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>. This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share a TracerProvider.
    • CONTAINER_COMMAND

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_COMMAND
      The command used to run the container (i.e. the command name).

      Notes:

      • If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.
    • CONTAINER_COMMAND_ARGS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_COMMAND_ARGS
      All the command arguments (including the command/executable itself) run by the container. [2]
    • CONTAINER_COMMAND_LINE

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_COMMAND_LINE
      The full command run by the container as a single string representing the full command. [2]
    • CONTAINER_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_ID
      Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated.
    • CONTAINER_IMAGE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_IMAGE_ID
      Runtime specific image identifier. Usually a hash algorithm followed by a UUID.

      Notes:

      • Docker defines a sha256 of the image id; container.image.id corresponds to the Image field from the Docker container inspect API endpoint. K8s defines a link to the container registry repository with digest "imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625". The ID is assinged by the container runtime and can vary in different environments. Consider using oci.manifest.digest if it is important to identify the same image in different environments/runtimes.
    • CONTAINER_IMAGE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_IMAGE_NAME
      Name of the image the container was built on.
    • CONTAINER_IMAGE_REPO_DIGESTS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_IMAGE_REPO_DIGESTS
      Repo digests of the container image as provided by the container runtime.

      Notes:

      • Docker and CRI report those under the RepoDigests field.
    • CONTAINER_IMAGE_TAGS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_IMAGE_TAGS
      Container image tags. An example can be found in Docker Image Inspect. Should be only the <tag> section of the full name for example from registry.example.com/my-org/my-image:<tag>.
    • CONTAINER_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_NAME
      Container name used by container runtime.
    • CONTAINER_RUNTIME

      public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_RUNTIME
      The container runtime managing this container.
    • OCI_MANIFEST_DIGEST

      public static final io.opentelemetry.api.common.AttributeKey<String> OCI_MANIFEST_DIGEST
      The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known.

      Notes:

    • ANDROID_OS_API_LEVEL

      public static final io.opentelemetry.api.common.AttributeKey<String> ANDROID_OS_API_LEVEL
      Uniquely identifies the framework API revision offered by a version (os.version) of the android operating system. More information can be found here.
    • BROWSER_BRANDS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> BROWSER_BRANDS
      Array of brand name and version separated by a space

      Notes:

      • This value is intended to be taken from the UA client hints API ( navigator.userAgentData.brands).
    • BROWSER_LANGUAGE

      public static final io.opentelemetry.api.common.AttributeKey<String> BROWSER_LANGUAGE
      Preferred language of the user using the browser

      Notes:

      • This value is intended to be taken from the Navigator API navigator.language.
    • BROWSER_MOBILE

      public static final io.opentelemetry.api.common.AttributeKey<Boolean> BROWSER_MOBILE
      A boolean that is true if the browser is running on a mobile device

      Notes:

      • This value is intended to be taken from the UA client hints API ( navigator.userAgentData.mobile). If unavailable, this attribute SHOULD be left unset.
    • BROWSER_PLATFORM

      public static final io.opentelemetry.api.common.AttributeKey<String> BROWSER_PLATFORM
      The platform on which the browser is running

      Notes:

      • This value is intended to be taken from the UA client hints API ( navigator.userAgentData.platform). If unavailable, the legacy navigator.platform API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. The list of possible values is defined in the W3C User-Agent Client Hints specification. Note that some (but not all) of these values can overlap with values in the os.type and os.name attributes. However, for consistency, the values in the browser.platform attribute should capture the exact value that the user agent provides.
    • AWS_ECS_CLUSTER_ARN

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_CLUSTER_ARN
      The ARN of an ECS cluster.
    • AWS_ECS_CONTAINER_ARN

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_CONTAINER_ARN
      The Amazon Resource Name (ARN) of an ECS container instance.
    • AWS_ECS_LAUNCHTYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_LAUNCHTYPE
      The launch type for an ECS task.
    • AWS_ECS_TASK_ARN

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_TASK_ARN
      The ARN of an ECS task definition.
    • AWS_ECS_TASK_FAMILY

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_TASK_FAMILY
      The task definition family this task definition is a member of.
    • AWS_ECS_TASK_REVISION

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_TASK_REVISION
      The revision for this task definition.
    • AWS_EKS_CLUSTER_ARN

      public static final io.opentelemetry.api.common.AttributeKey<String> AWS_EKS_CLUSTER_ARN
      The ARN of an EKS cluster.
    • AWS_LOG_GROUP_ARNS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_GROUP_ARNS
      The Amazon Resource Name(s) (ARN) of the AWS log group(s).

      Notes:

    • AWS_LOG_GROUP_NAMES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_GROUP_NAMES
      The name(s) of the AWS log group(s) an application is writing to.

      Notes:

      • Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group.
    • AWS_LOG_STREAM_ARNS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_STREAM_ARNS
      The ARN(s) of the AWS log stream(s).

      Notes:

    • AWS_LOG_STREAM_NAMES

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_STREAM_NAMES
      The name(s) of the AWS log stream(s) an application is writing to.
    • GCP_CLOUD_RUN_JOB_EXECUTION

      public static final io.opentelemetry.api.common.AttributeKey<String> GCP_CLOUD_RUN_JOB_EXECUTION
      The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION environment variable.
    • GCP_CLOUD_RUN_JOB_TASK_INDEX

      public static final io.opentelemetry.api.common.AttributeKey<Long> GCP_CLOUD_RUN_JOB_TASK_INDEX
      The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX environment variable.
    • GCP_GCE_INSTANCE_HOSTNAME

      public static final io.opentelemetry.api.common.AttributeKey<String> GCP_GCE_INSTANCE_HOSTNAME
      The hostname of a GCE instance. This is the full value of the default or custom hostname.
    • GCP_GCE_INSTANCE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> GCP_GCE_INSTANCE_NAME
      The instance name of a GCE instance. This is the value provided by host.name, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name.
    • HEROKU_APP_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> HEROKU_APP_ID
      Unique identifier for the application
    • HEROKU_RELEASE_COMMIT

      public static final io.opentelemetry.api.common.AttributeKey<String> HEROKU_RELEASE_COMMIT
      Commit hash for the current release
    • HEROKU_RELEASE_CREATION_TIMESTAMP

      public static final io.opentelemetry.api.common.AttributeKey<String> HEROKU_RELEASE_CREATION_TIMESTAMP
      Time and date the release was created
    • DEPLOYMENT_ENVIRONMENT

      public static final io.opentelemetry.api.common.AttributeKey<String> DEPLOYMENT_ENVIRONMENT
      Name of the deployment environment (aka deployment tier).
    • DEVICE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_ID
      A unique identifier representing the device

      Notes:

      • The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the vendor identifier. On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found here on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence.
    • DEVICE_MANUFACTURER

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MANUFACTURER
      The name of the device manufacturer

      Notes:

      • The Android OS provides this field via Build. iOS apps SHOULD hardcode the value Apple.
    • DEVICE_MODEL_IDENTIFIER

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MODEL_IDENTIFIER
      The model identifier for the device

      Notes:

      • It's recommended this value represents a machine readable version of the model identifier rather than the market or consumer-friendly name of the device.
    • DEVICE_MODEL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MODEL_NAME
      The marketing name for the device model

      Notes:

      • It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
    • FAAS_INSTANCE

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_INSTANCE
      The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.

      Notes:

      • AWS Lambda: Use the (full) log stream name.
    • FAAS_MAX_MEMORY

      public static final io.opentelemetry.api.common.AttributeKey<Long> FAAS_MAX_MEMORY
      The amount of memory available to the serverless function converted to Bytes.

      Notes:

      • It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE provides this information (which must be multiplied by 1,048,576).
    • FAAS_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_NAME
      The name of the single function that this runtime instance executes.

      Notes:

      • This is the name of the function as configured/deployed on the FaaS platform and is usually different from the name of the callback function (which may be stored in the code.namespace/ code.function span attributes).
      • For some cloud providers, the above definition is ambiguous. The following definition of function name MUST be used for this attribute (and consequently the span name) for the listed cloud providers/products:
      • Azure: The full name <FUNCAPP>/<FUNC>, i.e., function app name followed by a forward slash followed by the function name (this form can also be seen in the resource JSON for the function). This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share a TracerProvider (see also the cloud.resource_id attribute).
    • FAAS_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_VERSION
      The immutable version of the function being executed.

      Notes:

      • Depending on the cloud provider and platform, use:
      • AWS Lambda: The function version (an integer represented as a decimal string).
      • Google Cloud Run (Services): The revision (i.e., the function name plus the revision suffix).
      • Google Cloud Functions: The value of the K_REVISION environment variable.
      • Azure Functions: Not applicable. Do not set this attribute.
    • HOST_ARCH

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_ARCH
      The CPU architecture the host system is running on.
    • HOST_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_ID
      Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id. See the table below for the sources to use to determine the machine-id based on operating system.
    • HOST_IMAGE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_IMAGE_ID
      VM image ID or host OS image ID. For Cloud, this value is from the provider.
    • HOST_IMAGE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_IMAGE_NAME
      Name of the VM image or OS install the host was instantiated from.
    • HOST_IMAGE_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_IMAGE_VERSION
      The version string of the VM image or host OS as defined in Version Attributes.
    • HOST_IP

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> HOST_IP
      Available IP addresses of the host, excluding loopback interfaces.

      Notes:

      • IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format.
    • HOST_MAC

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> HOST_MAC
      Available MAC addresses of the host, excluding loopback interfaces.

      Notes:

      • MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
    • HOST_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_NAME
      Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user.
    • HOST_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_TYPE
      Type of host. For Cloud, this must be the machine type.
    • HOST_CPU_CACHE_L2_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HOST_CPU_CACHE_L2_SIZE
      The amount of level 2 memory cache available to the processor (in Bytes).
    • HOST_CPU_FAMILY

      public static final io.opentelemetry.api.common.AttributeKey<Long> HOST_CPU_FAMILY
      Numeric value specifying the family or generation of the CPU.
    • HOST_CPU_MODEL_ID

      public static final io.opentelemetry.api.common.AttributeKey<Long> HOST_CPU_MODEL_ID
      Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family.
    • HOST_CPU_MODEL_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_CPU_MODEL_NAME
      Model designation of the processor.
    • HOST_CPU_STEPPING

      public static final io.opentelemetry.api.common.AttributeKey<Long> HOST_CPU_STEPPING
      Stepping or core revisions.
    • HOST_CPU_VENDOR_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> HOST_CPU_VENDOR_ID
      Processor manufacturer identifier. A maximum 12-character string.

      Notes:

      • CPUID command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string.
    • 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_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_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_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_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_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_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_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.
    • 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_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_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.
    • OS_BUILD_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> OS_BUILD_ID
      Unique identifier for a particular build or compilation of the operating system.
    • OS_DESCRIPTION

      public static final io.opentelemetry.api.common.AttributeKey<String> OS_DESCRIPTION
      Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands.
    • OS_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> OS_NAME
      Human readable operating system name.
    • OS_TYPE

      public static final io.opentelemetry.api.common.AttributeKey<String> OS_TYPE
      The operating system type.
    • OS_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> OS_VERSION
      The version string of the operating system as defined in Version Attributes.
    • PROCESS_COMMAND

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_COMMAND
      The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in proc/[pid]/cmdline. On Windows, can be set to the first parameter extracted from GetCommandLineW.
    • PROCESS_COMMAND_ARGS

      public static final io.opentelemetry.api.common.AttributeKey<List<String>> PROCESS_COMMAND_ARGS
      All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from proc/[pid]/cmdline. For libc-based executables, this would be the full argv vector passed to main.
    • PROCESS_COMMAND_LINE

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_COMMAND_LINE
      The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of GetCommandLineW. Do not set this if you have to assemble it just for monitoring; use process.command_args instead.
    • PROCESS_EXECUTABLE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_EXECUTABLE_NAME
      The name of the process executable. On Linux based systems, can be set to the Name in proc/[pid]/status. On Windows, can be set to the base name of GetProcessImageFileNameW.
    • PROCESS_EXECUTABLE_PATH

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_EXECUTABLE_PATH
      The full path to the process executable. On Linux based systems, can be set to the target of proc/[pid]/exe. On Windows, can be set to the result of GetProcessImageFileNameW.
    • PROCESS_OWNER

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_OWNER
      The username of the user that owns the process.
    • PROCESS_PARENT_PID

      public static final io.opentelemetry.api.common.AttributeKey<Long> PROCESS_PARENT_PID
      Parent Process identifier (PID).
    • PROCESS_PID

      public static final io.opentelemetry.api.common.AttributeKey<Long> PROCESS_PID
      Process identifier (PID).
    • PROCESS_RUNTIME_DESCRIPTION

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_DESCRIPTION
      An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment.
    • PROCESS_RUNTIME_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_NAME
      The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler.
    • PROCESS_RUNTIME_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_VERSION
      The version of the runtime of this process, as returned by the runtime without modification.
    • SERVICE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_NAME
      Logical name of the service.

      Notes:

      • MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to unknown_service: concatenated with process.executable.name, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service.
    • SERVICE_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_VERSION
      The version string of the service API or implementation. The format is not defined by these conventions.
    • SERVICE_INSTANCE_ID

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_INSTANCE_ID
      The string ID of the service instance.

      Notes:

      • MUST be unique for each instance of the same service.namespace,service.name pair (in other words service.namespace,service.name,service.instance.id triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations).
    • SERVICE_NAMESPACE

      public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_NAMESPACE
      A namespace for service.name.

      Notes:

      • A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. service.name is expected to be unique within the same namespace. If service.namespace is not specified in the Resource then service.name is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
    • TELEMETRY_SDK_LANGUAGE

      public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_SDK_LANGUAGE
      The language of the telemetry SDK.
    • TELEMETRY_SDK_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_SDK_NAME
      The name of the telemetry SDK as defined above.

      Notes:

      • The OpenTelemetry SDK MUST set the telemetry.sdk.name attribute to opentelemetry. If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the telemetry.sdk.name attribute to the fully-qualified class or module name of this SDK's main entry point or another suitable identifier depending on the language. The identifier opentelemetry is reserved and MUST NOT be used in this case. All custom identifiers SHOULD be stable across different versions of an implementation.
    • TELEMETRY_SDK_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_SDK_VERSION
      The version string of the telemetry SDK.
    • TELEMETRY_DISTRO_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_DISTRO_NAME
      The name of the auto instrumentation agent or distribution, if used.

      Notes:

      • Official auto instrumentation agents and distributions SHOULD set the telemetry.distro.name attribute to a string starting with opentelemetry-, e.g. opentelemetry-java-instrumentation.
    • TELEMETRY_DISTRO_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_DISTRO_VERSION
      The version string of the auto instrumentation agent or distribution, if used.
    • WEBENGINE_DESCRIPTION

      public static final io.opentelemetry.api.common.AttributeKey<String> WEBENGINE_DESCRIPTION
      Additional description of the web engine (e.g. detailed version and edition information).
    • WEBENGINE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> WEBENGINE_NAME
      The name of the web engine.
    • WEBENGINE_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> WEBENGINE_VERSION
      The version of the web engine.
    • OTEL_SCOPE_NAME

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_NAME
      The name of the instrumentation scope - (InstrumentationScope.Name in OTLP).
    • OTEL_SCOPE_VERSION

      public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_SCOPE_VERSION
      The version of the instrumentation scope - (InstrumentationScope.Version in OTLP).
    • OTEL_LIBRARY_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_NAME
      Deprecated.
      Deprecated, use the `otel.scope.name` attribute.
      Deprecated, use the otel.scope.name attribute.
    • OTEL_LIBRARY_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_VERSION
      Deprecated.
      Deprecated, use the `otel.scope.version` attribute.
      Deprecated, use the otel.scope.version attribute.
    • CONTAINER_LABELS

      public static final AttributeKeyTemplate<String> CONTAINER_LABELS
      Container labels, <key> being the label name, the value being the label value.
    • GCP_OPENSHIFT

      @Deprecated public static final String GCP_OPENSHIFT
      Deprecated.
      This item has been removed as of 1.18.0 of the semantic conventions. Use GCP_OPENSHIFT instead.
      Red Hat OpenShift on Google Cloud.
      See Also:
    • BROWSER_USER_AGENT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> BROWSER_USER_AGENT
      Deprecated.
      This item has been renamed in 1.19.0 version of the semantic conventions. Use SemanticAttributes.USER_AGENT_ORIGINAL instead.
      Full user-agent string provided by the browser

      Notes:

      • The user-agent value SHOULD be provided only from browsers that do not have a mechanism to retrieve brands and platform individually from the User-Agent Client Hints API. To retrieve the value, the legacy navigator.userAgent API can be used.
    • FAAS_ID

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> FAAS_ID
      Deprecated.
      This item has been removed in 1.19.0 version of the semantic conventions. Use CLOUD_RESOURCE_ID instead.
      The unique ID of the single function that this runtime instance executes.

      Notes:

      • On some cloud providers, it may not be possible to determine the full ID at startup, so consider setting faas.id as a span attribute instead.
      • The exact value to use for faas.id depends on the cloud provider:
      • AWS Lambda: The function ARN. Take care not to use the "invoked ARN" directly but replace any alias suffix with the resolved function version, as the same runtime instance may be invokable with multiple different aliases.
      • GCP: The URI of the resource
      • Azure: The Fully Qualified Resource ID of the invoked function, not the function app, having the form /subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>. This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share a TracerProvider.
    • TELEMETRY_AUTO_VERSION

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_AUTO_VERSION
      Deprecated.
      This item has been renamed in 1.22.0 of the semantic conventions. Use TELEMETRY_DISTRO_VERSION instead.
      The version string of the auto instrumentation agent, if used.
    • CONTAINER_IMAGE_TAG

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_IMAGE_TAG
      Deprecated.
      This item has been renamed in 1.22.0 of the semantic conventions. Use CONTAINER_IMAGE_TAGS instead.
      Container image tag.