ResourceAttributes
Attributes
- Source
- ResourceAttributes.scala
- Graph
-
- Supertypes
- Self type
-
ResourceAttributes.type
Members list
Type members
Classlikes
Attributes
- Companion
- object
- Source
- ResourceAttributes.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
Attributes
- Companion
- object
- Source
- ResourceAttributes.scala
- Supertypes
- Known subtypes
-
object AlibabaCloudEcsobject AlibabaCloudFcobject AlibabaCloudOpenshiftobject AwsAppRunnerobject AwsEc2object AwsEcsobject AwsEksobject AwsElasticBeanstalkobject AwsLambdaobject AwsOpenshiftobject AzureAksobject AzureAppServiceobject AzureContainerInstancesobject AzureFunctionsobject AzureOpenshiftobject AzureVmobject GcpAppEngineobject GcpBareMetalSolutionobject GcpCloudFunctionsobject GcpCloudRunobject GcpComputeEngineobject GcpKubernetesEngineobject GcpOpenshiftobject IbmCloudOpenshiftobject TencentCloudCvmobject TencentCloudEksobject TencentCloudScfShow all
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
-
CloudPlatformValue.type
Attributes
- Companion
- object
- Source
- ResourceAttributes.scala
- Supertypes
- Known subtypes
-
object AlibabaCloudobject Awsobject Azureobject Gcpobject Herokuobject IbmCloudobject TencentCloudShow all
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
-
CloudProviderValue.type
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
-
HostArchValue.type
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
-
OsTypeValue.type
Attributes
- Companion
- class
- Source
- ResourceAttributes.scala
- Supertypes
- Self type
Value members
Concrete fields
Uniquely identifies the framework API revision offered by a version (os.version
) of the android operating system.
Uniquely identifies the framework API revision offered by a version (os.version
) of the android operating system. More information can be found <a href="https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels">here.
Attributes
- Source
- ResourceAttributes.scala
The ARN of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html">ECS cluster.
The ARN of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html">ECS cluster.
Attributes
- Source
- ResourceAttributes.scala
The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html">ECS container instance.
The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html">ECS container instance.
Attributes
- Source
- ResourceAttributes.scala
The <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">launch type for an ECS task.
The <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">launch type for an ECS task.
Attributes
- Source
- ResourceAttributes.scala
The ARN of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html">ECS task definition.
The ARN of an <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html">ECS task definition.
Attributes
- Source
- ResourceAttributes.scala
The task definition family this task definition is a member of.
The task definition family this task definition is a member of.
Attributes
- Source
- ResourceAttributes.scala
The revision for this task definition.
The ARN of an EKS cluster.
The Amazon Resource Name(s) (ARN) of the AWS log group(s).
The Amazon Resource Name(s) (ARN) of the AWS log group(s).
Notes: - See the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format">log group ARN format documentation.
Attributes
- Source
- ResourceAttributes.scala
The name(s) of the AWS log group(s) an application is writing to.
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.
Attributes
- Source
- ResourceAttributes.scala
The ARN(s) of the AWS log stream(s).
The ARN(s) of the AWS log stream(s).
Notes: - See the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format">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.
Attributes
- Source
- ResourceAttributes.scala
The name(s) of the AWS log stream(s) an application is writing to.
The name(s) of the AWS log stream(s) an application is writing to.
Attributes
- Source
- ResourceAttributes.scala
Array of brand name and version separated by a space
Array of brand name and version separated by a space
Notes: - This value is intended to be taken from the <a href="https://wicg.github.io/ua-client-hints/#interface">UA client hints API (`navigator.userAgentData.brands`).
Attributes
- Source
- ResourceAttributes.scala
Preferred language of the user using the browser
Preferred language of the user using the browser
Notes: - This value is intended to be taken from the Navigator API navigator.language
.
Attributes
- Source
- ResourceAttributes.scala
A boolean that is true if the browser is running on a mobile device
A boolean that is true if the browser is running on a mobile device
Notes: - This value is intended to be taken from the <a href="https://wicg.github.io/ua-client-hints/#interface">UA client hints API (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset.
Attributes
- Source
- ResourceAttributes.scala
The platform on which the browser is running
The platform on which the browser is running
Notes: - This value is intended to be taken from the <a href="https://wicg.github.io/ua-client-hints/#interface">UA client hints API (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. The list of possible values is defined in the W3C User-Agent Client Hints specification. Note that some (but not all) of these values can overlap with values in the `os.type` and `os.name` attributes. However, for consistency, the values in the browser.platform
attribute should capture the exact value that the user agent provides.
Attributes
- Source
- ResourceAttributes.scala
The cloud account ID the resource is assigned to.
Cloud regions often have multiple, isolated locations known as zones to increase availability.
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.
Attributes
- Source
- ResourceAttributes.scala
The cloud platform in use.
The cloud platform in use.
Notes: - The prefix of the service SHOULD match the one specified in cloud.provider
.
Attributes
- Source
- ResourceAttributes.scala
Name of the cloud provider.
The geographical region the resource is running.
The geographical region the resource is running.
Notes: - Refer to your provider's docs to see the available regions, for example <a href="https://www.alibabacloud.com/help/doc-detail/40654.htm">Alibaba Cloud regions, AWS regions, <a href="https://azure.microsoft.com/global-infrastructure/geographies/">Azure regions, Google Cloud regions, or Tencent Cloud regions.
Attributes
- Source
- ResourceAttributes.scala
Cloud provider-specific native identifier of the monitored cloud resource (e.g.
Cloud provider-specific native identifier of the monitored cloud resource (e.g. an <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN on AWS, a fully qualified resource ID on Azure, a <a href="https://cloud.google.com/apis/design/resource_names#full_resource_name">full resource name on GCP) Notes: - On some cloud providers, it may not be possible to determine the full ID at startup, so it may be necessary to set `cloud.resource_id` as a span attribute instead. - The exact value to use for `cloud.resource_id` depends on the cloud provider. The following well-known definitions MUST be used if you set this attribute and they apply: - AWS Lambda: The function ARN. Take care not to use the "invoked ARN" directly but replace any <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">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 <a href="https://docs.microsoft.com/rest/api/resources/resources/get-by-id">Fully Qualified Resource ID of the invoked function, not the function app, having the form `/subscriptions/
Attributes
- Source
- ResourceAttributes.scala
The command used to run the container (i.e.
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.
Attributes
- Source
- ResourceAttributes.scala
All the command arguments (including the command/executable itself) run by the container.
All the command arguments (including the command/executable itself) run by the container. [2]
Attributes
- Source
- ResourceAttributes.scala
The full command run by the container as a single string representing the full command.
The full command run by the container as a single string representing the full command. [2]
Attributes
- Source
- ResourceAttributes.scala
Container ID.
Container ID. Usually a UUID, as for example used to <a href="https://docs.docker.com/engine/reference/run/#container-identification">identify Docker containers. The UUID might be abbreviated.
Attributes
- Source
- ResourceAttributes.scala
Runtime specific image identifier.
Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
Notes: - Docker defines a sha256 of the image id; container.image.id
corresponds to the Image
field from the Docker container inspect <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect">API endpoint. K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`. The ID is assinged by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes.
Attributes
- Source
- ResourceAttributes.scala
Name of the image the container was built on.
Repo digests of the container image as provided by the container runtime.
Repo digests of the container image as provided by the container runtime.
Notes: - <a href="https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect">Docker and CRI report those under the RepoDigests
field.
Attributes
- Source
- ResourceAttributes.scala
Container image tags.
Container image tags. An example can be found in <a href="https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect">Docker Image Inspect. Should be only the `
Attributes
- Source
- ResourceAttributes.scala
Container name used by container runtime.
The container runtime managing this container.
Name of the <a href="https://wikipedia.org/wiki/Deployment_environment">deployment environment (aka deployment tier).
Name of the <a href="https://wikipedia.org/wiki/Deployment_environment">deployment environment (aka deployment tier).
Attributes
- Source
- ResourceAttributes.scala
A unique identifier representing the device
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 <a href="https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor">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.
Attributes
- Source
- ResourceAttributes.scala
The name of the device manufacturer
The name of the device manufacturer
Notes: - The Android OS provides this field via <a href="https://developer.android.com/reference/android/os/Build#MANUFACTURER">Build. iOS apps SHOULD hardcode the value `Apple`.
Attributes
- Source
- ResourceAttributes.scala
The model identifier for the device
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.
Attributes
- Source
- ResourceAttributes.scala
The marketing name for the device model
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.
Attributes
- Source
- ResourceAttributes.scala
The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.
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.
Attributes
- Source
- ResourceAttributes.scala
The amount of memory available to the serverless function converted to Bytes.
The amount of memory available to the serverless function converted to Bytes.
Notes: - It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE
provides this information (which must be multiplied by 1,048,576).
Attributes
- Source
- ResourceAttributes.scala
The name of the single function that this runtime instance executes.
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 <a href="/docs/general/attributes.md#source-code-attributes">code.namespace
/code.function
span attributes). - For some cloud providers, the above definition is ambiguous. The following definition of function name MUST be used for this attribute (and consequently the span name) for the listed cloud providers/products: - Azure: The full name `
Attributes
- Source
- ResourceAttributes.scala
The immutable version of the function being executed.
The immutable version of the function being executed.
Notes: - Depending on the cloud provider and platform, use: - AWS Lambda: The <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html">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 <a href="https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically">K_REVISION
environment variable. - Azure Functions: Not applicable. Do not set this attribute.
Attributes
- Source
- ResourceAttributes.scala
The name of the Cloud Run <a href="https://cloud.google.com/run/docs/managing/job-executions">execution being run for the Job, as set by the `CLOUD_RUN_EXECUTION` environment variable.
The name of the Cloud Run <a href="https://cloud.google.com/run/docs/managing/job-executions">execution being run for the Job, as set by the `CLOUD_RUN_EXECUTION` environment variable.
Attributes
- Source
- ResourceAttributes.scala
The index for a task within an execution as provided by the <a href="https://cloud.google.com/run/docs/container-contract#jobs-env-vars">CLOUD_RUN_TASK_INDEX
environment variable.
The index for a task within an execution as provided by the <a href="https://cloud.google.com/run/docs/container-contract#jobs-env-vars">CLOUD_RUN_TASK_INDEX
environment variable.
Attributes
- Source
- ResourceAttributes.scala
The hostname of a GCE instance.
The hostname of a GCE instance. This is the full value of the default or <a href="https://cloud.google.com/compute/docs/instances/custom-hostname-vm">custom hostname.
Attributes
- Source
- ResourceAttributes.scala
The instance name of a GCE instance.
The instance name of a GCE instance. This is the value provided by host.name
, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the <a href="https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names">default internal DNS name.
Attributes
- Source
- ResourceAttributes.scala
Unique identifier for the application
Commit hash for the current release
Time and date the release was created
The CPU architecture the host system is running on.
The amount of level 2 memory cache available to the processor (in Bytes).
The amount of level 2 memory cache available to the processor (in Bytes).
Attributes
- Source
- ResourceAttributes.scala
Numeric value specifying the family or generation of the CPU.
Numeric value specifying the family or generation of the CPU.
Attributes
- Source
- ResourceAttributes.scala
Model identifier.
Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family.
Attributes
- Source
- ResourceAttributes.scala
Model designation of the processor.
Stepping or core revisions.
Processor manufacturer identifier.
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.
Attributes
- Source
- ResourceAttributes.scala
Unique host ID.
Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id
. See the table below for the sources to use to determine the machine-id
based on operating system.
Attributes
- Source
- ResourceAttributes.scala
VM image ID or host OS image ID.
VM image ID or host OS image ID. For Cloud, this value is from the provider.
Attributes
- Source
- ResourceAttributes.scala
Name of the VM image or OS install the host was instantiated from.
Name of the VM image or OS install the host was instantiated from.
Attributes
- Source
- ResourceAttributes.scala
The version string of the VM image or host OS as defined in <a href="README.md#version-attributes">Version Attributes.
The version string of the VM image or host OS as defined in <a href="README.md#version-attributes">Version Attributes.
Attributes
- Source
- ResourceAttributes.scala
Available IP addresses of the host, excluding loopback interfaces.
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 <a href="https://www.rfc-editor.org/rfc/rfc5952.html">RFC 5952 format.
Attributes
- Source
- ResourceAttributes.scala
Available MAC addresses of the host, excluding loopback interfaces.
Available MAC addresses of the host, excluding loopback interfaces.
Notes: - MAC Addresses MUST be represented in <a href="https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf">IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
Attributes
- Source
- ResourceAttributes.scala
Name of the host.
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.
Attributes
- Source
- ResourceAttributes.scala
Type of host.
The name of the cluster.
A pseudo-ID for the cluster, set to the UID of the kube-system
namespace.
A pseudo-ID for the cluster, set to the UID of the kube-system
namespace.
Notes: - K8s doesn't have support for obtaining a cluster ID. If this is ever added, we will recommend collecting the k8s.cluster.uid
through the official APIs. In the meantime, we are able to use the uid
of the kube-system
namespace as a proxy for cluster ID. Read on for the rationale. - Every object created in a K8s cluster is assigned a distinct UID. The kube-system
namespace is used by Kubernetes itself and will exist for the lifetime of the cluster. Using the uid
of the kube-system
namespace is a reasonable proxy for the K8s ClusterID as it will only change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are UUIDs as standardized by <a href="https://www.itu.int/ITU-T/studygroups/com17/oid.html">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.
Attributes
- Source
- ResourceAttributes.scala
The name of the Container from Pod specification, must be unique within a 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
).
Attributes
- Source
- ResourceAttributes.scala
Number of times the container was restarted.
Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec.
Attributes
- Source
- ResourceAttributes.scala
The name of the CronJob.
The UID of the CronJob.
The name of the DaemonSet.
The UID of the DaemonSet.
The name of the Deployment.
The UID of the Deployment.
The name of the Job.
The UID of the Job.
The name of the namespace that the pod is running in.
The name of the Node.
The UID of the Node.
The name of the Pod.
The UID of the Pod.
The name of the ReplicaSet.
The UID of the ReplicaSet.
The name of the StatefulSet.
The UID of the StatefulSet.
The digest of the OCI image manifest.
The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known.
Notes: - Follows <a href="https://github.com/opencontainers/image-spec/blob/main/manifest.md">OCI Image Manifest Specification, and specifically the Digest property. An example can be found in <a href="https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest">Example Image Manifest.
Attributes
- Source
- ResourceAttributes.scala
Unique identifier for a particular build or compilation of the operating system.
Unique identifier for a particular build or compilation of the operating system.
Attributes
- Source
- ResourceAttributes.scala
Human readable (not intended to be parsed) OS version information, like e.g.
Human readable (not intended to be parsed) OS version information, like e.g. reported by ver
or lsb_release -a
commands.
Attributes
- Source
- ResourceAttributes.scala
Human readable operating system name.
The operating system type.
The version string of the operating system as defined in <a href="/docs/resource/README.md#version-attributes">Version Attributes.
The version string of the operating system as defined in <a href="/docs/resource/README.md#version-attributes">Version Attributes.
Attributes
- Source
- ResourceAttributes.scala
The name of the instrumentation scope - (InstrumentationScope.Name
in OTLP).
The name of the instrumentation scope - (InstrumentationScope.Name
in OTLP).
Attributes
- Source
- ResourceAttributes.scala
The version of the instrumentation scope - (InstrumentationScope.Version
in OTLP).
The version of the instrumentation scope - (InstrumentationScope.Version
in OTLP).
Attributes
- Source
- ResourceAttributes.scala
The command used to launch the process (i.e.
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
.
Attributes
- Source
- ResourceAttributes.scala
All the command arguments (including the command/executable itself) as received by the process.
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
.
Attributes
- Source
- ResourceAttributes.scala
The full command used to launch the process as a single string representing the full command.
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.
Attributes
- Source
- ResourceAttributes.scala
The name of the process executable.
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
.
Attributes
- Source
- ResourceAttributes.scala
The full path to the process executable.
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
.
Attributes
- Source
- ResourceAttributes.scala
The username of the user that owns the process.
Parent Process identifier (PID).
Process identifier (PID).
An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment.
An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment.
Attributes
- Source
- ResourceAttributes.scala
The name of the runtime of this process.
The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler.
Attributes
- Source
- ResourceAttributes.scala
The version of the runtime of this process, as returned by the runtime without modification.
The version of the runtime of this process, as returned by the runtime without modification.
Attributes
- Source
- ResourceAttributes.scala
The URL of the OpenTelemetry schema for these keys and values.
The URL of the OpenTelemetry schema for these keys and values.
Attributes
- Source
- ResourceAttributes.scala
The string ID of the service instance.
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).
Attributes
- Source
- ResourceAttributes.scala
Logical name of the service.
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 <a href="process.md#process">process.executable.name
, e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
Attributes
- Source
- ResourceAttributes.scala
A namespace for service.name
.
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.
Attributes
- Source
- ResourceAttributes.scala
The version string of the service API or implementation.
The version string of the service API or implementation. The format is not defined by these conventions.
Attributes
- Source
- ResourceAttributes.scala
The name of the auto instrumentation agent or distribution, if used.
The name of the auto instrumentation agent or distribution, if used.
Notes: - Official auto instrumentation agents and distributions SHOULD set the telemetry.distro.name
attribute to a string starting with opentelemetry-
, e.g. opentelemetry-java-instrumentation
.
Attributes
- Source
- ResourceAttributes.scala
The version string of the auto instrumentation agent or distribution, if used.
The version string of the auto instrumentation agent or distribution, if used.
Attributes
- Source
- ResourceAttributes.scala
The language of the telemetry SDK.
The name of the telemetry SDK as defined above.
The name of the telemetry SDK as defined above.
Notes: - The OpenTelemetry SDK MUST set the telemetry.sdk.name
attribute to opentelemetry
. If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the telemetry.sdk.name
attribute to the fully-qualified class or module name of this SDK's main entry point or another suitable identifier depending on the language. The identifier opentelemetry
is reserved and MUST NOT be used in this case. All custom identifiers SHOULD be stable across different versions of an implementation.
Attributes
- Source
- ResourceAttributes.scala
The version string of the telemetry SDK.
Additional description of the web engine (e.g.
Additional description of the web engine (e.g. detailed version and edition information).
Attributes
- Source
- ResourceAttributes.scala
The name of the web engine.
The version of the web engine.
Deprecated fields
Full user-agent string provided by the browser
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.
Attributes
- Deprecated
-
This item has been renamed in 1.19.0 version of the semantic conventions. Use org.typelevel.otel4s.semconv.trace.attributes.SemanticAttributes.UserAgentOriginal instead.
- Source
- ResourceAttributes.scala
Container image tag.
Container image tag.
Attributes
- Deprecated
-
This item has been renamed in 1.22.0 of the semantic conventions. Use ResourceAttributes.ContainerImageTags instead.
- Source
- ResourceAttributes.scala
The unique ID of the single function that this runtime instance executes.
The unique ID of the single function that this runtime instance executes.
Notes:
- On some cloud providers, it may not be possible to determine the full ID at startup, so consider setting faas.id
as a span attribute instead. - The exact value to use for faas.id
depends on the cloud provider: - AWS Lambda: The function <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">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 <a href="https://cloud.google.com/iam/docs/full-resource-names">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.
Attributes
- Deprecated
-
This item has been removed in 1.19.0 version of the semantic conventions. Use ResourceAttributes.CloudResourceId instead.
- Source
- ResourceAttributes.scala
Red Hat OpenShift on Google Cloud.
Red Hat OpenShift on Google Cloud.
Attributes
- Deprecated
-
This item has been removed as of 1.18.0 of the semantic conventions. Use ResourceAttributes.CloudPlatform.GcpOpenshift instead.
- Source
- ResourceAttributes.scala
Deprecated, use the otel.scope.name
attribute.
Deprecated, use the otel.scope.name
attribute.
Attributes
- Deprecated
- true
- Source
- ResourceAttributes.scala
Deprecated, use the otel.scope.version
attribute.
Deprecated, use the otel.scope.version
attribute.
Attributes
- Deprecated
- true
- Source
- ResourceAttributes.scala
The version string of the auto instrumentation agent, if used.
The version string of the auto instrumentation agent, if used.
Attributes
- Deprecated
-
This item has been renamed in 1.22.0 of the semantic conventions. Use ResourceAttributes.TelemetryDistroVersion instead.
- Source
- ResourceAttributes.scala