Package io.opentelemetry.semconv
Class ResourceAttributes
java.lang.Object
io.opentelemetry.semconv.ResourceAttributes
Deprecated.
This class is deprecated and will be removed in a future release. It is only provided
as a convenience to help migration to the new semantic conventions classes structure that was
introduced in version 1.24.0.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDeprecated.static final classDeprecated.static final classDeprecated.static final classDeprecated.static final classDeprecated.static final classDeprecated. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Boolean>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.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>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.This item has been renamed in 1.22.0 of the semantic conventions.Deprecated.deprecated in favor of attribute.static final AttributeKeyTemplate<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.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>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final StringDeprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<Long>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final StringDeprecated.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.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>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute.static final io.opentelemetry.api.common.AttributeKey<String>Deprecated.deprecated in favor of attribute. -
Method Summary
-
Field Details
-
SCHEMA_URL
Deprecated.The URL of the OpenTelemetry schema for these keys and values.- See Also:
-
CLOUD_ACCOUNT_ID
Deprecated.deprecated in favor of attribute.The cloud account ID the resource is assigned to. -
CLOUD_AVAILABILITY_ZONE
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> CLOUD_AVAILABILITY_ZONEDeprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.The cloud platform in use.Notes:
- The prefix of the service SHOULD match the one specified in
cloud.provider.
- The prefix of the service SHOULD match the one specified in
-
CLOUD_PROVIDER
Deprecated.deprecated in favor of attribute.Name of the cloud provider. -
CLOUD_REGION
Deprecated.deprecated in favor of attribute.The geographical region the resource is running.Notes:
- Refer to your provider's docs to see the available regions, for example Alibaba Cloud regions, AWS regions, Azure regions, Google Cloud regions, or Tencent Cloud regions.
-
CLOUD_RESOURCE_ID
Deprecated.deprecated in favor of attribute.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_idas a span attribute instead. - The exact value to use for
cloud.resource_iddepends 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.
- On some cloud providers, it may not be possible to determine the full ID at startup, so
it may be necessary to set
-
CONTAINER_COMMAND
Deprecated.deprecated in favor of attribute.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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_COMMAND_ARGSDeprecated.deprecated in favor of attribute.All the command arguments (including the command/executable itself) run by the container. [2] -
CONTAINER_COMMAND_LINE
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_COMMAND_LINEDeprecated.deprecated in favor of attribute.The full command run by the container as a single string representing the full command. [2] -
CONTAINER_ID
Deprecated.deprecated in favor of attribute.Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated. -
CONTAINER_IMAGE_ID
Deprecated.deprecated in favor of attribute.Runtime specific image identifier. Usually a hash algorithm followed by a UUID.Notes:
- Docker defines a sha256 of the image id;
container.image.idcorresponds to theImagefield 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 usingoci.manifest.digestif it is important to identify the same image in different environments/runtimes.
- Docker defines a sha256 of the image id;
-
CONTAINER_IMAGE_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> CONTAINER_IMAGE_NAMEDeprecated.deprecated in favor of attribute.Name of the image the container was built on. -
CONTAINER_IMAGE_REPO_DIGESTS
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_IMAGE_REPO_DIGESTSDeprecated.deprecated in favor of attribute. -
CONTAINER_IMAGE_TAGS
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> CONTAINER_IMAGE_TAGSDeprecated.deprecated in favor of attribute.Container image tags. An example can be found in Docker Image Inspect. Should be only the<tag>section of the full name for example fromregistry.example.com/my-org/my-image:<tag>. -
CONTAINER_NAME
Deprecated.deprecated in favor of attribute.Container name used by container runtime. -
CONTAINER_RUNTIME
Deprecated.deprecated in favor of attribute.The container runtime managing this container. -
OCI_MANIFEST_DIGEST
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OCI_MANIFEST_DIGESTDeprecated.deprecated in favor of attribute.The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known.Notes:
- Follows OCI Image Manifest Specification, and specifically the Digest property. An example can be found in Example Image Manifest.
-
ANDROID_OS_API_LEVEL
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> ANDROID_OS_API_LEVELDeprecated.deprecated in favor of attribute.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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> BROWSER_BRANDSDeprecated.deprecated in favor of attribute.Array of brand name and version separated by a spaceNotes:
- This value is intended to be taken from the UA client hints API (
navigator.userAgentData.brands).
- This value is intended to be taken from the UA client hints API (
-
BROWSER_LANGUAGE
Deprecated.deprecated in favor of attribute.Preferred language of the user using the browserNotes:
- This value is intended to be taken from the Navigator API
navigator.language.
- This value is intended to be taken from the Navigator API
-
BROWSER_MOBILE
Deprecated.deprecated in favor of attribute.A boolean that is true if the browser is running on a mobile deviceNotes:
- This value is intended to be taken from the UA client hints API (
navigator.userAgentData.mobile). If unavailable, this attribute SHOULD be left unset.
- This value is intended to be taken from the UA client hints API (
-
BROWSER_PLATFORM
Deprecated.deprecated in favor of attribute.The platform on which the browser is runningNotes:
- This value is intended to be taken from the UA client hints API (
navigator.userAgentData.platform). If unavailable, the legacynavigator.platformAPI 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 theos.typeandos.nameattributes. However, for consistency, the values in thebrowser.platformattribute should capture the exact value that the user agent provides.
- This value is intended to be taken from the UA client hints API (
-
AWS_ECS_CLUSTER_ARN
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_CLUSTER_ARNDeprecated.deprecated in favor of attribute.The ARN of an ECS cluster. -
AWS_ECS_CONTAINER_ARN
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_CONTAINER_ARNDeprecated.deprecated in favor of attribute.The Amazon Resource Name (ARN) of an ECS container instance. -
AWS_ECS_LAUNCHTYPE
Deprecated.deprecated in favor of attribute.The launch type for an ECS task. -
AWS_ECS_TASK_ARN
Deprecated.deprecated in favor of attribute.The ARN of an ECS task definition. -
AWS_ECS_TASK_FAMILY
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_TASK_FAMILYDeprecated.deprecated in favor of attribute.The task definition family this task definition is a member of. -
AWS_ECS_TASK_REVISION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> AWS_ECS_TASK_REVISIONDeprecated.deprecated in favor of attribute.The revision for this task definition. -
AWS_EKS_CLUSTER_ARN
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> AWS_EKS_CLUSTER_ARNDeprecated.deprecated in favor of attribute.The ARN of an EKS cluster. -
AWS_LOG_GROUP_ARNS
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_GROUP_ARNSDeprecated.deprecated in favor of attribute.The Amazon Resource Name(s) (ARN) of the AWS log group(s).Notes:
- See the log group ARN format documentation.
-
AWS_LOG_GROUP_NAMES
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_GROUP_NAMESDeprecated.deprecated in favor of attribute.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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_STREAM_ARNSDeprecated.deprecated in favor of attribute.The ARN(s) of the AWS log stream(s).Notes:
- See the log stream ARN format documentation. One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.
-
AWS_LOG_STREAM_NAMES
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> AWS_LOG_STREAM_NAMESDeprecated.deprecated in favor of attribute.The name(s) of the AWS log stream(s) an application is writing to. -
GCP_CLOUD_RUN_JOB_EXECUTION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> GCP_CLOUD_RUN_JOB_EXECUTIONDeprecated.deprecated in favor of attribute.The name of the Cloud Run execution being run for the Job, as set by theCLOUD_RUN_EXECUTIONenvironment variable. -
GCP_CLOUD_RUN_JOB_TASK_INDEX
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> GCP_CLOUD_RUN_JOB_TASK_INDEXDeprecated.deprecated in favor of attribute.The index for a task within an execution as provided by theCLOUD_RUN_TASK_INDEXenvironment variable. -
GCP_GCE_INSTANCE_HOSTNAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> GCP_GCE_INSTANCE_HOSTNAMEDeprecated.deprecated in favor of attribute.The hostname of a GCE instance. This is the full value of the default or custom hostname. -
GCP_GCE_INSTANCE_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> GCP_GCE_INSTANCE_NAMEDeprecated.deprecated in favor of attribute.The instance name of a GCE instance. This is the value provided byhost.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
Deprecated.deprecated in favor of attribute.Unique identifier for the application -
HEROKU_RELEASE_COMMIT
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HEROKU_RELEASE_COMMITDeprecated.deprecated in favor of attribute.Commit hash for the current release -
HEROKU_RELEASE_CREATION_TIMESTAMP
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HEROKU_RELEASE_CREATION_TIMESTAMPDeprecated.deprecated in favor of attribute.Time and date the release was created -
DEPLOYMENT_ENVIRONMENT
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DEPLOYMENT_ENVIRONMENTDeprecated.deprecated in favor of attribute.Name of the deployment environment (aka deployment tier). -
DEVICE_ID
Deprecated.deprecated in favor of attribute.A unique identifier representing the deviceNotes:
- 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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MANUFACTURERDeprecated.deprecated in favor of attribute.The name of the device manufacturerNotes:
- The Android OS provides this field via Build.
iOS apps SHOULD hardcode the value
Apple.
- The Android OS provides this field via Build.
iOS apps SHOULD hardcode the value
-
DEVICE_MODEL_IDENTIFIER
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> DEVICE_MODEL_IDENTIFIERDeprecated.deprecated in favor of attribute.The model identifier for the deviceNotes:
- 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
Deprecated.deprecated in favor of attribute.The marketing name for the device modelNotes:
- It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
-
FAAS_INSTANCE
Deprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.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_SIZEprovides this information (which must be multiplied by 1,048,576).
- 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
-
FAAS_NAME
Deprecated.deprecated in favor of attribute.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.functionspan 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 thecloud.resource_idattribute).
- 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
-
FAAS_VERSION
Deprecated.deprecated in favor of attribute.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_REVISIONenvironment variable. - Azure Functions: Not applicable. Do not set this attribute.
-
HOST_ARCH
Deprecated.deprecated in favor of attribute.The CPU architecture the host system is running on. -
HOST_ID
Deprecated.deprecated in favor of attribute.Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be themachine-id. See the table below for the sources to use to determine themachine-idbased on operating system. -
HOST_IMAGE_ID
Deprecated.deprecated in favor of attribute.VM image ID or host OS image ID. For Cloud, this value is from the provider. -
HOST_IMAGE_NAME
Deprecated.deprecated in favor of attribute.Name of the VM image or OS install the host was instantiated from. -
HOST_IMAGE_VERSION
Deprecated.deprecated in favor of attribute.The version string of the VM image or host OS as defined in Version Attributes. -
HOST_IP
Deprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.Type of host. For Cloud, this must be the machine type. -
HOST_CPU_CACHE_L2_SIZE
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HOST_CPU_CACHE_L2_SIZEDeprecated.deprecated in favor of attribute.The amount of level 2 memory cache available to the processor (in Bytes). -
HOST_CPU_FAMILY
Deprecated.deprecated in favor of attribute.Numeric value specifying the family or generation of the CPU. -
HOST_CPU_MODEL_ID
Deprecated.deprecated in favor of attribute.Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. -
HOST_CPU_MODEL_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HOST_CPU_MODEL_NAMEDeprecated.deprecated in favor of attribute.Model designation of the processor. -
HOST_CPU_STEPPING
Deprecated.deprecated in favor of attribute.Stepping or core revisions. -
HOST_CPU_VENDOR_ID
Deprecated.deprecated in favor of attribute.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
Deprecated.deprecated in favor of attribute.The name of the cluster. -
K8S_CLUSTER_UID
Deprecated.deprecated in favor of attribute.A pseudo-ID for the cluster, set to the UID of thekube-systemnamespace.Notes:
- K8s doesn't have support for obtaining a cluster ID. If this is ever added, we will
recommend collecting the
k8s.cluster.uidthrough the official APIs. In the meantime, we are able to use theuidof thekube-systemnamespace 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-systemnamespace is used by Kubernetes itself and will exist for the lifetime of the cluster. Using theuidof thekube-systemnamespace 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 doesn't have support for obtaining a cluster ID. If this is ever added, we will
recommend collecting the
-
K8S_NODE_NAME
Deprecated.deprecated in favor of attribute.The name of the Node. -
K8S_NODE_UID
Deprecated.deprecated in favor of attribute.The UID of the Node. -
K8S_NAMESPACE_NAME
Deprecated.deprecated in favor of attribute.The name of the namespace that the pod is running in. -
K8S_POD_NAME
Deprecated.deprecated in favor of attribute.The name of the Pod. -
K8S_POD_UID
Deprecated.deprecated in favor of attribute.The UID of the Pod. -
K8S_CONTAINER_NAME
Deprecated.deprecated in favor of attribute.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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> K8S_CONTAINER_RESTART_COUNTDeprecated.deprecated in favor of attribute.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
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> K8S_REPLICASET_NAMEDeprecated.deprecated in favor of attribute.The name of the ReplicaSet. -
K8S_REPLICASET_UID
Deprecated.deprecated in favor of attribute.The UID of the ReplicaSet. -
K8S_DEPLOYMENT_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> K8S_DEPLOYMENT_NAMEDeprecated.deprecated in favor of attribute.The name of the Deployment. -
K8S_DEPLOYMENT_UID
Deprecated.deprecated in favor of attribute.The UID of the Deployment. -
K8S_STATEFULSET_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> K8S_STATEFULSET_NAMEDeprecated.deprecated in favor of attribute.The name of the StatefulSet. -
K8S_STATEFULSET_UID
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> K8S_STATEFULSET_UIDDeprecated.deprecated in favor of attribute.The UID of the StatefulSet. -
K8S_DAEMONSET_NAME
Deprecated.deprecated in favor of attribute.The name of the DaemonSet. -
K8S_DAEMONSET_UID
Deprecated.deprecated in favor of attribute.The UID of the DaemonSet. -
K8S_JOB_NAME
Deprecated.deprecated in favor of attribute.The name of the Job. -
K8S_JOB_UID
Deprecated.deprecated in favor of attribute.The UID of the Job. -
K8S_CRONJOB_NAME
Deprecated.deprecated in favor of attribute.The name of the CronJob. -
K8S_CRONJOB_UID
Deprecated.deprecated in favor of attribute.The UID of the CronJob. -
OS_BUILD_ID
Deprecated.deprecated in favor of attribute.Unique identifier for a particular build or compilation of the operating system. -
OS_DESCRIPTION
Deprecated.deprecated in favor of attribute.Human readable (not intended to be parsed) OS version information, like e.g. reported byverorlsb_release -acommands. -
OS_NAME
Deprecated.deprecated in favor of attribute.Human readable operating system name. -
OS_TYPE
Deprecated.deprecated in favor of attribute.The operating system type. -
OS_VERSION
Deprecated.deprecated in favor of attribute.The version string of the operating system as defined in Version Attributes. -
PROCESS_COMMAND
Deprecated.deprecated in favor of attribute.The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string inproc/[pid]/cmdline. On Windows, can be set to the first parameter extracted fromGetCommandLineW. -
PROCESS_COMMAND_ARGS
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<List<String>> PROCESS_COMMAND_ARGSDeprecated.deprecated in favor of attribute.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 fromproc/[pid]/cmdline. For libc-based executables, this would be the full argv vector passed tomain. -
PROCESS_COMMAND_LINE
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_COMMAND_LINEDeprecated.deprecated in favor of attribute.The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result ofGetCommandLineW. Do not set this if you have to assemble it just for monitoring; useprocess.command_argsinstead. -
PROCESS_EXECUTABLE_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_EXECUTABLE_NAMEDeprecated.deprecated in favor of attribute.The name of the process executable. On Linux based systems, can be set to theNameinproc/[pid]/status. On Windows, can be set to the base name ofGetProcessImageFileNameW. -
PROCESS_EXECUTABLE_PATH
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_EXECUTABLE_PATHDeprecated.deprecated in favor of attribute.The full path to the process executable. On Linux based systems, can be set to the target ofproc/[pid]/exe. On Windows, can be set to the result ofGetProcessImageFileNameW. -
PROCESS_OWNER
Deprecated.deprecated in favor of attribute.The username of the user that owns the process. -
PROCESS_PARENT_PID
Deprecated.deprecated in favor of attribute.Parent Process identifier (PID). -
PROCESS_PID
Deprecated.deprecated in favor of attribute.Process identifier (PID). -
PROCESS_RUNTIME_DESCRIPTION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_DESCRIPTIONDeprecated.deprecated in favor of attribute.An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. -
PROCESS_RUNTIME_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_NAMEDeprecated.deprecated in favor of attribute.The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. -
PROCESS_RUNTIME_VERSION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> PROCESS_RUNTIME_VERSIONDeprecated.deprecated in favor of attribute.The version of the runtime of this process, as returned by the runtime without modification. -
SERVICE_NAME
Deprecated.deprecated in favor of attribute.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 withprocess.executable.name, e.g.unknown_service:bash. Ifprocess.executable.nameis not available, the value MUST be set tounknown_service.
- MUST be the same for all instances of horizontally scaled services. If the value was not
specified, SDKs MUST fallback to
-
SERVICE_VERSION
Deprecated.deprecated in favor of attribute.The version string of the service API or implementation. The format is not defined by these conventions. -
SERVICE_INSTANCE_ID
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> SERVICE_INSTANCE_IDDeprecated.deprecated in favor of attribute.The string ID of the service instance.Notes:
- MUST be unique for each instance of the same
service.namespace,service.namepair (in other wordsservice.namespace,service.name,service.instance.idtriplet 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).
- MUST be unique for each instance of the same
-
SERVICE_NAMESPACE
Deprecated.deprecated in favor of attribute.A namespace forservice.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.nameis expected to be unique within the same namespace. Ifservice.namespaceis not specified in the Resource thenservice.nameis 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.
- 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.
-
TELEMETRY_SDK_LANGUAGE
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_SDK_LANGUAGEDeprecated.deprecated in favor of attribute.The language of the telemetry SDK. -
TELEMETRY_SDK_NAME
Deprecated.deprecated in favor of attribute.The name of the telemetry SDK as defined above.Notes:
- The OpenTelemetry SDK MUST set the
telemetry.sdk.nameattribute toopentelemetry. If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set thetelemetry.sdk.nameattribute to the fully-qualified class or module name of this SDK's main entry point or another suitable identifier depending on the language. The identifieropentelemetryis reserved and MUST NOT be used in this case. All custom identifiers SHOULD be stable across different versions of an implementation.
- The OpenTelemetry SDK MUST set the
-
TELEMETRY_SDK_VERSION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_SDK_VERSIONDeprecated.deprecated in favor of attribute.The version string of the telemetry SDK. -
TELEMETRY_DISTRO_NAME
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_DISTRO_NAMEDeprecated.deprecated in favor of attribute.The name of the auto instrumentation agent or distribution, if used.Notes:
- Official auto instrumentation agents and distributions SHOULD set the
telemetry.distro.nameattribute to a string starting withopentelemetry-, e.g.opentelemetry-java-instrumentation.
- Official auto instrumentation agents and distributions SHOULD set the
-
TELEMETRY_DISTRO_VERSION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_DISTRO_VERSIONDeprecated.deprecated in favor of attribute.The version string of the auto instrumentation agent or distribution, if used. -
WEBENGINE_DESCRIPTION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> WEBENGINE_DESCRIPTIONDeprecated.deprecated in favor of attribute.Additional description of the web engine (e.g. detailed version and edition information). -
WEBENGINE_NAME
Deprecated.deprecated in favor of attribute.The name of the web engine. -
WEBENGINE_VERSION
Deprecated.deprecated in favor of attribute.The version of the web engine. -
OTEL_SCOPE_NAME
Deprecated.deprecated in favor of attribute.The name of the instrumentation scope - (InstrumentationScope.Namein OTLP). -
OTEL_SCOPE_VERSION
Deprecated.deprecated in favor of attribute.The version of the instrumentation scope - (InstrumentationScope.Versionin OTLP). -
OTEL_LIBRARY_NAME
Deprecated.deprecated in favor of attribute.Deprecated, use theotel.scope.nameattribute. -
OTEL_LIBRARY_VERSION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> OTEL_LIBRARY_VERSIONDeprecated.deprecated in favor of attribute.Deprecated, use theotel.scope.versionattribute. -
CONTAINER_LABELS
Deprecated.deprecated in favor of attribute.Container labels,<key>being the label name, the value being the label value. -
GCP_OPENSHIFT
Deprecated.deprecated in favor of attribute.Red Hat OpenShift on Google Cloud.- See Also:
-
BROWSER_USER_AGENT
Deprecated.This item has been renamed in 1.19.0 version of the semantic conventions. UseSemanticAttributes.USER_AGENT_ORIGINALinstead.Full user-agent string provided by the browserNotes:
- 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.userAgentAPI can be used.
- 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
-
FAAS_ID
Deprecated.This item has been removed in 1.19.0 version of the semantic conventions. UseCLOUD_RESOURCE_IDinstead.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.idas a span attribute instead. - The exact value to use for
faas.iddepends 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.
- On some cloud providers, it may not be possible to determine the full ID at startup, so
consider setting
-
TELEMETRY_AUTO_VERSION
@Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> TELEMETRY_AUTO_VERSIONDeprecated.This item has been renamed in 1.22.0 of the semantic conventions. UseTELEMETRY_DISTRO_VERSIONinstead.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_TAGDeprecated.This item has been renamed in 1.22.0 of the semantic conventions. UseCONTAINER_IMAGE_TAGSinstead.Container image tag.
-