Module: OpenTelemetry::SemanticConventions::Resource

Defined in:: lib/opentelemetry/semantic_conventions/resource.rb

Constant Summary collapse

CLOUD_PROVIDER = Name of the cloud provider

'cloud.provider'

CLOUD_ACCOUNT_ID = The cloud account ID the resource is assigned to

'cloud.account.id'

CLOUD_REGION =

Note:

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

The geographical region the resource is running

'cloud.region'

CLOUD_AVAILABILITY_ZONE =

Note:

Availability zones are called “zones” on Alibaba Cloud and Google Cloud

Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running

'cloud.availability_zone'

CLOUD_PLATFORM =

Note:

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

The cloud platform in use

'cloud.platform'

AWS_ECS_CONTAINER_ARN = The Amazon Resource Name (ARN) of an ECS container instance

'aws.ecs.container.arn'

AWS_ECS_CLUSTER_ARN = The ARN of an ECS cluster

'aws.ecs.cluster.arn'

AWS_ECS_LAUNCHTYPE = The launch type for an ECS task

'aws.ecs.launchtype'

AWS_ECS_TASK_ARN = The ARN of an ECS task definition

'aws.ecs.task.arn'

AWS_ECS_TASK_FAMILY = The task definition family this task definition is a member of

'aws.ecs.task.family'

AWS_ECS_TASK_REVISION = The revision for this task definition

'aws.ecs.task.revision'

AWS_EKS_CLUSTER_ARN = The ARN of an EKS cluster

'aws.eks.cluster.arn'

AWS_LOG_GROUP_NAMES =

Note:

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

The name(s) of the AWS log group(s) an application is writing to

'aws.log.group.names'

AWS_LOG_GROUP_ARNS =

Note:

See the log group ARN format documentation

The Amazon Resource Name(s) (ARN) of the AWS log group(s)

'aws.log.group.arns'

AWS_LOG_STREAM_NAMES = The name(s) of the AWS log stream(s) an application is writing to

'aws.log.stream.names'

AWS_LOG_STREAM_ARNS =

Note:

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

The ARN(s) of the AWS log stream(s)

'aws.log.stream.arns'

CONTAINER_NAME = Container name used by container runtime

'container.name'

CONTAINER_ID = Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated

'container.id'

CONTAINER_RUNTIME = The container runtime managing this container

'container.runtime'

CONTAINER_IMAGE_NAME = Name of the image the container was built on

'container.image.name'

CONTAINER_IMAGE_TAG = Container image tag

'container.image.tag'

DEPLOYMENT_ENVIRONMENT = Name of the deployment environment (aka deployment tier)

'deployment.environment'

DEVICE_ID =

Note:

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

A unique identifier representing the device

'device.id'

DEVICE_MODEL_IDENTIFIER =

Note:

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

The model identifier for the device

'device.model.identifier'

DEVICE_MODEL_NAME =

Note:

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

The marketing name for the device model

'device.model.name'

FAAS_NAME =

Note:

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)

The name of the single function that this runtime instance executes

'faas.name'

FAAS_ID =

Note:

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

The unique ID of the single function that this runtime instance executes

'faas.id'

FAAS_VERSION =

Note:

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

The immutable version of the function being executed

'faas.version'

FAAS_INSTANCE =

Note:

AWS Lambda: Use the (full) log stream name

The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version

'faas.instance'

FAAS_MAX_MEMORY =

Note:

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

The amount of memory available to the serverless function in MiB

'faas.max_memory'

HOST_ID = Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider

'host.id'

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.name'

HOST_TYPE = Type of host. For Cloud, this must be the machine type

'host.type'

HOST_ARCH = The CPU architecture the host system is running on

'host.arch'

HOST_IMAGE_NAME = Name of the VM image or OS install the host was instantiated from

'host.image.name'

HOST_IMAGE_ID = VM image ID. For Cloud, this value is from the provider

'host.image.id'

HOST_IMAGE_VERSION = The version string of the VM image as defined in Version Attributes

'host.image.version'

K8S_CLUSTER_NAME = The name of the cluster

'k8s.cluster.name'

K8S_NODE_NAME = The name of the Node

'k8s.node.name'

K8S_NODE_UID = The UID of the Node

'k8s.node.uid'

K8S_NAMESPACE_NAME = The name of the namespace that the pod is running in

'k8s.namespace.name'

K8S_POD_UID = The UID of the Pod

'k8s.pod.uid'

K8S_POD_NAME = The name of the Pod

'k8s.pod.name'

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.name'

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.container.restart_count'

K8S_REPLICASET_UID = The UID of the ReplicaSet

'k8s.replicaset.uid'

K8S_REPLICASET_NAME = The name of the ReplicaSet

'k8s.replicaset.name'

K8S_DEPLOYMENT_UID = The UID of the Deployment

'k8s.deployment.uid'

K8S_DEPLOYMENT_NAME = The name of the Deployment

'k8s.deployment.name'

K8S_STATEFULSET_UID = The UID of the StatefulSet

'k8s.statefulset.uid'

K8S_STATEFULSET_NAME = The name of the StatefulSet

'k8s.statefulset.name'

K8S_DAEMONSET_UID = The UID of the DaemonSet

'k8s.daemonset.uid'

K8S_DAEMONSET_NAME = The name of the DaemonSet

'k8s.daemonset.name'

K8S_JOB_UID = The UID of the Job

'k8s.job.uid'

K8S_JOB_NAME = The name of the Job

'k8s.job.name'

K8S_CRONJOB_UID = The UID of the CronJob

'k8s.cronjob.uid'

K8S_CRONJOB_NAME = The name of the CronJob

'k8s.cronjob.name'

OS_TYPE = The operating system type

'os.type'

OS_DESCRIPTION = Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands

'os.description'

OS_NAME = Human readable operating system name

'os.name'

OS_VERSION = The version string of the operating system as defined in Version Attributes

'os.version'

PROCESS_PID = Process identifier (PID)

'process.pid'

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.name'

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.executable.path'

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'

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_line'

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_args'

PROCESS_OWNER = The username of the user that owns the process

'process.owner'

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.name'

PROCESS_RUNTIME_VERSION = The version of the runtime of this process, as returned by the runtime without modification

'process.runtime.version'

PROCESS_RUNTIME_DESCRIPTION = An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment

'process.runtime.description'

SERVICE_NAME =

Note:

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

Logical name of the service

'service.name'

SERVICE_NAMESPACE =

Note:

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

A namespace for service.name

'service.namespace'

SERVICE_INSTANCE_ID =

Note:

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)

The string ID of the service instance

'service.instance.id'

SERVICE_VERSION = The version string of the service API or implementation

'service.version'

TELEMETRY_SDK_NAME = The name of the telemetry SDK as defined above

'telemetry.sdk.name'

TELEMETRY_SDK_LANGUAGE = The language of the telemetry SDK

'telemetry.sdk.language'

TELEMETRY_SDK_VERSION = The version string of the telemetry SDK

'telemetry.sdk.version'

TELEMETRY_AUTO_VERSION = The version string of the auto instrumentation agent, if used

'telemetry.auto.version'

WEBENGINE_NAME = The name of the web engine

'webengine.name'

WEBENGINE_VERSION = The version of the web engine

'webengine.version'

WEBENGINE_DESCRIPTION = Additional description of the web engine (e.g. detailed version and edition information)

'webengine.description'