Documentation

The URL of the OpenTelemetry schema for these keys and values.

Array of brand name and version separated by a space

Notes

This value is intended to be taken from the https://wicg.github.io/ua-client-hints/#interface (navigator.userAgentData.brands).

The platform on which the browser is running

Notes

This value is intended to be taken from the https://wicg.github.io/ua-client-hints/#interface (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 https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform. Note that some (but not all) of these values can overlap with values in the ./os.md. However, for consistency, the values in the browser.platform attribute should capture the exact value that the user agent provides.

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.

Name of the cloud provider.

The cloud account ID the resource is assigned to.

The geographical region the resource is running.

Notes

Refer to your provider's docs to see the available regions, for example https://www.alibabacloud.com/help/doc-detail/40654.htm, https://aws.amazon.com/about-aws/global-infrastructure/regions_az/, https://azure.microsoft.com/en-us/global-infrastructure/geographies/, https://cloud.google.com/about/locations, or https://intl.cloud.tencent.com/document/product/213/6091.

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.

The cloud platform in use.

Notes

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

The Amazon Resource Name (ARN) of an https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html.

The ARN of an https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html.

The https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html for an ECS task.

The ARN of an https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html.

The task definition family this task definition is a member of.

The revision for this task definition.

The ARN of an EKS cluster.

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.

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

Notes

See the https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format.

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

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

Notes

See the https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format. One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.

Container name used by container runtime.

Container ID. Usually a UUID, as for example used to https://docs.docker.com/engine/reference/run/#container-identification. The UUID might be abbreviated.

The container runtime managing this container.

Name of the image the container was built on.

Container image tag.

Name of the https://en.wikipedia.org/wiki/Deployment_environment (aka deployment tier).

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 https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor. 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 https://developer.android.com/training/articles/user-data-ids 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.

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.

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.

The name of the device manufacturer

Notes

The Android OS provides this field via https://developer.android.com/reference/android/os/Build#MANUFACTURER. iOS apps SHOULD hardcode the value Apple.

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 ../../trace/semantic_conventions/span-general.md#source-code-attributes 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 providersproducts:listrongAzure:<strong> 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 faas.id attribute)./li

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:listrongAWS Lambda:/strong The function https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html. Take care not to use the &quot;invoked ARN&quot; directly but replace any https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html with the resolved function version, as the same runtime instance may be invokable with multiple different aliases./li listrongGCP:/strong The https://cloud.google.com/iam/docs/full-resource-names/li listrongAzure:/strong The https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id of the invoked function, emnot/em 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./li

The immutable version of the function being executed.

Notes

Depending on the cloud provider and platform, use:listrongAWS Lambda:/strong The https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html (an integer represented as a decimal string)./li listrongGoogle Cloud Run:/strong The https://cloud.google.com/run/docs/managing/revisions (i.e., the function name plus the revision suffix)./li listrongGoogle Cloud Functions:/strong The value of the https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically./li listrongAzure Functions:/strong Not applicable. Do not set this attribute./li

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

Notes

listrongAWS Lambda:/strong Use the (full) log stream name./li

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.

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

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.

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

The CPU architecture the host system is running on.

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

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

The version string of the VM image as defined in README.md#version-attributes.

The name of the cluster.

The name of the Node.

The UID of the Node.

The name of the namespace that the pod is running in.

The UID of the Pod.

The name of the Pod.

The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (container.name).

Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec.

The UID of the ReplicaSet.

The name of the ReplicaSet.

The UID of the Deployment.

The name of the Deployment.

The UID of the StatefulSet.

The name of the StatefulSet.

The UID of the DaemonSet.

The name of the DaemonSet.

The UID of the Job.

The name of the Job.

The UID of the CronJob.

The name of the CronJob.

The operating system type.

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

Human readable operating system name.

The version string of the operating system as defined in ../../resource/semantic_conventions/README.md#version-attributes.

Process identifier (PID).

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.

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.

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.

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.

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.

The username of the user that owns the process.

The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler.

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

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

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.md#process, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service.

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.

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

The version string of the service API or implementation.

The name of the telemetry SDK as defined above.

The language of the telemetry SDK.

The version string of the telemetry SDK.

The version string of the auto instrumentation agent, if used.

The name of the web engine.

The version of the web engine.

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