diff --git a/script/semantic-conventions/semconv.sh b/script/semantic-conventions/semconv.sh index b85a87af7..b51029df2 100755 --- a/script/semantic-conventions/semconv.sh +++ b/script/semantic-conventions/semconv.sh @@ -12,7 +12,7 @@ SPEC_DIR="${ROOT_DIR}/var/semantic-conventions" CODE_DIR="${ROOT_DIR}/src/SemConv" # freeze the spec & generator tools versions to make SemanticAttributes generation reproducible -SEMCONV_VERSION=${SEMCONV_VERSION:=1.23.0} +SEMCONV_VERSION=${SEMCONV_VERSION:=1.23.1} SPEC_VERSION=v$SEMCONV_VERSION SCHEMA_URL=https://opentelemetry.io/schemas/$SEMCONV_VERSION GENERATOR_VERSION=0.23.0 diff --git a/script/semantic-conventions/templates/AttributeValues.php.j2 b/script/semantic-conventions/templates/AttributeValues.php.j2 index 0a02f2552..b6d493bcd 100644 --- a/script/semantic-conventions/templates/AttributeValues.php.j2 +++ b/script/semantic-conventions/templates/AttributeValues.php.j2 @@ -13,7 +13,7 @@ interface {{ class }}AttributeValues */ public const SCHEMA_URL = '{{schemaUrl}}'; -{%- for attribute in attributes | unique(attribute="fqn") %} +{%- for attribute in attributes | unique(attribute="fqn") | sort(attribute="fqn") %} {%- if attribute.attr_type.members %} {%- for member in attribute.attr_type.members %} {%- if member.brief %} diff --git a/script/semantic-conventions/templates/Attributes.php.j2 b/script/semantic-conventions/templates/Attributes.php.j2 index 67a45a7f1..de260b4ff 100644 --- a/script/semantic-conventions/templates/Attributes.php.j2 +++ b/script/semantic-conventions/templates/Attributes.php.j2 @@ -12,7 +12,7 @@ interface {{ class }}Attributes * The URL of the OpenTelemetry schema for these keys and values. */ public const SCHEMA_URL = '{{schemaUrl}}'; -{% for attribute in attributes | unique(attribute="fqn") %} +{% for attribute in attributes | unique(attribute="fqn") | sort(attribute="fqn") %} /** * {{ attribute.brief | render_markdown(code="`{0}`", paragraph="{0}", link="{1}") | to_doc_brief | regex_replace(pattern="\n", replace="\n * ") }}. {%- if attribute.note %} diff --git a/src/SemConv/ResourceAttributes.php b/src/SemConv/ResourceAttributes.php index f67c78a00..451ee54e5 100644 --- a/src/SemConv/ResourceAttributes.php +++ b/src/SemConv/ResourceAttributes.php @@ -11,7 +11,7 @@ interface ResourceAttributes /** * The URL of the OpenTelemetry schema for these keys and values. */ - public const SCHEMA_URL = 'https://opentelemetry.io/schemas/1.23.0'; + public const SCHEMA_URL = 'https://opentelemetry.io/schemas/1.23.1'; /** * Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found here. @@ -21,121 +21,6 @@ interface ResourceAttributes */ public const ANDROID_OS_API_LEVEL = 'android.os.api_level'; - /** - * Array of brand name and version separated by a space. - * - * This value is intended to be taken from the UA client hints API (`navigator.userAgentData.brands`). - * - * @example Not A;Brand 99 - * @example Chromium 99 - * @example Chrome 99 - */ - public const BROWSER_BRANDS = 'browser.brands'; - - /** - * Preferred language of the user using the browser. - * - * This value is intended to be taken from the Navigator API `navigator.language`. - * - * @example en - * @example en-US - * @example fr - * @example fr-FR - */ - public const BROWSER_LANGUAGE = 'browser.language'; - - /** - * A boolean that is true if the browser is running on a mobile device. - * - * This value is intended to be taken from the UA client hints API (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset. - */ - public const BROWSER_MOBILE = 'browser.mobile'; - - /** - * The platform on which the browser is running. - * - * This value is intended to be taken from the 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. - * - * @example Windows - * @example macOS - * @example Android - */ - public const BROWSER_PLATFORM = 'browser.platform'; - - /** - * Full user-agent string provided by the browser. - * - * 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. - * - * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36 - */ - public const USER_AGENT_ORIGINAL = 'user_agent.original'; - - /** - * The cloud account ID the resource is assigned to. - * - * @example 111111111111 - * @example opentelemetry - */ - public const CLOUD_ACCOUNT_ID = 'cloud.account.id'; - - /** - * Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. - * - * Availability zones are called "zones" on Alibaba Cloud and Google Cloud. - * - * @example us-east-1c - */ - public const CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone'; - - /** - * The cloud platform in use. - * - * The prefix of the service SHOULD match the one specified in `cloud.provider`. - */ - public const CLOUD_PLATFORM = 'cloud.platform'; - - /** - * Name of the cloud provider. - */ - public const CLOUD_PROVIDER = 'cloud.provider'; - - /** - * The geographical region the resource is running. - * - * 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. - * - * @example us-central1 - * @example us-east-1 - */ - public const CLOUD_REGION = 'cloud.region'; - - /** - * 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). - * - * 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: - * - * @example arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function - * @example //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID - * @example /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ - */ - public const CLOUD_RESOURCE_ID = 'cloud.resource_id'; - /** * The ARN of an ECS cluster. * @@ -220,56 +105,110 @@ interface ResourceAttributes public const AWS_LOG_STREAM_NAMES = 'aws.log.stream.names'; /** - * The name of the Cloud Run execution being run for the Job, as set by the `CLOUD_RUN_EXECUTION` environment variable. + * Array of brand name and version separated by a space. * - * @example job-name-xxxx - * @example sample-job-mdw84 + * This value is intended to be taken from the UA client hints API (`navigator.userAgentData.brands`). + * + * @example Not A;Brand 99 + * @example Chromium 99 + * @example Chrome 99 */ - public const GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution'; + public const BROWSER_BRANDS = 'browser.brands'; /** - * The index for a task within an execution as provided by the `CLOUD_RUN_TASK_INDEX` environment variable. + * Preferred language of the user using the browser. * - * @example 1 + * This value is intended to be taken from the Navigator API `navigator.language`. + * + * @example en + * @example en-US + * @example fr + * @example fr-FR */ - public const GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index'; + public const BROWSER_LANGUAGE = 'browser.language'; /** - * The hostname of a GCE instance. This is the full value of the default or custom hostname. + * A boolean that is true if the browser is running on a mobile device. * - * @example my-host1234.example.com - * @example sample-vm.us-west1-b.c.my-project.internal + * This value is intended to be taken from the UA client hints API (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset. */ - public const GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname'; + public const BROWSER_MOBILE = 'browser.mobile'; /** - * 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 default internal DNS name. + * The platform on which the browser is running. * - * @example instance-1 - * @example my-vm-name + * This value is intended to be taken from the 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. + * + * @example Windows + * @example macOS + * @example Android */ - public const GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name'; + public const BROWSER_PLATFORM = 'browser.platform'; /** - * Unique identifier for the application. + * The cloud account ID the resource is assigned to. * - * @example 2daa2797-e42b-4624-9322-ec3f968df4da + * @example 111111111111 + * @example opentelemetry */ - public const HEROKU_APP_ID = 'heroku.app.id'; + public const CLOUD_ACCOUNT_ID = 'cloud.account.id'; /** - * Commit hash for the current release. + * Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. * - * @example e6134959463efd8966b20e75b913cafe3f5ec + * Availability zones are called "zones" on Alibaba Cloud and Google Cloud. + * + * @example us-east-1c */ - public const HEROKU_RELEASE_COMMIT = 'heroku.release.commit'; + public const CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone'; /** - * Time and date the release was created. + * The cloud platform in use. * - * @example 2022-10-23T18:00:42Z + * The prefix of the service SHOULD match the one specified in `cloud.provider`. */ - public const HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp'; + public const CLOUD_PLATFORM = 'cloud.platform'; + + /** + * Name of the cloud provider. + */ + public const CLOUD_PROVIDER = 'cloud.provider'; + + /** + * The geographical region the resource is running. + * + * 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. + * + * @example us-central1 + * @example us-east-1 + */ + public const CLOUD_REGION = 'cloud.region'; + + /** + * 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). + * + * 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 + * 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//resourceGroups//providers/Microsoft.Web/sites//functions/`. + * This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share + * a TracerProvider.
    • + *
+ * + * @example arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function + * @example //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID + * @example /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ + */ + public const CLOUD_RESOURCE_ID = 'cloud.resource_id'; /** * The command used to run the container (i.e. the command name). @@ -353,16 +292,6 @@ interface ResourceAttributes */ public const CONTAINER_RUNTIME = 'container.runtime'; - /** - * The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. - * - * Follows OCI Image Manifest Specification, and specifically the Digest property. - * An example can be found in Example Image Manifest. - * - * @example sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 - */ - public const OCI_MANIFEST_DIGEST = 'oci.manifest.digest'; - /** * Name of the deployment environment (aka deployment tier). * @@ -472,72 +401,61 @@ interface ResourceAttributes public const FAAS_VERSION = 'faas.version'; /** - * The CPU architecture the host system is running on. - */ - public const HOST_ARCH = 'host.arch'; - - /** - * 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. + * The name of the Cloud Run execution being run for the Job, as set by the `CLOUD_RUN_EXECUTION` environment variable. * - * @example fdbf79e8af94cb7f9e8df36789187052 + * @example job-name-xxxx + * @example sample-job-mdw84 */ - public const HOST_ID = 'host.id'; + public const GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution'; /** - * VM image ID or host OS image ID. For Cloud, this value is from the provider. + * The index for a task within an execution as provided by the `CLOUD_RUN_TASK_INDEX` environment variable. * - * @example ami-07b06b442921831e5 + * @example 1 */ - public const HOST_IMAGE_ID = 'host.image.id'; + public const GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index'; /** - * Name of the VM image or OS install the host was instantiated from. + * The hostname of a GCE instance. This is the full value of the default or custom hostname. * - * @example infra-ami-eks-worker-node-7d4ec78312 - * @example CentOS-8-x86_64-1905 + * @example my-host1234.example.com + * @example sample-vm.us-west1-b.c.my-project.internal */ - public const HOST_IMAGE_NAME = 'host.image.name'; + public const GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname'; /** - * The version string of the VM image or host OS as defined in Version Attributes. + * 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 default internal DNS name. * - * @example 0.1 + * @example instance-1 + * @example my-vm-name */ - public const HOST_IMAGE_VERSION = 'host.image.version'; + public const GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name'; /** - * Available IP addresses of the host, excluding loopback interfaces. - * - * IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format. + * Unique identifier for the application. * - * @example 192.168.1.140 - * @example fe80::abc2:4a28:737a:609e + * @example 2daa2797-e42b-4624-9322-ec3f968df4da */ - public const HOST_IP = 'host.ip'; + public const HEROKU_APP_ID = 'heroku.app.id'; /** - * Available MAC addresses of the host, excluding loopback interfaces. - * - * MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant. + * Commit hash for the current release. * - * @example AC-DE-48-23-45-67 - * @example AC-DE-48-23-45-67-01-9F + * @example e6134959463efd8966b20e75b913cafe3f5ec */ - public const HOST_MAC = 'host.mac'; + public const HEROKU_RELEASE_COMMIT = 'heroku.release.commit'; /** - * 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. + * Time and date the release was created. * - * @example opentelemetry-test + * @example 2022-10-23T18:00:42Z */ - public const HOST_NAME = 'host.name'; + public const HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp'; /** - * Type of host. For Cloud, this must be the machine type. - * - * @example n1-standard-1 + * The CPU architecture the host system is running on. */ - public const HOST_TYPE = 'host.type'; + public const HOST_ARCH = 'host.arch'; /** * The amount of level 2 memory cache available to the processor (in Bytes). @@ -556,32 +474,95 @@ interface ResourceAttributes /** * Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. * - * @example 6 + * @example 6 + */ + public const HOST_CPU_MODEL_ID = 'host.cpu.model.id'; + + /** + * Model designation of the processor. + * + * @example 11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz + */ + public const HOST_CPU_MODEL_NAME = 'host.cpu.model.name'; + + /** + * Stepping or core revisions. + * + * @example 1 + */ + public const HOST_CPU_STEPPING = 'host.cpu.stepping'; + + /** + * Processor manufacturer identifier. A maximum 12-character string. + * + * 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. + * + * @example GenuineIntel + */ + public const HOST_CPU_VENDOR_ID = 'host.cpu.vendor.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. + * + * @example fdbf79e8af94cb7f9e8df36789187052 + */ + public const HOST_ID = 'host.id'; + + /** + * VM image ID or host OS image ID. For Cloud, this value is from the provider. + * + * @example ami-07b06b442921831e5 + */ + public const HOST_IMAGE_ID = 'host.image.id'; + + /** + * Name of the VM image or OS install the host was instantiated from. + * + * @example infra-ami-eks-worker-node-7d4ec78312 + * @example CentOS-8-x86_64-1905 + */ + public const HOST_IMAGE_NAME = 'host.image.name'; + + /** + * The version string of the VM image or host OS as defined in Version Attributes. + * + * @example 0.1 + */ + public const HOST_IMAGE_VERSION = 'host.image.version'; + + /** + * Available IP addresses of the host, excluding loopback interfaces. + * + * IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format. + * + * @example 192.168.1.140 + * @example fe80::abc2:4a28:737a:609e */ - public const HOST_CPU_MODEL_ID = 'host.cpu.model.id'; + public const HOST_IP = 'host.ip'; /** - * Model designation of the processor. + * Available MAC addresses of the host, excluding loopback interfaces. * - * @example 11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz + * MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant. + * + * @example AC-DE-48-23-45-67 + * @example AC-DE-48-23-45-67-01-9F */ - public const HOST_CPU_MODEL_NAME = 'host.cpu.model.name'; + public const HOST_MAC = 'host.mac'; /** - * Stepping or core revisions. + * 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. * - * @example 1 + * @example opentelemetry-test */ - public const HOST_CPU_STEPPING = 'host.cpu.stepping'; + public const HOST_NAME = 'host.name'; /** - * Processor manufacturer identifier. A maximum 12-character string. - * - * 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. + * Type of host. For Cloud, this must be the machine type. * - * @example GenuineIntel + * @example n1-standard-1 */ - public const HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id'; + public const HOST_TYPE = 'host.type'; /** * The name of the cluster. @@ -616,137 +597,147 @@ interface ResourceAttributes public const K8S_CLUSTER_UID = 'k8s.cluster.uid'; /** - * The name of the Node. - * - * @example node-1 - */ - public const K8S_NODE_NAME = 'k8s.node.name'; - - /** - * The UID of the Node. + * The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). * - * @example 1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2 + * @example redis */ - public const K8S_NODE_UID = 'k8s.node.uid'; + public const K8S_CONTAINER_NAME = 'k8s.container.name'; /** - * The name of the namespace that the pod is running in. + * Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. * - * @example default + * @example 2 */ - public const K8S_NAMESPACE_NAME = 'k8s.namespace.name'; + public const K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count'; /** - * The name of the Pod. + * The name of the CronJob. * - * @example opentelemetry-pod-autoconf + * @example opentelemetry */ - public const K8S_POD_NAME = 'k8s.pod.name'; + public const K8S_CRONJOB_NAME = 'k8s.cronjob.name'; /** - * The UID of the Pod. + * The UID of the CronJob. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_POD_UID = 'k8s.pod.uid'; + public const K8S_CRONJOB_UID = 'k8s.cronjob.uid'; /** - * The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). + * The name of the DaemonSet. * - * @example redis + * @example opentelemetry */ - public const K8S_CONTAINER_NAME = 'k8s.container.name'; + public const K8S_DAEMONSET_NAME = 'k8s.daemonset.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 DaemonSet. * - * @example 2 + * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count'; + public const K8S_DAEMONSET_UID = 'k8s.daemonset.uid'; /** - * The name of the ReplicaSet. + * The name of the Deployment. * * @example opentelemetry */ - public const K8S_REPLICASET_NAME = 'k8s.replicaset.name'; + public const K8S_DEPLOYMENT_NAME = 'k8s.deployment.name'; /** - * The UID of the ReplicaSet. + * The UID of the Deployment. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_REPLICASET_UID = 'k8s.replicaset.uid'; + public const K8S_DEPLOYMENT_UID = 'k8s.deployment.uid'; /** - * The name of the Deployment. + * The name of the Job. * * @example opentelemetry */ - public const K8S_DEPLOYMENT_NAME = 'k8s.deployment.name'; + public const K8S_JOB_NAME = 'k8s.job.name'; /** - * The UID of the Deployment. + * The UID of the Job. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_DEPLOYMENT_UID = 'k8s.deployment.uid'; + public const K8S_JOB_UID = 'k8s.job.uid'; /** - * The name of the StatefulSet. + * The name of the namespace that the pod is running in. * - * @example opentelemetry + * @example default */ - public const K8S_STATEFULSET_NAME = 'k8s.statefulset.name'; + public const K8S_NAMESPACE_NAME = 'k8s.namespace.name'; /** - * The UID of the StatefulSet. + * The name of the Node. * - * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + * @example node-1 */ - public const K8S_STATEFULSET_UID = 'k8s.statefulset.uid'; + public const K8S_NODE_NAME = 'k8s.node.name'; /** - * The name of the DaemonSet. + * The UID of the Node. * - * @example opentelemetry + * @example 1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2 */ - public const K8S_DAEMONSET_NAME = 'k8s.daemonset.name'; + public const K8S_NODE_UID = 'k8s.node.uid'; /** - * The UID of the DaemonSet. + * The name of the Pod. + * + * @example opentelemetry-pod-autoconf + */ + public const K8S_POD_NAME = 'k8s.pod.name'; + + /** + * The UID of the Pod. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_DAEMONSET_UID = 'k8s.daemonset.uid'; + public const K8S_POD_UID = 'k8s.pod.uid'; /** - * The name of the Job. + * The name of the ReplicaSet. * * @example opentelemetry */ - public const K8S_JOB_NAME = 'k8s.job.name'; + public const K8S_REPLICASET_NAME = 'k8s.replicaset.name'; /** - * The UID of the Job. + * The UID of the ReplicaSet. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_JOB_UID = 'k8s.job.uid'; + public const K8S_REPLICASET_UID = 'k8s.replicaset.uid'; /** - * The name of the CronJob. + * The name of the StatefulSet. * * @example opentelemetry */ - public const K8S_CRONJOB_NAME = 'k8s.cronjob.name'; + public const K8S_STATEFULSET_NAME = 'k8s.statefulset.name'; /** - * The UID of the CronJob. + * The UID of the StatefulSet. * * @example 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff */ - public const K8S_CRONJOB_UID = 'k8s.cronjob.uid'; + public const K8S_STATEFULSET_UID = 'k8s.statefulset.uid'; + + /** + * The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. + * + * Follows OCI Image Manifest Specification, and specifically the Digest property. + * An example can be found in Example Image Manifest. + * + * @example sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 + */ + public const OCI_MANIFEST_DIGEST = 'oci.manifest.digest'; /** * Unique identifier for a particular build or compilation of the operating system. @@ -787,6 +778,36 @@ interface ResourceAttributes */ public const OS_VERSION = 'os.version'; + /** + * Deprecated, use the `otel.scope.name` attribute. + * + * @deprecated Deprecated, use the `otel.scope.name` attribute.. + * @example io.opentelemetry.contrib.mongodb + */ + public const OTEL_LIBRARY_NAME = 'otel.library.name'; + + /** + * Deprecated, use the `otel.scope.version` attribute. + * + * @deprecated Deprecated, use the `otel.scope.version` attribute.. + * @example 1.0.0 + */ + public const OTEL_LIBRARY_VERSION = 'otel.library.version'; + + /** + * The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). + * + * @example io.opentelemetry.contrib.mongodb + */ + public const OTEL_SCOPE_NAME = 'otel.scope.name'; + + /** + * The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). + * + * @example 1.0.0 + */ + public const OTEL_SCOPE_VERSION = 'otel.scope.version'; + /** * 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`. * @@ -865,6 +886,16 @@ interface ResourceAttributes */ public const PROCESS_RUNTIME_VERSION = 'process.runtime.version'; + /** + * The string ID of the service instance. + * + * 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). + * + * @example my-k8s-pod-deployment-1 + * @example 627cc493-f310-47de-96bd-71410b7dec09 + */ + public const SERVICE_INSTANCE_ID = 'service.instance.id'; + /** * Logical name of the service. * @@ -874,6 +905,15 @@ interface ResourceAttributes */ public const SERVICE_NAME = 'service.name'; + /** + * A namespace for `service.name`. + * + * 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. + * + * @example Shop + */ + public const SERVICE_NAMESPACE = 'service.namespace'; + /** * The version string of the service API or implementation. The format is not defined by these conventions. * @@ -883,23 +923,21 @@ interface ResourceAttributes public const SERVICE_VERSION = 'service.version'; /** - * The string ID of the service instance. + * The name of the auto instrumentation agent or distribution, if used. * - * 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). + * Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to + * a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. * - * @example my-k8s-pod-deployment-1 - * @example 627cc493-f310-47de-96bd-71410b7dec09 + * @example parts-unlimited-java */ - public const SERVICE_INSTANCE_ID = 'service.instance.id'; + public const TELEMETRY_DISTRO_NAME = 'telemetry.distro.name'; /** - * A namespace for `service.name`. - * - * 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 version string of the auto instrumentation agent or distribution, if used. * - * @example Shop + * @example 1.2.3 */ - public const SERVICE_NAMESPACE = 'service.namespace'; + public const TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version'; /** * The language of the telemetry SDK. @@ -928,21 +966,13 @@ interface ResourceAttributes public const TELEMETRY_SDK_VERSION = 'telemetry.sdk.version'; /** - * The name of the auto instrumentation agent or distribution, if used. - * - * Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to - * a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. + * Full user-agent string provided by the browser. * - * @example parts-unlimited-java - */ - public const TELEMETRY_DISTRO_NAME = 'telemetry.distro.name'; - - /** - * The version string of the auto instrumentation agent or distribution, if 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 `navigator.userAgent` API can be used. * - * @example 1.2.3 + * @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36 */ - public const TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version'; + public const USER_AGENT_ORIGINAL = 'user_agent.original'; /** * Additional description of the web engine (e.g. detailed version and edition information). @@ -965,36 +995,6 @@ interface ResourceAttributes */ public const WEBENGINE_VERSION = 'webengine.version'; - /** - * The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). - * - * @example io.opentelemetry.contrib.mongodb - */ - public const OTEL_SCOPE_NAME = 'otel.scope.name'; - - /** - * The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). - * - * @example 1.0.0 - */ - public const OTEL_SCOPE_VERSION = 'otel.scope.version'; - - /** - * Deprecated, use the `otel.scope.name` attribute. - * - * @deprecated Deprecated, use the `otel.scope.name` attribute.. - * @example io.opentelemetry.contrib.mongodb - */ - public const OTEL_LIBRARY_NAME = 'otel.library.name'; - - /** - * Deprecated, use the `otel.scope.version` attribute. - * - * @deprecated Deprecated, use the `otel.scope.version` attribute.. - * @example 1.0.0 - */ - public const OTEL_LIBRARY_VERSION = 'otel.library.version'; - /** * @deprecated Use USER_AGENT_ORIGINAL */ diff --git a/src/SemConv/TraceAttributes.php b/src/SemConv/TraceAttributes.php index 9652cac39..e7810c8cd 100644 --- a/src/SemConv/TraceAttributes.php +++ b/src/SemConv/TraceAttributes.php @@ -11,817 +11,932 @@ interface TraceAttributes /** * The URL of the OpenTelemetry schema for these keys and values. */ - public const SCHEMA_URL = 'https://opentelemetry.io/schemas/1.23.0'; + public const SCHEMA_URL = 'https://opentelemetry.io/schemas/1.23.1'; /** - * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. - * - * When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. + * This attribute represents the state the application has transitioned into at the occurrence of the event. * - * @example client.example.com - * @example 10.1.2.80 - * @example /tmp/my.sock + * The Android lifecycle states are defined in Activity lifecycle callbacks, and from which the `OS identifiers` are derived. */ - public const CLIENT_ADDRESS = 'client.address'; + public const ANDROID_STATE = 'android.state'; /** - * Client port number. - * - * When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. + * The JSON-serialized value of each item in the `AttributeDefinitions` request field. * - * @example 65123 + * @example { "AttributeName": "string", "AttributeType": "string" } */ - public const CLIENT_PORT = 'client.port'; + public const AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions'; /** - * Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. - * - * When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available. + * The value of the `AttributesToGet` request parameter. * - * @example destination.example.com - * @example 10.1.2.80 - * @example /tmp/my.sock + * @example lives + * @example id */ - public const DESTINATION_ADDRESS = 'destination.address'; + public const AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get'; /** - * Destination port number. - * - * @example 3389 - * @example 2888 + * The value of the `ConsistentRead` request parameter. */ - public const DESTINATION_PORT = 'destination.port'; + public const AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read'; /** - * Describes a class of error the operation ended with. - * - * The `error.type` SHOULD be predictable and SHOULD have low cardinality. - * Instrumentations SHOULD document the list of errors they report.The cardinality of `error.type` within one instrumentation library SHOULD be low. - * Telemetry consumers that aggregate data from multiple instrumentation libraries and applications - * should be prepared for `error.type` to have high cardinality at query time when no - * additional filters are applied.If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), - * it's RECOMMENDED to:
    - *
  • Use a domain-specific attribute
    • - *
  • Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
    • - *
+ * The JSON-serialized value of each item in the `ConsumedCapacity` response field. * - * @example timeout - * @example java.net.UnknownHostException - * @example server_certificate_invalid - * @example 500 + * @example { "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "LocalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "ReadCapacityUnits": number, "Table": { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableName": "string", "WriteCapacityUnits": number } */ - public const ERROR_TYPE = 'error.type'; + public const AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity'; /** - * The exception message. + * The value of the `Count` response parameter. * - * @example Division by zero - * @example Can't convert 'int' object to str implicitly + * @example 10 */ - public const EXCEPTION_MESSAGE = 'exception.message'; + public const AWS_DYNAMODB_COUNT = 'aws.dynamodb.count'; /** - * A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. + * The value of the `ExclusiveStartTableName` request parameter. * - * @example Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5) + * @example Users + * @example CatsTable */ - public const EXCEPTION_STACKTRACE = 'exception.stacktrace'; + public const AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table'; /** - * The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. + * The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field. * - * @example java.net.ConnectException - * @example OSError + * @example { "Create": { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } */ - public const EXCEPTION_TYPE = 'exception.type'; + public const AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates'; /** - * The name of the invoked function. - * - * SHOULD be equal to the `faas.name` resource attribute of the invoked function. + * The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field. * - * @example my-function + * @example { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } */ - public const FAAS_INVOKED_NAME = 'faas.invoked_name'; + public const AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes'; /** - * The cloud provider of the invoked function. + * The value of the `IndexName` request parameter. * - * SHOULD be equal to the `cloud.provider` resource attribute of the invoked function. + * @example name_to_group */ - public const FAAS_INVOKED_PROVIDER = 'faas.invoked_provider'; + public const AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name'; /** - * The cloud region of the invoked function. - * - * SHOULD be equal to the `cloud.region` resource attribute of the invoked function. + * The JSON-serialized value of the `ItemCollectionMetrics` response field. * - * @example eu-central-1 - */ - public const FAAS_INVOKED_REGION = 'faas.invoked_region'; - - /** - * Type of the trigger which caused this function invocation. + * @example { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] } */ - public const FAAS_TRIGGER = 'faas.trigger'; + public const AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics'; /** - * The `service.name` of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. + * The value of the `Limit` request parameter. * - * @example AuthTokenCache + * @example 10 */ - public const PEER_SERVICE = 'peer.service'; + public const AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit'; /** - * Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system. + * The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. * - * @example username + * @example { "IndexArn": "string", "IndexName": "string", "IndexSizeBytes": number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } } */ - public const ENDUSER_ID = 'enduser.id'; + public const AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes'; /** - * Actual/assumed role the client is making the request under extracted from token or application security context. + * The value of the `ProjectionExpression` request parameter. * - * @example admin + * @example Title + * @example Title, Price, Color + * @example Title, Description, RelatedItems, ProductReviews */ - public const ENDUSER_ROLE = 'enduser.role'; + public const AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection'; /** - * Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an OAuth 2.0 Access Token or an attribute value in a SAML 2.0 Assertion. + * The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. * - * @example read:message, write:files + * @example 1.0 + * @example 2.0 */ - public const ENDUSER_SCOPE = 'enduser.scope'; + public const AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity'; /** - * Current "managed" thread ID (as opposed to OS thread ID). + * The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. * - * @example 42 + * @example 1.0 + * @example 2.0 */ - public const THREAD_ID = 'thread.id'; + public const AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity'; /** - * Current thread name. - * - * @example main + * The value of the `ScanIndexForward` request parameter. */ - public const THREAD_NAME = 'thread.name'; + public const AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward'; /** - * The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. + * The value of the `ScannedCount` response parameter. * - * @example 16 + * @example 50 */ - public const CODE_COLUMN = 'code.column'; + public const AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count'; /** - * The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). + * The value of the `Segment` request parameter. * - * @example /usr/local/MyApplication/content_root/app/index.php + * @example 10 */ - public const CODE_FILEPATH = 'code.filepath'; + public const AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment'; /** - * The method or function name, or equivalent (usually rightmost part of the code unit's name). + * The value of the `Select` request parameter. * - * @example serveRequest + * @example ALL_ATTRIBUTES + * @example COUNT */ - public const CODE_FUNCTION = 'code.function'; + public const AWS_DYNAMODB_SELECT = 'aws.dynamodb.select'; /** - * The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. + * The the number of items in the `TableNames` response parameter. * - * @example 42 + * @example 20 */ - public const CODE_LINENO = 'code.lineno'; + public const AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count'; /** - * The "namespace" within which `code.function` is defined. Usually the qualified class or module name, such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit. + * The keys in the `RequestItems` object field. * - * @example com.example.MyHttpService + * @example Users + * @example Cats */ - public const CODE_NAMESPACE = 'code.namespace'; + public const AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names'; /** - * HTTP request method. - * - * HTTP request method value SHOULD be "known" to the instrumentation. - * By default, this convention defines "known" methods as the ones listed in RFC9110 - * and the PATCH method defined in RFC5789.If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override - * the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named - * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods - * (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. - * Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - * Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. + * The value of the `TotalSegments` request parameter. * - * @example GET - * @example POST - * @example HEAD + * @example 100 */ - public const HTTP_REQUEST_METHOD = 'http.request.method'; + public const AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments'; /** - * HTTP response status code. + * The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable). * - * @example 200 + * This may be different from `cloud.resource_id` if an alias is involved. + * + * @example arn:aws:lambda:us-east-1:123456:function:myfunction:myalias */ - public const HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code'; + public const AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn'; /** - * OSI application layer or non-OSI equivalent. - * - * The value SHOULD be normalized to lowercase. + * The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. * - * @example http - * @example spdy + * @example 79b9da39-b7ae-508a-a6bc-864b2829c622 + * @example C9ER4AJX75574TDJ */ - public const NETWORK_PROTOCOL_NAME = 'network.protocol.name'; + public const AWS_REQUEST_ID = 'aws.request_id'; /** - * Version of the protocol specified in `network.protocol.name`. + * The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the S3 API operations. * - * `network.protocol.version` refers to the version of the protocol used and might be different from the protocol client's version. If the HTTP client has a version of `0.27.2`, but sends HTTP version `1.1`, this attribute should be set to `1.1`. + * The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. + * This applies to almost all S3 operations except `list-buckets`. * - * @example 1.0 - * @example 1.1 - * @example 2 - * @example 3 + * @example some-bucket-name */ - public const NETWORK_PROTOCOL_VERSION = 'network.protocol.version'; + public const AWS_S3_BUCKET = 'aws.s3.bucket'; /** - * Host identifier of the "URI origin" HTTP request is sent to. + * The source object (in the form `bucket`/`key`) for the copy operation. * - * If an HTTP client request is explicitly made to an IP address, e.g. `http://x.x.x.x:8080`, then `server.address` SHOULD be the IP address `x.x.x.x`. A DNS lookup SHOULD NOT be used. + * The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter + * of the copy-object operation within the S3 API. + * This applies in particular to the following operations:
    + *
  • copy-object
    • + *
  • upload-part-copy
    • + *
* - * @example example.com - * @example 10.1.2.80 - * @example /tmp/my.sock + * @example someFile.yml */ - public const SERVER_ADDRESS = 'server.address'; + public const AWS_S3_COPY_SOURCE = 'aws.s3.copy_source'; /** - * Port identifier of the "URI origin" HTTP request is sent to. + * The delete request container that specifies the objects to be deleted. * - * When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. + * The `delete` attribute is only applicable to the delete-object operation. + * The `delete` attribute corresponds to the `--delete` parameter of the + * delete-objects operation within the S3 API. * - * @example 80 - * @example 8080 - * @example 443 + * @example Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean */ - public const SERVER_PORT = 'server.port'; + public const AWS_S3_DELETE = 'aws.s3.delete'; /** - * The URI scheme component identifying the used protocol. + * The S3 object key the request refers to. Corresponds to the `--key` parameter of the S3 API operations. * - * @example http - * @example https - */ - public const URL_SCHEME = 'url.scheme'; - + * The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. + * This applies in particular to the following operations:
    + *
  • copy-object
    • + *
  • delete-object
    • + *
  • get-object
    • + *
  • head-object
    • + *
  • put-object
    • + *
  • restore-object
    • + *
  • select-object-content
    • + *
  • abort-multipart-upload
    • + *
  • complete-multipart-upload
    • + *
  • create-multipart-upload
    • + *
  • list-parts
    • + *
  • upload-part
    • + *
  • upload-part-copy
    • + *
+ * + * @example someFile.yml + */ + public const AWS_S3_KEY = 'aws.s3.key'; + /** - * The matched route, that is, the path template in the format used by the respective server framework. + * The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. * - * MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. - * SHOULD include the application root if there is one. + * The `part_number` attribute is only applicable to the upload-part + * and upload-part-copy operations. + * The `part_number` attribute corresponds to the `--part-number` parameter of the + * upload-part operation within the S3 API. * - * @example /users/:userID? - * @example {controller}/{action}/{id?} + * @example 3456 */ - public const HTTP_ROUTE = 'http.route'; + public const AWS_S3_PART_NUMBER = 'aws.s3.part_number'; /** - * The domain identifies the business context for the events. + * Upload ID that identifies the multipart upload. * - * Events across different domains may have same `event.name`, yet be unrelated events. + * The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter + * of the S3 API multipart operations. + * This applies in particular to the following operations:
    + *
  • abort-multipart-upload
    • + *
  • complete-multipart-upload
    • + *
  • list-parts
    • + *
  • upload-part
    • + *
  • upload-part-copy
    • + *
+ * + * @example dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ */ - public const EVENT_DOMAIN = 'event.domain'; + public const AWS_S3_UPLOAD_ID = 'aws.s3.upload_id'; /** - * The name identifies the event. + * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. * - * @example click - * @example exception + * When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. + * + * @example client.example.com + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const EVENT_NAME = 'event.name'; + public const CLIENT_ADDRESS = 'client.address'; /** - * A unique identifier for the Log Record. + * Client port number. * - * If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. - * The id MAY be an Universally Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used as needed. + * When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. * - * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV + * @example 65123 */ - public const LOG_RECORD_UID = 'log.record.uid'; + public const CLIENT_PORT = 'client.port'; /** - * The unique identifier of the feature flag. + * 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). * - * @example logo-color + * 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 + * 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//resourceGroups//providers/Microsoft.Web/sites//functions/`. + * This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share + * a TracerProvider.
    • + *
+ * + * @example arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function + * @example //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID + * @example /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ */ - public const FEATURE_FLAG_KEY = 'feature_flag.key'; + public const CLOUD_RESOURCE_ID = 'cloud.resource_id'; /** - * The name of the service provider that performs the flag evaluation. + * The event_id uniquely identifies the event. * - * @example Flag Manager + * @example 123e4567-e89b-12d3-a456-426614174000 + * @example 0001 */ - public const FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name'; + public const CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id'; /** - * SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. + * The source identifies the context in which an event happened. * - * A semantic identifier, commonly referred to as a variant, provides a means - * for referring to a value without including the value itself. This can - * provide additional context for understanding the meaning behind a value. - * For example, the variant `red` maybe be used for the value `#c05543`.A stringified version of the value can be used in situations where a - * semantic identifier is unavailable. String representation of the value - * should be determined by the implementer. + * @example https://github.com/cloudevents + * @example /cloudevents/spec/pull/123 + * @example my-service + */ + public const CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source'; + + /** + * The version of the CloudEvents specification which the event uses. * - * @example red - * @example true - * @example on + * @example 1.0 */ - public const FEATURE_FLAG_VARIANT = 'feature_flag.variant'; + public const CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version'; /** - * The stream associated with the log. See below for a list of well-known values. + * The subject of the event in the context of the event producer (identified by source). + * + * @example mynewfile.jpg */ - public const LOG_IOSTREAM = 'log.iostream'; + public const CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject'; /** - * The basename of the file. + * The event_type contains a value describing the type of event related to the originating occurrence. * - * @example audit.log + * @example com.github.pull_request.opened + * @example com.example.object.deleted.v2 */ - public const LOG_FILE_NAME = 'log.file.name'; + public const CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type'; /** - * The basename of the file, with symlinks resolved. + * The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. * - * @example uuid.log + * @example 16 */ - public const LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved'; + public const CODE_COLUMN = 'code.column'; /** - * The full path to the file. + * The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). * - * @example /var/log/mysql/audit.log + * @example /usr/local/MyApplication/content_root/app/index.php */ - public const LOG_FILE_PATH = 'log.file.path'; + public const CODE_FILEPATH = 'code.filepath'; /** - * The full path to the file, with symlinks resolved. + * The method or function name, or equivalent (usually rightmost part of the code unit's name). * - * @example /var/lib/docker/uuid.log + * @example serveRequest */ - public const LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved'; + public const CODE_FUNCTION = 'code.function'; /** - * This attribute represents the state the application has transitioned into at the occurrence of the event. + * The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. * - * The iOS lifecycle states are defined in the UIApplicationDelegate documentation, and from which the `OS terminology` column values are derived. + * @example 42 */ - public const IOS_STATE = 'ios.state'; + public const CODE_LINENO = 'code.lineno'; /** - * This attribute represents the state the application has transitioned into at the occurrence of the event. + * The "namespace" within which `code.function` is defined. Usually the qualified class or module name, such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit. * - * The Android lifecycle states are defined in Activity lifecycle callbacks, and from which the `OS identifiers` are derived. + * @example com.example.MyHttpService */ - public const ANDROID_STATE = 'android.state'; + public const CODE_NAMESPACE = 'code.namespace'; /** - * The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the db.connection_string should be used. + * The consistency level of the query. Based on consistency values from CQL. + */ + public const DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level'; + + /** + * The data center of the coordinating node for a query. * - * @example myDataSource + * @example us-west-2 */ - public const POOL_NAME = 'pool.name'; + public const DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc'; /** - * The state of a connection in the pool. + * The ID of the coordinating node for a query. * - * @example idle + * @example be13faa2-8574-4d71-926d-27f16cf8a7af */ - public const STATE = 'state'; + public const DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id'; /** - * Name of the buffer pool. + * Whether or not the query is idempotent. + */ + public const DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence'; + + /** + * The fetch size used for paging, i.e. how many rows will be returned at once. * - * Pool names are generally obtained via BufferPoolMXBean#getName(). + * @example 5000 + */ + public const DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size'; + + /** + * The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. * - * @example mapped - * @example direct + * @example 2 + */ + public const DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count'; + + /** + * The name of the primary table that the operation is acting upon, including the keyspace name (if applicable). + * + * This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set. + * + * @example mytable + */ + public const DB_CASSANDRA_TABLE = 'db.cassandra.table'; + + /** + * The connection string used to connect to the database. It is recommended to remove embedded credentials. + * + * @example Server=(localdb)\v11.0;Integrated Security=true; + */ + public const DB_CONNECTION_STRING = 'db.connection_string'; + + /** + * Unique Cosmos client instance id. + * + * @example 3ba4827d-4422-483f-b59f-85b74211c11d + */ + public const DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id'; + + /** + * Cosmos client connection mode. + */ + public const DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode'; + + /** + * Cosmos DB container name. + * + * @example anystring + */ + public const DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container'; + + /** + * CosmosDB Operation Type. + */ + public const DB_COSMOSDB_OPERATION_TYPE = 'db.cosmosdb.operation_type'; + + /** + * RU consumed for that operation. + * + * @example 46.18 + * @example 1.0 + */ + public const DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge'; + + /** + * Request payload size in bytes. + */ + public const DB_COSMOSDB_REQUEST_CONTENT_LENGTH = 'db.cosmosdb.request_content_length'; + + /** + * Cosmos DB status code. + * + * @example 200 + * @example 201 + */ + public const DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code'; + + /** + * Cosmos DB sub status code. + * + * @example 1000 + * @example 1002 */ - public const JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name'; + public const DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code'; /** - * Name of the memory pool. - * - * Pool names are generally obtained via MemoryPoolMXBean#getName(). + * Represents the identifier of an Elasticsearch cluster. * - * @example G1 Old Gen - * @example G1 Eden space - * @example G1 Survivor Space + * @example e9106fc68e3044f0b1475b04bf4ffd5f */ - public const JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name'; + public const DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name'; /** - * The type of memory. + * Represents the human-readable identifier of the node/instance to which a request was routed. * - * @example heap - * @example non_heap + * @example instance-0000000001 */ - public const JVM_MEMORY_TYPE = 'jvm.memory.type'; + public const DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name'; /** - * OSI transport layer or inter-process communication method. - * - * The value SHOULD be normalized to lowercase.Consider always setting the transport when setting a port number, since - * a port number is ambiguous without knowing the transport. For example - * different processes could be listening on TCP port 12345 and UDP port 12345. + * The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect. * - * @example tcp - * @example udp + * @example org.postgresql.Driver + * @example com.microsoft.sqlserver.jdbc.SQLServerDriver */ - public const NETWORK_TRANSPORT = 'network.transport'; + public const DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname'; /** - * OSI network layer or non-OSI equivalent. - * - * The value SHOULD be normalized to lowercase. + * The collection being accessed within the database stated in `db.name`. * - * @example ipv4 - * @example ipv6 + * @example customers + * @example products */ - public const NETWORK_TYPE = 'network.type'; + public const DB_MONGODB_COLLECTION = 'db.mongodb.collection'; /** - * The name of the (logical) method being called, must be equal to the $method part in the span name. + * The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance. * - * This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side). + * If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard). * - * @example exampleMethod + * @example MSSQLSERVER */ - public const RPC_METHOD = 'rpc.method'; + public const DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name'; /** - * The full (logical) name of the service being called, including its package name, if applicable. + * This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails). * - * This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). + * In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name). * - * @example myservice.EchoService + * @example customers + * @example main */ - public const RPC_SERVICE = 'rpc.service'; + public const DB_NAME = 'db.name'; /** - * A string identifying the remoting system. See below for a list of well-known identifiers. + * The name of the operation being executed, e.g. the MongoDB command name such as `findAndModify`, or the SQL keyword. + * + * When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted. + * + * @example findAndModify + * @example HMSET + * @example SELECT */ - public const RPC_SYSTEM = 'rpc.system'; + public const DB_OPERATION = 'db.operation'; /** - * The device identifier. + * The index of the database being accessed as used in the `SELECT` command, provided as an integer. To be used instead of the generic `db.name` attribute. * - * @example (identifier) + * @example 1 + * @example 15 */ - public const SYSTEM_DEVICE = 'system.device'; + public const DB_REDIS_DATABASE_INDEX = 'db.redis.database_index'; /** - * The logical CPU number [0..n-1]. + * The name of the primary table that the operation is acting upon, including the database name (if applicable). * - * @example 1 + * It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set. + * + * @example public.users + * @example customers */ - public const SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number'; + public const DB_SQL_TABLE = 'db.sql.table'; /** - * The state of the CPU. + * The database statement being executed. * - * @example idle - * @example interrupt + * @example SELECT * FROM wuser_table + * @example SET mykey "WuValue" */ - public const SYSTEM_CPU_STATE = 'system.cpu.state'; + public const DB_STATEMENT = 'db.statement'; /** - * The memory state. - * - * @example free - * @example cached + * An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. */ - public const SYSTEM_MEMORY_STATE = 'system.memory.state'; + public const DB_SYSTEM = 'db.system'; /** - * The paging access direction. + * Username for accessing the database. * - * @example in + * @example readonly_user + * @example reporting_user */ - public const SYSTEM_PAGING_DIRECTION = 'system.paging.direction'; + public const DB_USER = 'db.user'; /** - * The memory paging state. + * Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. * - * @example free + * When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available. + * + * @example destination.example.com + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const SYSTEM_PAGING_STATE = 'system.paging.state'; + public const DESTINATION_ADDRESS = 'destination.address'; /** - * The memory paging type. + * Destination port number. * - * @example minor + * @example 3389 + * @example 2888 */ - public const SYSTEM_PAGING_TYPE = 'system.paging.type'; + public const DESTINATION_PORT = 'destination.port'; /** - * The disk operation direction. + * Username or client_id extracted from the access token or Authorization header in the inbound request from outside the system. * - * @example read + * @example username */ - public const SYSTEM_DISK_DIRECTION = 'system.disk.direction'; + public const ENDUSER_ID = 'enduser.id'; /** - * The filesystem mode. + * Actual/assumed role the client is making the request under extracted from token or application security context. * - * @example rw, ro + * @example admin */ - public const SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode'; + public const ENDUSER_ROLE = 'enduser.role'; /** - * The filesystem mount path. + * Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an OAuth 2.0 Access Token or an attribute value in a SAML 2.0 Assertion. * - * @example /mnt/data + * @example read:message, write:files */ - public const SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint'; + public const ENDUSER_SCOPE = 'enduser.scope'; /** - * The filesystem state. + * Describes a class of error the operation ended with. * - * @example used + * The `error.type` SHOULD be predictable and SHOULD have low cardinality. + * Instrumentations SHOULD document the list of errors they report.The cardinality of `error.type` within one instrumentation library SHOULD be low. + * Telemetry consumers that aggregate data from multiple instrumentation libraries and applications + * should be prepared for `error.type` to have high cardinality at query time when no + * additional filters are applied.If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), + * it's RECOMMENDED to:
    + *
  • Use a domain-specific attribute
    • + *
  • Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
    • + *
+ * + * @example timeout + * @example java.net.UnknownHostException + * @example server_certificate_invalid + * @example 500 */ - public const SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state'; + public const ERROR_TYPE = 'error.type'; /** - * The filesystem type. + * The domain identifies the business context for the events. * - * @example ext4 + * Events across different domains may have same `event.name`, yet be unrelated events. */ - public const SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type'; + public const EVENT_DOMAIN = 'event.domain'; /** - * . + * The name identifies the event. * - * @example transmit + * @example click + * @example exception */ - public const SYSTEM_NETWORK_DIRECTION = 'system.network.direction'; + public const EVENT_NAME = 'event.name'; /** - * A stateless protocol MUST NOT set this attribute. + * SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span. * - * @example close_wait + * An exception is considered to have escaped (or left) the scope of a span, + * if that span is ended while the exception is still logically "in flight". + * This may be actually "in flight" in some languages (e.g. if the exception + * is passed to a Context manager's `__exit__` method in Python) but will + * usually be caught at the point of recording the exception in most languages.It is usually not possible to determine at the point where an exception is thrown + * whether it will escape the scope of a span. + * However, it is trivial to know that an exception + * will escape, if one checks for an active exception just before ending the span, + * as done in the example above.It follows that an exception may still escape the scope of the span + * even if the `exception.escaped` attribute was not set or set to false, + * since the event might have been recorded at a time where it was not + * clear whether the exception will escape. */ - public const SYSTEM_NETWORK_STATE = 'system.network.state'; + public const EXCEPTION_ESCAPED = 'exception.escaped'; /** - * The process state, e.g., Linux Process State Codes. + * The exception message. * - * @example running + * @example Division by zero + * @example Can't convert 'int' object to str implicitly */ - public const SYSTEM_PROCESSES_STATUS = 'system.processes.status'; + public const EXCEPTION_MESSAGE = 'exception.message'; /** - * Local address of the network connection - IP address or Unix domain socket name. + * A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. * - * @example 10.1.2.80 - * @example /tmp/my.sock + * @example Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5) */ - public const NETWORK_LOCAL_ADDRESS = 'network.local.address'; + public const EXCEPTION_STACKTRACE = 'exception.stacktrace'; /** - * Local port number of the network connection. + * The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. * - * @example 65123 + * @example java.net.ConnectException + * @example OSError */ - public const NETWORK_LOCAL_PORT = 'network.local.port'; + public const EXCEPTION_TYPE = 'exception.type'; /** - * Peer address of the network connection - IP address or Unix domain socket name. - * - * @example 10.1.2.80 - * @example /tmp/my.sock + * A boolean that is true if the serverless function is executed for the first time (aka cold-start). */ - public const NETWORK_PEER_ADDRESS = 'network.peer.address'; + public const FAAS_COLDSTART = 'faas.coldstart'; /** - * Peer port number of the network connection. + * A string containing the schedule period as Cron Expression. * - * @example 65123 + * @example 0/5 * * * ? * */ - public const NETWORK_PEER_PORT = 'network.peer.port'; + public const FAAS_CRON = 'faas.cron'; /** - * The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. + * The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. * - * @example DE + * @example myBucketName + * @example myDbName */ - public const NETWORK_CARRIER_ICC = 'network.carrier.icc'; + public const FAAS_DOCUMENT_COLLECTION = 'faas.document.collection'; /** - * The mobile carrier country code. + * The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. * - * @example 310 + * @example myFile.txt + * @example myTableName */ - public const NETWORK_CARRIER_MCC = 'network.carrier.mcc'; + public const FAAS_DOCUMENT_NAME = 'faas.document.name'; /** - * The mobile carrier network code. - * - * @example 001 + * Describes the type of the operation that was performed on the data. */ - public const NETWORK_CARRIER_MNC = 'network.carrier.mnc'; + public const FAAS_DOCUMENT_OPERATION = 'faas.document.operation'; /** - * The name of the mobile carrier. + * A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC. * - * @example sprint + * @example 2020-01-23T13:47:06Z */ - public const NETWORK_CARRIER_NAME = 'network.carrier.name'; + public const FAAS_DOCUMENT_TIME = 'faas.document.time'; /** - * This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. + * The invocation ID of the current function invocation. * - * @example LTE + * @example af9d5aa4-a685-4c5f-a22b-444f80b3cc28 */ - public const NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype'; + public const FAAS_INVOCATION_ID = 'faas.invocation_id'; /** - * The internet connection type. + * The name of the invoked function. * - * @example wifi + * SHOULD be equal to the `faas.name` resource attribute of the invoked function. + * + * @example my-function */ - public const NETWORK_CONNECTION_TYPE = 'network.connection.type'; + public const FAAS_INVOKED_NAME = 'faas.invoked_name'; /** - * The cloud account ID the resource is assigned to. + * The cloud provider of the invoked function. * - * @example 111111111111 - * @example opentelemetry + * SHOULD be equal to the `cloud.provider` resource attribute of the invoked function. */ - public const CLOUD_ACCOUNT_ID = 'cloud.account.id'; + public const FAAS_INVOKED_PROVIDER = 'faas.invoked_provider'; /** - * Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. + * The cloud region of the invoked function. * - * Availability zones are called "zones" on Alibaba Cloud and Google Cloud. + * SHOULD be equal to the `cloud.region` resource attribute of the invoked function. * - * @example us-east-1c + * @example eu-central-1 */ - public const CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone'; + public const FAAS_INVOKED_REGION = 'faas.invoked_region'; /** - * The cloud platform in use. + * A string containing the function invocation time in the ISO 8601 format expressed in UTC. * - * The prefix of the service SHOULD match the one specified in `cloud.provider`. + * @example 2020-01-23T13:47:06Z */ - public const CLOUD_PLATFORM = 'cloud.platform'; + public const FAAS_TIME = 'faas.time'; /** - * Name of the cloud provider. + * Type of the trigger which caused this function invocation. */ - public const CLOUD_PROVIDER = 'cloud.provider'; + public const FAAS_TRIGGER = 'faas.trigger'; /** - * The geographical region the resource is running. - * - * 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 unique identifier of the feature flag. * - * @example us-central1 - * @example us-east-1 + * @example logo-color */ - public const CLOUD_REGION = 'cloud.region'; + public const FEATURE_FLAG_KEY = 'feature_flag.key'; /** - * 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). - * - * 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 - * 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//resourceGroups//providers/Microsoft.Web/sites//functions/`. - * This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share - * a TracerProvider.
    • - *
+ * The name of the service provider that performs the flag evaluation. * - * @example arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function - * @example //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID - * @example /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ + * @example Flag Manager */ - public const CLOUD_RESOURCE_ID = 'cloud.resource_id'; + public const FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name'; /** - * The command used to run the container (i.e. the command name). + * SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. * - * If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage. + * A semantic identifier, commonly referred to as a variant, provides a means + * for referring to a value without including the value itself. This can + * provide additional context for understanding the meaning behind a value. + * For example, the variant `red` maybe be used for the value `#c05543`.A stringified version of the value can be used in situations where a + * semantic identifier is unavailable. String representation of the value + * should be determined by the implementer. * - * @example otelcontribcol + * @example red + * @example true + * @example on */ - public const CONTAINER_COMMAND = 'container.command'; + public const FEATURE_FLAG_VARIANT = 'feature_flag.variant'; /** - * All the command arguments (including the command/executable itself) run by the container. [2]. + * The GraphQL document being executed. * - * @example otelcontribcol, --config, config.yaml + * The value may be sanitized to exclude sensitive information. + * + * @example query findBookById { bookById(id: ?) { name } } */ - public const CONTAINER_COMMAND_ARGS = 'container.command_args'; + public const GRAPHQL_DOCUMENT = 'graphql.document'; /** - * The full command run by the container as a single string representing the full command. [2]. + * The name of the operation being executed. * - * @example otelcontribcol --config config.yaml + * @example findBookById */ - public const CONTAINER_COMMAND_LINE = 'container.command_line'; + public const GRAPHQL_OPERATION_NAME = 'graphql.operation.name'; /** - * Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated. + * The type of the operation being executed. * - * @example a3bf90e006b2 + * @example query + * @example mutation + * @example subscription */ - public const CONTAINER_ID = 'container.id'; + public const GRAPHQL_OPERATION_TYPE = 'graphql.operation.type'; /** - * Runtime specific image identifier. Usually a hash algorithm followed by a UUID. - * - * Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field 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 using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes. + * Deprecated, use `http.request.method` instead. * - * @example sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f + * @deprecated Deprecated, use `http.request.method` instead.. + * @example GET + * @example POST + * @example HEAD */ - public const CONTAINER_IMAGE_ID = 'container.image.id'; + public const HTTP_METHOD = 'http.method'; /** - * Name of the image the container was built on. + * The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. * - * @example gcr.io/opentelemetry/operator + * @example 3495 */ - public const CONTAINER_IMAGE_NAME = 'container.image.name'; + public const HTTP_REQUEST_BODY_SIZE = 'http.request.body.size'; /** - * Repo digests of the container image as provided by the container runtime. + * HTTP request method. * - * Docker and CRI report those under the `RepoDigests` field. + * HTTP request method value SHOULD be "known" to the instrumentation. + * By default, this convention defines "known" methods as the ones listed in RFC9110 + * and the PATCH method defined in RFC5789.If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override + * the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named + * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods + * (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. + * Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. + * Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. * - * @example example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb - * @example internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578 + * @example GET + * @example POST + * @example HEAD */ - public const CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests'; + public const HTTP_REQUEST_METHOD = 'http.request.method'; /** - * Container image tags. An example can be found in Docker Image Inspect. Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:`. + * Original HTTP method sent by the client in the request line. * - * @example v1.27.1 - * @example 3.5.7-0 + * @example GeT + * @example ACL + * @example foo */ - public const CONTAINER_IMAGE_TAGS = 'container.image.tags'; + public const HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original'; /** - * Container name used by container runtime. + * The ordinal number of request resending attempt (for any reason, including redirects). + * + * The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). * - * @example opentelemetry-autoconf + * @example 3 */ - public const CONTAINER_NAME = 'container.name'; + public const HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count'; /** - * The container runtime managing this container. + * Deprecated, use `http.request.header.content-length` instead. * - * @example docker - * @example containerd - * @example rkt + * @deprecated Deprecated, use `http.request.header.content-length` instead.. + * @example 3495 */ - public const CONTAINER_RUNTIME = 'container.runtime'; + public const HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length'; /** - * Deprecated, use `http.request.method` instead. + * The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. * - * @deprecated Deprecated, use `http.request.method` instead.. - * @example GET - * @example POST - * @example HEAD + * @example 3495 */ - public const HTTP_METHOD = 'http.method'; + public const HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size'; /** - * Deprecated, use `http.request.header.content-length` instead. + * HTTP response status code. * - * @deprecated Deprecated, use `http.request.header.content-length` instead.. - * @example 3495 + * @example 200 */ - public const HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length'; + public const HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code'; /** * Deprecated, use `http.response.header.content-length` instead. @@ -831,6 +946,17 @@ interface TraceAttributes */ public const HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length'; + /** + * The matched route, that is, the path template in the format used by the respective server framework. + * + * MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. + * SHOULD include the application root if there is one. + * + * @example /users/:userID? + * @example {controller}/{action}/{id?} + */ + public const HTTP_ROUTE = 'http.route'; + /** * Deprecated, use `url.scheme` instead. * @@ -865,136 +991,105 @@ interface TraceAttributes public const HTTP_URL = 'http.url'; /** - * Deprecated, use `server.address`. + * This attribute represents the state the application has transitioned into at the occurrence of the event. * - * @deprecated Deprecated, use `server.address`.. - * @example example.com + * The iOS lifecycle states are defined in the UIApplicationDelegate documentation, and from which the `OS terminology` column values are derived. */ - public const NET_HOST_NAME = 'net.host.name'; + public const IOS_STATE = 'ios.state'; /** - * Deprecated, use `server.port`. + * Name of the buffer pool. * - * @deprecated Deprecated, use `server.port`.. - * @example 8080 - */ - public const NET_HOST_PORT = 'net.host.port'; - - /** - * Deprecated, use `server.address` on client spans and `client.address` on server spans. + * Pool names are generally obtained via BufferPoolMXBean#getName(). * - * @deprecated Deprecated, use `server.address` on client spans and `client.address` on server spans.. - * @example example.com + * @example mapped + * @example direct */ - public const NET_PEER_NAME = 'net.peer.name'; + public const JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name'; /** - * Deprecated, use `server.port` on client spans and `client.port` on server spans. + * Name of the memory pool. * - * @deprecated Deprecated, use `server.port` on client spans and `client.port` on server spans.. - * @example 8080 - */ - public const NET_PEER_PORT = 'net.peer.port'; - - /** - * Deprecated, use `network.protocol.name`. + * Pool names are generally obtained via MemoryPoolMXBean#getName(). * - * @deprecated Deprecated, use `network.protocol.name`.. - * @example amqp - * @example http - * @example mqtt + * @example G1 Old Gen + * @example G1 Eden space + * @example G1 Survivor Space */ - public const NET_PROTOCOL_NAME = 'net.protocol.name'; + public const JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name'; /** - * Deprecated, use `network.protocol.version`. + * The type of memory. * - * @deprecated Deprecated, use `network.protocol.version`.. - * @example 3.1.1 - */ - public const NET_PROTOCOL_VERSION = 'net.protocol.version'; - - /** - * Deprecated, use `network.transport` and `network.type`. + * @example heap + * @example non_heap */ - public const NET_SOCK_FAMILY = 'net.sock.family'; + public const JVM_MEMORY_TYPE = 'jvm.memory.type'; /** - * Deprecated, use `network.local.address`. + * The basename of the file. * - * @deprecated Deprecated, use `network.local.address`.. - * @example /var/my.sock + * @example audit.log */ - public const NET_SOCK_HOST_ADDR = 'net.sock.host.addr'; + public const LOG_FILE_NAME = 'log.file.name'; /** - * Deprecated, use `network.local.port`. + * The basename of the file, with symlinks resolved. * - * @deprecated Deprecated, use `network.local.port`.. - * @example 8080 + * @example uuid.log */ - public const NET_SOCK_HOST_PORT = 'net.sock.host.port'; + public const LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved'; /** - * Deprecated, use `network.peer.address`. + * The full path to the file. * - * @deprecated Deprecated, use `network.peer.address`.. - * @example 192.168.0.1 + * @example /var/log/mysql/audit.log */ - public const NET_SOCK_PEER_ADDR = 'net.sock.peer.addr'; + public const LOG_FILE_PATH = 'log.file.path'; /** - * Deprecated, no replacement at this time. + * The full path to the file, with symlinks resolved. * - * @deprecated Deprecated, no replacement at this time.. - * @example /var/my.sock + * @example /var/lib/docker/uuid.log */ - public const NET_SOCK_PEER_NAME = 'net.sock.peer.name'; + public const LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved'; /** - * Deprecated, use `network.peer.port`. - * - * @deprecated Deprecated, use `network.peer.port`.. - * @example 65531 + * The stream associated with the log. See below for a list of well-known values. */ - public const NET_SOCK_PEER_PORT = 'net.sock.peer.port'; + public const LOG_IOSTREAM = 'log.iostream'; /** - * Deprecated, use `network.transport`. + * A unique identifier for the Log Record. + * + * If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. + * The id MAY be an Universally Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used as needed. + * + * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV */ - public const NET_TRANSPORT = 'net.transport'; + public const LOG_RECORD_UID = 'log.record.uid'; /** - * The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. - * - * @example 3495 + * Compressed size of the message in bytes. */ - public const HTTP_REQUEST_BODY_SIZE = 'http.request.body.size'; + public const MESSAGE_COMPRESSED_SIZE = 'message.compressed_size'; /** - * Original HTTP method sent by the client in the request line. + * MUST be calculated as two different counters starting from `1` one for sent messages and one for received message. * - * @example GeT - * @example ACL - * @example foo + * This way we guarantee that the values will be consistent between different implementations. */ - public const HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original'; + public const MESSAGE_ID = 'message.id'; /** - * The ordinal number of request resending attempt (for any reason, including redirects). - * - * The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). - * - * @example 3 + * Whether this is a received or sent message. */ - public const HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count'; + public const MESSAGE_TYPE = 'message.type'; /** - * The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. - * - * @example 3495 + * Uncompressed size of the message in bytes. */ - public const HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size'; + public const MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size'; /** * The number of messages sent, received, or processed in the scope of the batching operation. @@ -1215,393 +1310,227 @@ interface TraceAttributes public const MESSAGING_SYSTEM = 'messaging.system'; /** - * The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. - * - * Follows OCI Image Manifest Specification, and specifically the Digest property. - * An example can be found in Example Image Manifest. - * - * @example sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 - */ - public const OCI_MANIFEST_DIGEST = 'oci.manifest.digest'; - - /** - * The error codes of the Connect request. Error codes are always string values. - */ - public const RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code'; - - /** - * The numeric status code of the gRPC request. - */ - public const RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code'; - - /** - * `error.code` property of response if it is an error response. - * - * @example -32700 - * @example 100 - */ - public const RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code'; - - /** - * `error.message` property of response if it is an error response. - * - * @example Parse error - * @example User already exists - */ - public const RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message'; - - /** - * `id` property of request or response. Since protocol allows id to be int, string, `null` or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of `null` value. Omit entirely if this is a notification. - * - * @example 10 - * @example request-7 - */ - public const RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id'; - - /** - * Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. - * - * @example 2.0 - * @example 1.0 - */ - public const RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version'; - - /** - * The URI fragment component. - * - * @example SemConv - */ - public const URL_FRAGMENT = 'url.fragment'; - - /** - * Absolute URL describing a network resource according to RFC3986. - * - * For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. - * `url.full` MUST NOT contain credentials passed via URL in form of `https://username:password@www.example.com/`. In such case username and password SHOULD be redacted and attribute's value SHOULD be `https://REDACTED:REDACTED@www.example.com/`. - * `url.full` SHOULD capture the absolute URL when it is available (or can be reconstructed) and SHOULD NOT be validated or modified except for sanitizing purposes. - * - * @example https://www.foo.bar/search?q=OpenTelemetry#SemConv - * @example //localhost - */ - public const URL_FULL = 'url.full'; - - /** - * The URI path component. - * - * @example /search - */ - public const URL_PATH = 'url.path'; - - /** - * The URI query component. - * - * Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it. - * - * @example q=OpenTelemetry - */ - public const URL_QUERY = 'url.query'; - - /** - * Value of the HTTP User-Agent header sent by the client. - * - * @example CERN-LineMode/2.15 libwww/2.17b3 - * @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1 - */ - public const USER_AGENT_ORIGINAL = 'user_agent.original'; - - /** - * A unique id to identify a session. - * - * @example 00112233-4455-6677-8899-aabbccddeeff - */ - public const SESSION_ID = 'session.id'; - - /** - * The previous `session.id` for this user, when known. - * - * @example 00112233-4455-6677-8899-aabbccddeeff - */ - public const SESSION_PREVIOUS_ID = 'session.previous_id'; - - /** - * Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. - * - * When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available. - * - * @example source.example.com - * @example 10.1.2.80 - * @example /tmp/my.sock - */ - public const SOURCE_ADDRESS = 'source.address'; - - /** - * Source port number. - * - * @example 3389 - * @example 2888 - */ - public const SOURCE_PORT = 'source.port'; - - /** - * The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable). - * - * This may be different from `cloud.resource_id` if an alias is involved. - * - * @example arn:aws:lambda:us-east-1:123456:function:myfunction:myalias - */ - public const AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn'; - - /** - * The event_id uniquely identifies the event. - * - * @example 123e4567-e89b-12d3-a456-426614174000 - * @example 0001 - */ - public const CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id'; - - /** - * The source identifies the context in which an event happened. - * - * @example https://github.com/cloudevents - * @example /cloudevents/spec/pull/123 - * @example my-service - */ - public const CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source'; - - /** - * The version of the CloudEvents specification which the event uses. - * - * @example 1.0 - */ - public const CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version'; - - /** - * The subject of the event in the context of the event producer (identified by source). - * - * @example mynewfile.jpg - */ - public const CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject'; - - /** - * The event_type contains a value describing the type of event related to the originating occurrence. - * - * @example com.github.pull_request.opened - * @example com.example.object.deleted.v2 - */ - public const CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type'; - - /** - * Parent-child Reference type. + * Deprecated, use `server.address`. * - * The causal relationship between a child Span and a parent Span. + * @deprecated Deprecated, use `server.address`.. + * @example example.com */ - public const OPENTRACING_REF_TYPE = 'opentracing.ref_type'; + public const NET_HOST_NAME = 'net.host.name'; /** - * The connection string used to connect to the database. It is recommended to remove embedded credentials. + * Deprecated, use `server.port`. * - * @example Server=(localdb)\v11.0;Integrated Security=true; + * @deprecated Deprecated, use `server.port`.. + * @example 8080 */ - public const DB_CONNECTION_STRING = 'db.connection_string'; + public const NET_HOST_PORT = 'net.host.port'; /** - * The fully-qualified class name of the Java Database Connectivity (JDBC) driver used to connect. + * Deprecated, use `server.address` on client spans and `client.address` on server spans. * - * @example org.postgresql.Driver - * @example com.microsoft.sqlserver.jdbc.SQLServerDriver + * @deprecated Deprecated, use `server.address` on client spans and `client.address` on server spans.. + * @example example.com */ - public const DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname'; + public const NET_PEER_NAME = 'net.peer.name'; /** - * This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails). - * - * In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name). + * Deprecated, use `server.port` on client spans and `client.port` on server spans. * - * @example customers - * @example main + * @deprecated Deprecated, use `server.port` on client spans and `client.port` on server spans.. + * @example 8080 */ - public const DB_NAME = 'db.name'; + public const NET_PEER_PORT = 'net.peer.port'; /** - * The name of the operation being executed, e.g. the MongoDB command name such as `findAndModify`, or the SQL keyword. - * - * When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted. + * Deprecated, use `network.protocol.name`. * - * @example findAndModify - * @example HMSET - * @example SELECT + * @deprecated Deprecated, use `network.protocol.name`.. + * @example amqp + * @example http + * @example mqtt */ - public const DB_OPERATION = 'db.operation'; + public const NET_PROTOCOL_NAME = 'net.protocol.name'; /** - * The database statement being executed. + * Deprecated, use `network.protocol.version`. * - * @example SELECT * FROM wuser_table - * @example SET mykey "WuValue" + * @deprecated Deprecated, use `network.protocol.version`.. + * @example 3.1.1 */ - public const DB_STATEMENT = 'db.statement'; + public const NET_PROTOCOL_VERSION = 'net.protocol.version'; /** - * An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers. + * Deprecated, use `network.transport` and `network.type`. */ - public const DB_SYSTEM = 'db.system'; + public const NET_SOCK_FAMILY = 'net.sock.family'; /** - * Username for accessing the database. + * Deprecated, use `network.local.address`. * - * @example readonly_user - * @example reporting_user + * @deprecated Deprecated, use `network.local.address`.. + * @example /var/my.sock */ - public const DB_USER = 'db.user'; + public const NET_SOCK_HOST_ADDR = 'net.sock.host.addr'; /** - * The Microsoft SQL Server instance name connecting to. This name is used to determine the port of a named instance. - * - * If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard). + * Deprecated, use `network.local.port`. * - * @example MSSQLSERVER - */ - public const DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name'; - - /** - * The consistency level of the query. Based on consistency values from CQL. + * @deprecated Deprecated, use `network.local.port`.. + * @example 8080 */ - public const DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level'; + public const NET_SOCK_HOST_PORT = 'net.sock.host.port'; /** - * The data center of the coordinating node for a query. + * Deprecated, use `network.peer.address`. * - * @example us-west-2 + * @deprecated Deprecated, use `network.peer.address`.. + * @example 192.168.0.1 */ - public const DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc'; + public const NET_SOCK_PEER_ADDR = 'net.sock.peer.addr'; /** - * The ID of the coordinating node for a query. + * Deprecated, no replacement at this time. * - * @example be13faa2-8574-4d71-926d-27f16cf8a7af + * @deprecated Deprecated, no replacement at this time.. + * @example /var/my.sock */ - public const DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id'; + public const NET_SOCK_PEER_NAME = 'net.sock.peer.name'; /** - * Whether or not the query is idempotent. + * Deprecated, use `network.peer.port`. + * + * @deprecated Deprecated, use `network.peer.port`.. + * @example 65531 */ - public const DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence'; + public const NET_SOCK_PEER_PORT = 'net.sock.peer.port'; /** - * The fetch size used for paging, i.e. how many rows will be returned at once. - * - * @example 5000 + * Deprecated, use `network.transport`. */ - public const DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size'; + public const NET_TRANSPORT = 'net.transport'; /** - * The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. + * The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. * - * @example 2 + * @example DE */ - public const DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count'; + public const NETWORK_CARRIER_ICC = 'network.carrier.icc'; /** - * The name of the primary table that the operation is acting upon, including the keyspace name (if applicable). - * - * This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set. + * The mobile carrier country code. * - * @example mytable + * @example 310 */ - public const DB_CASSANDRA_TABLE = 'db.cassandra.table'; + public const NETWORK_CARRIER_MCC = 'network.carrier.mcc'; /** - * The index of the database being accessed as used in the `SELECT` command, provided as an integer. To be used instead of the generic `db.name` attribute. + * The mobile carrier network code. * - * @example 1 - * @example 15 + * @example 001 */ - public const DB_REDIS_DATABASE_INDEX = 'db.redis.database_index'; + public const NETWORK_CARRIER_MNC = 'network.carrier.mnc'; /** - * The collection being accessed within the database stated in `db.name`. + * The name of the mobile carrier. * - * @example customers - * @example products + * @example sprint */ - public const DB_MONGODB_COLLECTION = 'db.mongodb.collection'; + public const NETWORK_CARRIER_NAME = 'network.carrier.name'; /** - * Represents the identifier of an Elasticsearch cluster. + * This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. * - * @example e9106fc68e3044f0b1475b04bf4ffd5f + * @example LTE */ - public const DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name'; + public const NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype'; /** - * Represents the human-readable identifier of the node/instance to which a request was routed. + * The internet connection type. * - * @example instance-0000000001 + * @example wifi */ - public const DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name'; + public const NETWORK_CONNECTION_TYPE = 'network.connection.type'; /** - * The name of the primary table that the operation is acting upon, including the database name (if applicable). - * - * It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set. + * Local address of the network connection - IP address or Unix domain socket name. * - * @example public.users - * @example customers + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const DB_SQL_TABLE = 'db.sql.table'; + public const NETWORK_LOCAL_ADDRESS = 'network.local.address'; /** - * Unique Cosmos client instance id. + * Local port number of the network connection. * - * @example 3ba4827d-4422-483f-b59f-85b74211c11d + * @example 65123 */ - public const DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id'; + public const NETWORK_LOCAL_PORT = 'network.local.port'; /** - * Cosmos client connection mode. + * Peer address of the network connection - IP address or Unix domain socket name. + * + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode'; + public const NETWORK_PEER_ADDRESS = 'network.peer.address'; /** - * Cosmos DB container name. + * Peer port number of the network connection. * - * @example anystring + * @example 65123 */ - public const DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container'; + public const NETWORK_PEER_PORT = 'network.peer.port'; /** - * CosmosDB Operation Type. + * OSI application layer or non-OSI equivalent. + * + * The value SHOULD be normalized to lowercase. + * + * @example http + * @example spdy */ - public const DB_COSMOSDB_OPERATION_TYPE = 'db.cosmosdb.operation_type'; + public const NETWORK_PROTOCOL_NAME = 'network.protocol.name'; /** - * RU consumed for that operation. + * Version of the protocol specified in `network.protocol.name`. + * + * `network.protocol.version` refers to the version of the protocol used and might be different from the protocol client's version. If the HTTP client has a version of `0.27.2`, but sends HTTP version `1.1`, this attribute should be set to `1.1`. * - * @example 46.18 * @example 1.0 + * @example 1.1 + * @example 2 + * @example 3 */ - public const DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge'; + public const NETWORK_PROTOCOL_VERSION = 'network.protocol.version'; /** - * Request payload size in bytes. + * OSI transport layer or inter-process communication method. + * + * The value SHOULD be normalized to lowercase.Consider always setting the transport when setting a port number, since + * a port number is ambiguous without knowing the transport. For example + * different processes could be listening on TCP port 12345 and UDP port 12345. + * + * @example tcp + * @example udp */ - public const DB_COSMOSDB_REQUEST_CONTENT_LENGTH = 'db.cosmosdb.request_content_length'; + public const NETWORK_TRANSPORT = 'network.transport'; /** - * Cosmos DB status code. + * OSI network layer or non-OSI equivalent. * - * @example 200 - * @example 201 + * The value SHOULD be normalized to lowercase. + * + * @example ipv4 + * @example ipv6 */ - public const DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code'; + public const NETWORK_TYPE = 'network.type'; /** - * Cosmos DB sub status code. + * Parent-child Reference type. * - * @example 1000 - * @example 1002 + * The causal relationship between a child Span and a parent Span. */ - public const DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code'; + public const OPENTRACING_REF_TYPE = 'opentracing.ref_type'; /** * Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. @@ -1616,377 +1545,317 @@ interface TraceAttributes public const OTEL_STATUS_DESCRIPTION = 'otel.status_description'; /** - * The invocation ID of the current function invocation. + * The `service.name` of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. * - * @example af9d5aa4-a685-4c5f-a22b-444f80b3cc28 + * @example AuthTokenCache */ - public const FAAS_INVOCATION_ID = 'faas.invocation_id'; + public const PEER_SERVICE = 'peer.service'; /** - * The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. + * The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, then the db.connection_string should be used. * - * @example myBucketName - * @example myDbName + * @example myDataSource */ - public const FAAS_DOCUMENT_COLLECTION = 'faas.document.collection'; + public const POOL_NAME = 'pool.name'; /** - * The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. - * - * @example myFile.txt - * @example myTableName + * The error codes of the Connect request. Error codes are always string values. */ - public const FAAS_DOCUMENT_NAME = 'faas.document.name'; + public const RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code'; /** - * Describes the type of the operation that was performed on the data. + * The numeric status code of the gRPC request. */ - public const FAAS_DOCUMENT_OPERATION = 'faas.document.operation'; + public const RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code'; /** - * A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC. + * `error.code` property of response if it is an error response. * - * @example 2020-01-23T13:47:06Z + * @example -32700 + * @example 100 */ - public const FAAS_DOCUMENT_TIME = 'faas.document.time'; + public const RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code'; /** - * A string containing the schedule period as Cron Expression. + * `error.message` property of response if it is an error response. * - * @example 0/5 * * * ? * + * @example Parse error + * @example User already exists */ - public const FAAS_CRON = 'faas.cron'; + public const RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message'; /** - * A string containing the function invocation time in the ISO 8601 format expressed in UTC. + * `id` property of request or response. Since protocol allows id to be int, string, `null` or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of `null` value. Omit entirely if this is a notification. * - * @example 2020-01-23T13:47:06Z - */ - public const FAAS_TIME = 'faas.time'; - - /** - * A boolean that is true if the serverless function is executed for the first time (aka cold-start). + * @example 10 + * @example request-7 */ - public const FAAS_COLDSTART = 'faas.coldstart'; + public const RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id'; /** - * The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. + * Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. * - * @example 79b9da39-b7ae-508a-a6bc-864b2829c622 - * @example C9ER4AJX75574TDJ + * @example 2.0 + * @example 1.0 */ - public const AWS_REQUEST_ID = 'aws.request_id'; + public const RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version'; /** - * The value of the `AttributesToGet` request parameter. + * The name of the (logical) method being called, must be equal to the $method part in the span name. * - * @example lives - * @example id - */ - public const AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get'; - - /** - * The value of the `ConsistentRead` request parameter. - */ - public const AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read'; - - /** - * The JSON-serialized value of each item in the `ConsumedCapacity` response field. + * This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side). * - * @example { "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "LocalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "ReadCapacityUnits": number, "Table": { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableName": "string", "WriteCapacityUnits": number } + * @example exampleMethod */ - public const AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity'; + public const RPC_METHOD = 'rpc.method'; /** - * The value of the `IndexName` request parameter. + * The full (logical) name of the service being called, including its package name, if applicable. * - * @example name_to_group - */ - public const AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name'; - - /** - * The JSON-serialized value of the `ItemCollectionMetrics` response field. + * This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). * - * @example { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] } + * @example myservice.EchoService */ - public const AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics'; + public const RPC_SERVICE = 'rpc.service'; /** - * The value of the `Limit` request parameter. - * - * @example 10 + * A string identifying the remoting system. See below for a list of well-known identifiers. */ - public const AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit'; + public const RPC_SYSTEM = 'rpc.system'; /** - * The value of the `ProjectionExpression` request parameter. + * Host identifier of the "URI origin" HTTP request is sent to. * - * @example Title - * @example Title, Price, Color - * @example Title, Description, RelatedItems, ProductReviews + * If an HTTP client request is explicitly made to an IP address, e.g. `http://x.x.x.x:8080`, then `server.address` SHOULD be the IP address `x.x.x.x`. A DNS lookup SHOULD NOT be used. + * + * @example example.com + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection'; + public const SERVER_ADDRESS = 'server.address'; /** - * The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. + * Port identifier of the "URI origin" HTTP request is sent to. + * + * When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. * - * @example 1.0 - * @example 2.0 + * @example 80 + * @example 8080 + * @example 443 */ - public const AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity'; + public const SERVER_PORT = 'server.port'; /** - * The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. + * A unique id to identify a session. * - * @example 1.0 - * @example 2.0 + * @example 00112233-4455-6677-8899-aabbccddeeff */ - public const AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity'; + public const SESSION_ID = 'session.id'; /** - * The value of the `Select` request parameter. + * The previous `session.id` for this user, when known. * - * @example ALL_ATTRIBUTES - * @example COUNT + * @example 00112233-4455-6677-8899-aabbccddeeff */ - public const AWS_DYNAMODB_SELECT = 'aws.dynamodb.select'; + public const SESSION_PREVIOUS_ID = 'session.previous_id'; /** - * The keys in the `RequestItems` object field. + * Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. * - * @example Users - * @example Cats + * When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available. + * + * @example source.example.com + * @example 10.1.2.80 + * @example /tmp/my.sock */ - public const AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names'; + public const SOURCE_ADDRESS = 'source.address'; /** - * The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field. + * Source port number. * - * @example { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } + * @example 3389 + * @example 2888 */ - public const AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes'; + public const SOURCE_PORT = 'source.port'; /** - * The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. + * The state of a connection in the pool. * - * @example { "IndexArn": "string", "IndexName": "string", "IndexSizeBytes": number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } } + * @example idle */ - public const AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes'; + public const STATE = 'state'; /** - * The value of the `ExclusiveStartTableName` request parameter. + * The logical CPU number [0..n-1]. * - * @example Users - * @example CatsTable + * @example 1 */ - public const AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table'; + public const SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number'; /** - * The the number of items in the `TableNames` response parameter. + * The state of the CPU. * - * @example 20 + * @example idle + * @example interrupt */ - public const AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count'; + public const SYSTEM_CPU_STATE = 'system.cpu.state'; /** - * The value of the `ScanIndexForward` request parameter. + * The device identifier. + * + * @example (identifier) */ - public const AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward'; + public const SYSTEM_DEVICE = 'system.device'; /** - * The value of the `Count` response parameter. + * The disk operation direction. * - * @example 10 + * @example read */ - public const AWS_DYNAMODB_COUNT = 'aws.dynamodb.count'; + public const SYSTEM_DISK_DIRECTION = 'system.disk.direction'; /** - * The value of the `ScannedCount` response parameter. + * The filesystem mode. * - * @example 50 + * @example rw, ro */ - public const AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count'; + public const SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode'; /** - * The value of the `Segment` request parameter. + * The filesystem mount path. * - * @example 10 + * @example /mnt/data */ - public const AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment'; + public const SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint'; /** - * The value of the `TotalSegments` request parameter. + * The filesystem state. * - * @example 100 + * @example used */ - public const AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments'; + public const SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state'; /** - * The JSON-serialized value of each item in the `AttributeDefinitions` request field. + * The filesystem type. * - * @example { "AttributeName": "string", "AttributeType": "string" } + * @example ext4 */ - public const AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions'; + public const SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type'; /** - * The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field. + * The memory state. * - * @example { "Create": { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } + * @example free + * @example cached */ - public const AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates'; + public const SYSTEM_MEMORY_STATE = 'system.memory.state'; /** - * The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the S3 API operations. - * - * The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. - * This applies to almost all S3 operations except `list-buckets`. + * . * - * @example some-bucket-name + * @example transmit */ - public const AWS_S3_BUCKET = 'aws.s3.bucket'; + public const SYSTEM_NETWORK_DIRECTION = 'system.network.direction'; /** - * The source object (in the form `bucket`/`key`) for the copy operation. - * - * The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter - * of the copy-object operation within the S3 API. - * This applies in particular to the following operations:
    - *
  • copy-object
    • - *
  • upload-part-copy
    • - *
+ * A stateless protocol MUST NOT set this attribute. * - * @example someFile.yml + * @example close_wait */ - public const AWS_S3_COPY_SOURCE = 'aws.s3.copy_source'; + public const SYSTEM_NETWORK_STATE = 'system.network.state'; /** - * The delete request container that specifies the objects to be deleted. - * - * The `delete` attribute is only applicable to the delete-object operation. - * The `delete` attribute corresponds to the `--delete` parameter of the - * delete-objects operation within the S3 API. + * The paging access direction. * - * @example Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean + * @example in */ - public const AWS_S3_DELETE = 'aws.s3.delete'; + public const SYSTEM_PAGING_DIRECTION = 'system.paging.direction'; /** - * The S3 object key the request refers to. Corresponds to the `--key` parameter of the S3 API operations. - * - * The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. - * This applies in particular to the following operations:
    - *
  • copy-object
    • - *
  • delete-object
    • - *
  • get-object
    • - *
  • head-object
    • - *
  • put-object
    • - *
  • restore-object
    • - *
  • select-object-content
    • - *
  • abort-multipart-upload
    • - *
  • complete-multipart-upload
    • - *
  • create-multipart-upload
    • - *
  • list-parts
    • - *
  • upload-part
    • - *
  • upload-part-copy
    • - *
+ * The memory paging state. * - * @example someFile.yml + * @example free */ - public const AWS_S3_KEY = 'aws.s3.key'; + public const SYSTEM_PAGING_STATE = 'system.paging.state'; /** - * The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. - * - * The `part_number` attribute is only applicable to the upload-part - * and upload-part-copy operations. - * The `part_number` attribute corresponds to the `--part-number` parameter of the - * upload-part operation within the S3 API. + * The memory paging type. * - * @example 3456 + * @example minor */ - public const AWS_S3_PART_NUMBER = 'aws.s3.part_number'; + public const SYSTEM_PAGING_TYPE = 'system.paging.type'; /** - * Upload ID that identifies the multipart upload. - * - * The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter - * of the S3 API multipart operations. - * This applies in particular to the following operations:
    - *
  • abort-multipart-upload
    • - *
  • complete-multipart-upload
    • - *
  • list-parts
    • - *
  • upload-part
    • - *
  • upload-part-copy
    • - *
+ * The process state, e.g., Linux Process State Codes. * - * @example dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ + * @example running */ - public const AWS_S3_UPLOAD_ID = 'aws.s3.upload_id'; + public const SYSTEM_PROCESSES_STATUS = 'system.processes.status'; /** - * The GraphQL document being executed. - * - * The value may be sanitized to exclude sensitive information. + * Current "managed" thread ID (as opposed to OS thread ID). * - * @example query findBookById { bookById(id: ?) { name } } + * @example 42 */ - public const GRAPHQL_DOCUMENT = 'graphql.document'; + public const THREAD_ID = 'thread.id'; /** - * The name of the operation being executed. + * Current thread name. * - * @example findBookById + * @example main */ - public const GRAPHQL_OPERATION_NAME = 'graphql.operation.name'; + public const THREAD_NAME = 'thread.name'; /** - * The type of the operation being executed. + * The URI fragment component. * - * @example query - * @example mutation - * @example subscription + * @example SemConv */ - public const GRAPHQL_OPERATION_TYPE = 'graphql.operation.type'; + public const URL_FRAGMENT = 'url.fragment'; /** - * Compressed size of the message in bytes. + * Absolute URL describing a network resource according to RFC3986. + * + * For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. + * `url.full` MUST NOT contain credentials passed via URL in form of `https://username:password@www.example.com/`. In such case username and password SHOULD be redacted and attribute's value SHOULD be `https://REDACTED:REDACTED@www.example.com/`. + * `url.full` SHOULD capture the absolute URL when it is available (or can be reconstructed) and SHOULD NOT be validated or modified except for sanitizing purposes. + * + * @example https://www.foo.bar/search?q=OpenTelemetry#SemConv + * @example //localhost */ - public const MESSAGE_COMPRESSED_SIZE = 'message.compressed_size'; + public const URL_FULL = 'url.full'; /** - * MUST be calculated as two different counters starting from `1` one for sent messages and one for received message. + * The URI path component. * - * This way we guarantee that the values will be consistent between different implementations. + * @example /search */ - public const MESSAGE_ID = 'message.id'; + public const URL_PATH = 'url.path'; /** - * Whether this is a received or sent message. + * The URI query component. + * + * Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it. + * + * @example q=OpenTelemetry */ - public const MESSAGE_TYPE = 'message.type'; + public const URL_QUERY = 'url.query'; /** - * Uncompressed size of the message in bytes. + * The URI scheme component identifying the used protocol. + * + * @example http + * @example https */ - public const MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size'; + public const URL_SCHEME = 'url.scheme'; /** - * SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span. + * Value of the HTTP User-Agent header sent by the client. * - * An exception is considered to have escaped (or left) the scope of a span, - * if that span is ended while the exception is still logically "in flight". - * This may be actually "in flight" in some languages (e.g. if the exception - * is passed to a Context manager's `__exit__` method in Python) but will - * usually be caught at the point of recording the exception in most languages.It is usually not possible to determine at the point where an exception is thrown - * whether it will escape the scope of a span. - * However, it is trivial to know that an exception - * will escape, if one checks for an active exception just before ending the span, - * as done in the example above.It follows that an exception may still escape the scope of the span - * even if the `exception.escaped` attribute was not set or set to false, - * since the event might have been recorded at a time where it was not - * clear whether the exception will escape. + * @example CERN-LineMode/2.15 libwww/2.17b3 + * @example Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1 */ - public const EXCEPTION_ESCAPED = 'exception.escaped'; + public const USER_AGENT_ORIGINAL = 'user_agent.original'; /** * @deprecated