Package io.opentelemetry.semconv.resource.attributes

Class ResourceAttributes

  • public final class ResourceAttributes
extends Object

    • Field Detail

      • SCHEMA_URL

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

      • CLOUD_PROVIDER

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

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

        public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_REGION
        The geographical region the resource is running. Refer to your provider's docs to see the available regions, for example AWS regions, Azure regions, or Google Cloud regions.

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

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

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

      • 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_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_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_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.

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

      • CONTAINER_NAME

        public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_NAME
        Container name.

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

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

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

        public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_IMAGE_TAG
        Container image tag.

      • 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_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_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).

      • FAAS_ID

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

        Notes:

        • Depending on the cloud provider, use:
        • 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.
        • On some providers, it may not be possible to determine the full ID at startup, which is why this field cannot be made required. For example, on AWS the account ID part of the ARN is not available without calling another AWS API which may be deemed too slow for a short-running lambda function. As an alternative, consider setting faas.id as a span attribute instead.

      • 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: 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.

      • 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 in MiB.

        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.

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

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

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

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

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

      • HOST_IMAGE_VERSION

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

      • K8S_CLUSTER_NAME

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

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

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

      • K8S_POD_NAME

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

      • K8S_CONTAINER_NAME

        public static final io.opentelemetry.api.common.AttributeKey<String> K8S_CONTAINER_NAME
        The name of the Container in a Pod template.

      • K8S_REPLICASET_UID

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

      • K8S_REPLICASET_NAME

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

      • K8S_DEPLOYMENT_UID

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

      • K8S_DEPLOYMENT_NAME

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

      • K8S_STATEFULSET_UID

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

      • K8S_STATEFULSET_NAME

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

      • K8S_DAEMONSET_UID

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

      • K8S_DAEMONSET_NAME

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

      • K8S_JOB_UID

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

      • K8S_JOB_NAME

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

      • K8S_CRONJOB_UID

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

      • K8S_CRONJOB_NAME

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

      • OS_TYPE

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

      • 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_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_PID

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

      • 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_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_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_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_OWNER

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

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

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

      • 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_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.

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

        public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_VERSION
        The version string of the service API or implementation.

      • TELEMETRY_SDK_NAME

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

      • TELEMETRY_SDK_LANGUAGE

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

      • TELEMETRY_SDK_VERSION

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

      • TELEMETRY_AUTO_VERSION

        public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_AUTO_VERSION
        The version string of the auto instrumentation agent, if used.

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

      • 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).