diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8c37a4f289..44baae1131 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,29 @@ release.
### Breaking
+- Update `jvm.gc.duration` histogram buckets to `[ 0.01, 0.1, 1, 10 ]`
+ ([#317](https://github.com/open-telemetry/semantic-conventions/pull/317))
+- BREAKING: Change type of `host.cpu.model.id` and `host.cpu.model.family` to string.
+ ([#495](https://github.com/open-telemetry/semantic-conventions/issues/495))
+
+### Features
+
+- Add `code.stacktrace` attribute
+ ([#435](https://github.com/open-telemetry/semantic-conventions/pull/435))
+- Add `http.flavor` and `http.user_agent` to list of deprecated attributes
+ ([#503](https://github.com/open-telemetry/semantic-conventions/pull/503))
+- Add Semantic conventions for TLS/SSL encrypted communication.
+ ([#21](https://github.com/open-telemetry/semantic-conventions/pull/21))
+
+### Fixes
+
+## v1.23.0 (2023-11-03)
+
+This release marks the first where the core of HTTP semantic conventions have
+stabilized.
+
+### Breaking
+
- BREAKING: Rename http.resend_count to http.request.resend_count.
([#374](https://github.com/open-telemetry/semantic-conventions/pull/374))
- BREAKING: Change `network.protocol.name` from recommended to opt-in in HTTP semconv.
@@ -68,6 +91,8 @@ release.
([#409](https://github.com/open-telemetry/semantic-conventions/pull/409))
- Add `host.mac` resource attribute convention.
([#340](https://github.com/open-telemetry/semantic-conventions/pull/340))
+- Mark HTTP semantic conventions as stable.
+ ([#377](https://github.com/open-telemetry/semantic-conventions/pull/377))
### Fixes
@@ -87,6 +112,7 @@ release.
- Change the precedence between `:authority` and `Host` headers when populating
`server.address` and `server.port` attributes.
([#455](https://github.com/open-telemetry/semantic-conventions/pull/455))
+- Explain `deployment.environment` impact on service identity. ([#481](https://github.com/open-telemetry/semantic-conventions/pull/481))
## v1.22.0 (2023-10-12)
diff --git a/Makefile b/Makefile
index ca93385774..acbb7f7de7 100644
--- a/Makefile
+++ b/Makefile
@@ -90,13 +90,13 @@ yamllint:
.PHONY: table-generation
table-generation:
docker run --rm -v $(PWD)/model:/source -v $(PWD)/docs:/spec \
- otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec
+ otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-use-badges --md-stable
# Check if current markdown tables differ from the ones that would be generated from YAML definitions
.PHONY: table-check
table-check:
docker run --rm -v $(PWD)/model:/source -v $(PWD)/docs:/spec \
- otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-check
+ otel/semconvgen:$(SEMCONVGEN_VERSION) -f /source markdown -md /spec --md-check --md-use-badges --md-stable
.PHONY: schema-check
schema-check:
diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
index fdff795789..be97468451 100644
--- a/docs/attributes-registry/README.md
+++ b/docs/attributes-registry/README.md
@@ -27,14 +27,24 @@ All registered attributes are listed by namespace in this registry.
Currently, the following namespaces exist:
+* [Client](client.md)
* [Cloud](cloud.md)
* [Code](code.md)
* [Container](container.md)
+* [Destination](destination.md)
+* [Device](device.md)
+* [Error](error.md)
+* [Host](host.md)
* [HTTP](http.md)
* [Network](network.md)
* [OCI](oci.md)
+* [OS](os.md)
+* [Process](process.md)
* [RPC](rpc.md)
+* [Server](server.md)
+* [Source](source.md)
* [Thread](thread.md)
+* [TLS](tls.md)
* [URL](url.md)
* [User agent](user-agent.md)
diff --git a/docs/attributes-registry/client.md b/docs/attributes-registry/client.md
new file mode 100644
index 0000000000..9ed3875a83
--- /dev/null
+++ b/docs/attributes-registry/client.md
@@ -0,0 +1,23 @@
+
+
+# Client Attributes
+
+These attributes may be used to describe the client in a connection-based network interaction
+where there is one side that initiates the connection (the client is the side that initiates the connection).
+This covers all TCP network interactions since TCP is connection-based and one side initiates the
+connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the
+protocol / API does not expose a clear notion of client and server).
+This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `client.address` | string | 
Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` |
+| `client.port` | int | 
Client port number. [2] | `65123` |
+
+**[1]:** 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.
+
+**[2]:** 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.
+
diff --git a/docs/attributes-registry/code.md b/docs/attributes-registry/code.md
index a337e239ed..651caa99f5 100644
--- a/docs/attributes-registry/code.md
+++ b/docs/attributes-registry/code.md
@@ -15,4 +15,5 @@ These attributes allow to report this unit of code and therefore to provide more
| `code.function` | string | The method or function name, or equivalent (usually rightmost part of the code unit's name). | `serveRequest` |
| `code.lineno` | int | The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. | `42` |
| `code.namespace` | string | 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. | `com.example.MyHttpService` |
+| `code.stacktrace` | string | 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. | `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)` |
\ No newline at end of file
diff --git a/docs/attributes-registry/destination.md b/docs/attributes-registry/destination.md
new file mode 100644
index 0000000000..db83cb53b0
--- /dev/null
+++ b/docs/attributes-registry/destination.md
@@ -0,0 +1,21 @@
+
+
+# Destination Attributes
+
+These attributes may be used to describe the receiver of a network exchange/packet. These should be used
+when there is no client/server relationship between the two sides, or when that relationship is unknown.
+This covers low-level network interactions (e.g. packet tracing) where you don't know if
+there was a connection or which side initiated it.
+This also covers unidirectional UDP flows and peer-to-peer communication where the
+"user-facing" surface of the protocol / API does not expose a clear notion of client and server.
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `destination.address` | string | Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `destination.example.com`; `10.1.2.80`; `/tmp/my.sock` |
+| `destination.port` | int | Destination port number | `3389`; `2888` |
+
+**[1]:** 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.
+
diff --git a/docs/attributes-registry/device.md b/docs/attributes-registry/device.md
new file mode 100644
index 0000000000..3c1f06c4ea
--- /dev/null
+++ b/docs/attributes-registry/device.md
@@ -0,0 +1,23 @@
+
+
+# Device
+
+## Device Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `device.id` | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` |
+| `device.manufacturer` | string | The name of the device manufacturer [2] | `Apple`; `Samsung` |
+| `device.model.identifier` | string | The model identifier for the device [3] | `iPhone3,4`; `SM-G920F` |
+| `device.model.name` | string | The marketing name for the device model [4] | `iPhone 6s Plus`; `Samsung Galaxy S6` |
+
+**[1]:** The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence.
+
+**[2]:** The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
+
+**[3]:** It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device.
+
+**[4]:** It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative.
+
diff --git a/docs/attributes-registry/error.md b/docs/attributes-registry/error.md
new file mode 100644
index 0000000000..21e0d2c67d
--- /dev/null
+++ b/docs/attributes-registry/error.md
@@ -0,0 +1,34 @@
+
+
+# Error
+
+## Error Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `error.type` | string | 
Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` |
+
+**[1]:** 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.
+
+`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
+
+| Value | Description |
+|---|---|
+| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |
+
\ No newline at end of file
diff --git a/docs/attributes-registry/host.md b/docs/attributes-registry/host.md
new file mode 100644
index 0000000000..005700c2cc
--- /dev/null
+++ b/docs/attributes-registry/host.md
@@ -0,0 +1,44 @@
+
+# Host
+
+## Host Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `host.arch` | string | The CPU architecture the host system is running on. | `amd64` |
+| `host.cpu.cache.l2.size` | int | The amount of level 2 memory cache available to the processor (in Bytes). | `12288000` |
+| `host.cpu.family` | string | Family or generation of the CPU. | `6`; `PA-RISC 1.1e` |
+| `host.cpu.model.id` | string | Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. | `6`; `9000/778/B180L` |
+| `host.cpu.model.name` | string | Model designation of the processor. | `11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz` |
+| `host.cpu.stepping` | int | Stepping or core revisions. | `1` |
+| `host.cpu.vendor.id` | string | Processor manufacturer identifier. A maximum 12-character string. [1] | `GenuineIntel` |
+| `host.id` | string | 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. | `fdbf79e8af94cb7f9e8df36789187052` |
+| `host.image.id` | string | VM image ID or host OS image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` |
+| `host.image.name` | string | Name of the VM image or OS install the host was instantiated from. | `infra-ami-eks-worker-node-7d4ec78312`; `CentOS-8-x86_64-1905` |
+| `host.image.version` | string | The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `0.1` |
+| `host.ip` | string[] | Available IP addresses of the host, excluding loopback interfaces. [2] | `[192.168.1.140, fe80::abc2:4a28:737a:609e]` |
+| `host.mac` | string[] | Available MAC addresses of the host, excluding loopback interfaces. [3] | `[AC-DE-48-23-45-67, AC-DE-48-23-45-67-01-9F]` |
+| `host.name` | string | 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. | `opentelemetry-test` |
+| `host.type` | string | Type of host. For Cloud, this must be the machine type. | `n1-standard-1` |
+
+**[1]:** [CPUID](https://wiki.osdev.org/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.
+
+**[2]:** IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format.
+
+**[3]:** MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
+
+`host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
+
+| Value | Description |
+|---|---|
+| `amd64` | AMD64 |
+| `arm32` | ARM32 |
+| `arm64` | ARM64 |
+| `ia64` | Itanium |
+| `ppc32` | 32-bit PowerPC |
+| `ppc64` | 64-bit PowerPC |
+| `s390x` | IBM z/Architecture |
+| `x86` | 32-bit x86 |
+
\ No newline at end of file
diff --git a/docs/attributes-registry/http.md b/docs/attributes-registry/http.md
index 04d52c8a25..2f9481a64c 100644
--- a/docs/attributes-registry/http.md
+++ b/docs/attributes-registry/http.md
@@ -9,14 +9,14 @@
| Attribute | Type | Description | Examples |
|---|---|---|---|
| `http.request.body.size` | int | 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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. | `3495` |
-| `http.request.header.` | string[] | HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [1] | `http.request.header.content-type=["application/json"]`; `http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]` |
-| `http.request.method` | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` |
-| `http.request.method_original` | string | Original HTTP method sent by the client in the request line. | `GeT`; `ACL`; `foo` |
-| `http.request.resend_count` | int | The ordinal number of request resending attempt (for any reason, including redirects). [3] | `3` |
+| `http.request.header.` | string[] | 
HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [1] | `http.request.header.content-type=["application/json"]`; `http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]` |
+| `http.request.method` | string | 
HTTP request method. [2] | `GET`; `POST`; `HEAD` |
+| `http.request.method_original` | string | 
Original HTTP method sent by the client in the request line. | `GeT`; `ACL`; `foo` |
+| `http.request.resend_count` | int | 
The ordinal number of request resending attempt (for any reason, including redirects). [3] | `3` |
| `http.response.body.size` | int | 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](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. | `3495` |
-| `http.response.header.` | string[] | HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [4] | `http.response.header.content-type=["application/json"]`; `http.response.header.my-custom-header=["abc", "def"]` |
-| `http.response.status_code` | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` |
-| `http.route` | string | The matched route, that is, the path template in the format used by the respective server framework. [5] | `/users/:userID?`; `{controller}/{action}/{id?}` |
+| `http.response.header.` | string[] | 
HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [4] | `http.response.header.content-type=["application/json"]`; `http.response.header.my-custom-header=["abc", "def"]` |
+| `http.response.status_code` | int | 
[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` |
+| `http.route` | string | 
The matched route, that is, the path template in the format used by the respective server framework. [5] | `/users/:userID?`; `{controller}/{action}/{id?}` |
**[1]:** Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information.
The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended.
@@ -67,6 +67,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
| Attribute | Type | Description | Examples |
|---|---|---|---|
+| `http.flavor` | string | Deprecated, use `network.protocol.name` instead. | `1.0` |
| `http.method` | string | Deprecated, use `http.request.method` instead. | `GET`; `POST`; `HEAD` |
| `http.request_content_length` | int | Deprecated, use `http.request.header.content-length` instead. | `3495` |
| `http.response_content_length` | int | Deprecated, use `http.response.header.content-length` instead. | `3495` |
@@ -74,4 +75,16 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
| `http.status_code` | int | Deprecated, use `http.response.status_code` instead. | `200` |
| `http.target` | string | Deprecated, use `url.path` and `url.query` instead. | `/search?q=OpenTelemetry#SemConv` |
| `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` |
+| `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `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` |
+
+`http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
+
+| Value | Description |
+|---|---|
+| `1.0` | HTTP/1.0 |
+| `1.1` | HTTP/1.1 |
+| `2.0` | HTTP/2 |
+| `3.0` | HTTP/3 |
+| `SPDY` | SPDY protocol. |
+| `QUIC` | QUIC protocol. |
diff --git a/docs/attributes-registry/network.md b/docs/attributes-registry/network.md
index 3e6cb078c7..77f00acedd 100644
--- a/docs/attributes-registry/network.md
+++ b/docs/attributes-registry/network.md
@@ -16,14 +16,14 @@ These attributes may be used for any network related operation.
| `network.carrier.name` | string | The name of the mobile carrier. | `sprint` |
| `network.connection.subtype` | string | 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. | `LTE` |
| `network.connection.type` | string | The internet connection type. | `wifi` |
-| `network.local.address` | string | Local address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` |
-| `network.local.port` | int | Local port number of the network connection. | `65123` |
-| `network.peer.address` | string | Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` |
-| `network.peer.port` | int | Peer port number of the network connection. | `65123` |
-| `network.protocol.name` | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [1] | `amqp`; `http`; `mqtt` |
-| `network.protocol.version` | string | Version of the protocol specified in `network.protocol.name`. [2] | `3.1.1` |
-| `network.transport` | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [3] | `tcp`; `udp` |
-| `network.type` | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [4] | `ipv4`; `ipv6` |
+| `network.local.address` | string | 
Local address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` |
+| `network.local.port` | int | 
Local port number of the network connection. | `65123` |
+| `network.peer.address` | string | 
Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` |
+| `network.peer.port` | int | 
Peer port number of the network connection. | `65123` |
+| `network.protocol.name` | string | 
[OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [1] | `amqp`; `http`; `mqtt` |
+| `network.protocol.version` | string | 
Version of the protocol specified in `network.protocol.name`. [2] | `3.1.1` |
+| `network.transport` | string | 
[OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [3] | `tcp`; `udp` |
+| `network.type` | string | 
[OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [4] | `ipv4`; `ipv6` |
**[1]:** The value SHOULD be normalized to lowercase.
diff --git a/docs/attributes-registry/os.md b/docs/attributes-registry/os.md
new file mode 100644
index 0000000000..a813298f98
--- /dev/null
+++ b/docs/attributes-registry/os.md
@@ -0,0 +1,32 @@
+
+# OS
+
+## Operating System Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `os.build_id` | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` |
+| `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` |
+| `os.name` | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` |
+| `os.type` | string | The operating system type. | `windows` |
+| `os.version` | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` |
+
+`os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
+
+| Value | Description |
+|---|---|
+| `windows` | Microsoft Windows |
+| `linux` | Linux |
+| `darwin` | Apple Darwin |
+| `freebsd` | FreeBSD |
+| `netbsd` | NetBSD |
+| `openbsd` | OpenBSD |
+| `dragonflybsd` | DragonFly BSD |
+| `hpux` | HP-UX (Hewlett Packard Unix) |
+| `aix` | AIX (Advanced Interactive eXecutive) |
+| `solaris` | SunOS, Oracle Solaris |
+| `z_os` | IBM z/OS |
+
\ No newline at end of file
diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md
new file mode 100644
index 0000000000..5f70408a5e
--- /dev/null
+++ b/docs/attributes-registry/process.md
@@ -0,0 +1,19 @@
+
+
+# Process
+
+## Process Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `process.command` | string | 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`. | `cmd/otelcol` |
+| `process.command_args` | string[] | All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`. | `[cmd/otecol, --config=config.yaml]` |
+| `process.command_line` | string | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. | `C:\cmd\otecol --config="my directory\config.yaml"` |
+| `process.executable.name` | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` |
+| `process.executable.path` | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` |
+| `process.owner` | string | The username of the user that owns the process. | `root` |
+| `process.parent_pid` | int | Parent Process identifier (PID). | `111` |
+| `process.pid` | int | Process identifier (PID). | `1234` |
+
diff --git a/docs/attributes-registry/server.md b/docs/attributes-registry/server.md
new file mode 100644
index 0000000000..a1189591a1
--- /dev/null
+++ b/docs/attributes-registry/server.md
@@ -0,0 +1,23 @@
+
+
+# Server Attributes
+
+These attributes may be used to describe the server in a connection-based network interaction
+where there is one side that initiates the connection (the client is the side that initiates the connection).
+This covers all TCP network interactions since TCP is connection-based and one side initiates the
+connection (an exception is made for peer-to-peer communication over TCP where the "user-facing" surface of the
+protocol / API does not expose a clear notion of client and server).
+This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `server.address` | string | 
Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `example.com`; `10.1.2.80`; `/tmp/my.sock` |
+| `server.port` | int | 
Server port number. [2] | `80`; `8080`; `443` |
+
+**[1]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
+
+**[2]:** 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.
+
\ No newline at end of file
diff --git a/docs/attributes-registry/source.md b/docs/attributes-registry/source.md
new file mode 100644
index 0000000000..c239896bf1
--- /dev/null
+++ b/docs/attributes-registry/source.md
@@ -0,0 +1,21 @@
+
+
+# Source Attributes
+
+These attributes may be used to describe the sender of a network exchange/packet. These should be used
+when there is no client/server relationship between the two sides, or when that relationship is unknown.
+This covers low-level network interactions (e.g. packet tracing) where you don't know if
+there was a connection or which side initiated it.
+This also covers unidirectional UDP flows and peer-to-peer communication where the
+"user-facing" surface of the protocol / API does not expose a clear notion of client and server.
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `source.address` | string | Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `source.example.com`; `10.1.2.80`; `/tmp/my.sock` |
+| `source.port` | int | Source port number | `3389`; `2888` |
+
+**[1]:** 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.
+
\ No newline at end of file
diff --git a/docs/attributes-registry/tls.md b/docs/attributes-registry/tls.md
new file mode 100644
index 0000000000..f774c31a26
--- /dev/null
+++ b/docs/attributes-registry/tls.md
@@ -0,0 +1,49 @@
+
+
+# TLS
+
+## TLS Attributes
+
+
+| Attribute | Type | Description | Examples |
+|---|---|---|---|
+| `tls.cipher` | string | String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection. [1] | `TLS_RSA_WITH_3DES_EDE_CBC_SHA`; `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` |
+| `tls.client.certificate` | string | PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. | `MII...` |
+| `tls.client.certificate_chain` | string[] | Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. | `[MII..., MI...]` |
+| `tls.client.hash.md5` | string | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. | `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` |
+| `tls.client.hash.sha1` | string | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. | `9E393D93138888D288266C2D915214D1D1CCEB2A` |
+| `tls.client.hash.sha256` | string | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. | `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` |
+| `tls.client.issuer` | string | Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. | `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` |
+| `tls.client.ja3` | string | A hash that identifies clients based on how they perform an SSL/TLS handshake. | `d4e5b18d6b55c71272893221c96ba240` |
+| `tls.client.not_after` | string | Date/Time indicating when client certificate is no longer considered valid. | `2021-01-01T00:00:00.000Z` |
+| `tls.client.not_before` | string | Date/Time indicating when client certificate is first considered valid. | `1970-01-01T00:00:00.000Z` |
+| `tls.client.server_name` | string | Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. | `opentelemetry.io` |
+| `tls.client.subject` | string | Distinguished name of subject of the x.509 certificate presented by the client. | `CN=myclient, OU=Documentation Team, DC=example, DC=com` |
+| `tls.client.supported_ciphers` | string[] | Array of ciphers offered by the client during the client hello. | `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "..."]` |
+| `tls.curve` | string | String indicating the curve used for the given cipher, when applicable | `secp256r1` |
+| `tls.established` | boolean | Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. | `True` |
+| `tls.next_protocol` | string | String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. | `http/1.1` |
+| `tls.protocol.name` | string | Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) | `ssl` |
+| `tls.protocol.version` | string | Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) | `1.2`; `3` |
+| `tls.resumed` | boolean | Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. | `True` |
+| `tls.server.certificate` | string | PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. | `MII...` |
+| `tls.server.certificate_chain` | string[] | Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. | `[MII..., MI...]` |
+| `tls.server.hash.md5` | string | Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. | `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` |
+| `tls.server.hash.sha1` | string | Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. | `9E393D93138888D288266C2D915214D1D1CCEB2A` |
+| `tls.server.hash.sha256` | string | Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. | `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` |
+| `tls.server.issuer` | string | Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. | `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` |
+| `tls.server.ja3s` | string | A hash that identifies servers based on how they perform an SSL/TLS handshake. | `d4e5b18d6b55c71272893221c96ba240` |
+| `tls.server.not_after` | string | Date/Time indicating when server certificate is no longer considered valid. | `2021-01-01T00:00:00.000Z` |
+| `tls.server.not_before` | string | Date/Time indicating when server certificate is first considered valid. | `1970-01-01T00:00:00.000Z` |
+| `tls.server.subject` | string | Distinguished name of subject of the x.509 certificate presented by the server. | `CN=myserver, OU=Documentation Team, DC=example, DC=com` |
+
+**[1]:** The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4).
+
+`tls.protocol.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
+
+| Value | Description |
+|---|---|
+| `ssl` | ssl |
+| `tls` | tls |
+
\ No newline at end of file
diff --git a/docs/attributes-registry/url.md b/docs/attributes-registry/url.md
index f361f46e8b..5b1aa7c0d8 100644
--- a/docs/attributes-registry/url.md
+++ b/docs/attributes-registry/url.md
@@ -8,11 +8,11 @@ linkTitle: URL
| Attribute | Type | Description | Examples |
|---|---|---|---|
-| `url.fragment` | string | The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component | `SemConv` |
-| `url.full` | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [1] | `https://www.foo.bar/search?q=OpenTelemetry#SemConv`; `//localhost` |
-| `url.path` | string | The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component | `/search` |
-| `url.query` | string | The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component [2] | `q=OpenTelemetry` |
-| `url.scheme` | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `https`; `ftp`; `telnet` |
+| `url.fragment` | string | 
The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component | `SemConv` |
+| `url.full` | string | 
Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [1] | `https://www.foo.bar/search?q=OpenTelemetry#SemConv`; `//localhost` |
+| `url.path` | string | 
The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component | `/search` |
+| `url.query` | string | 
The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component [2] | `q=OpenTelemetry` |
+| `url.scheme` | string | 
The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `https`; `ftp`; `telnet` |
**[1]:** 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/`.
diff --git a/docs/attributes-registry/user-agent.md b/docs/attributes-registry/user-agent.md
index d60e19697f..589f722f87 100644
--- a/docs/attributes-registry/user-agent.md
+++ b/docs/attributes-registry/user-agent.md
@@ -8,5 +8,5 @@
| Attribute | Type | Description | Examples |
|---|---|---|---|
-| `user_agent.original` | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `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` |
+| `user_agent.original` | string | 
Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `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` |
diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md
index 92678e42c5..1d3f6471f9 100644
--- a/docs/database/database-spans.md
+++ b/docs/database/database-spans.md
@@ -71,8 +71,8 @@ Some database systems may allow a connection to switch to a different `db.user`,
| [`network.peer.port`](../attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | Recommended: If `network.peer.address` is set. |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [1] | `tcp`; `udp` | Recommended |
| [`network.type`](../attributes-registry/network.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [2] | `ipv4`; `ipv6` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Name of the database host. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| [`server.port`](../general/attributes.md) | int | Server port number. [4] | `80`; `8080`; `443` | Conditionally Required: [5] |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the database host. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`server.port`](../attributes-registry/server.md) | int | Server port number. [4] | `80`; `8080`; `443` | Conditionally Required: [5] |
**[1]:** The value SHOULD be normalized to lowercase.
diff --git a/docs/database/elasticsearch.md b/docs/database/elasticsearch.md
index 1d82327cee..0dc1a722fa 100644
--- a/docs/database/elasticsearch.md
+++ b/docs/database/elasticsearch.md
@@ -32,8 +32,8 @@ If the endpoint id is not available, the span name SHOULD be the `http.request.m
| [`db.operation`](database-spans.md) | string | The endpoint identifier for the request. [4] | `search`; `ml.close_job`; `cat.aliases` | Required |
| [`db.statement`](database-spans.md) | string | The request body for a [search-type query](https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html), as a json string. | `"{\"query\":{\"term\":{\"user.id\":\"kimchy\"}}}"` | Recommended: [5] |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [6] | `GET`; `POST`; `HEAD` | Required |
-| [`server.address`](../general/attributes.md) | string | Name of the database host. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| [`server.port`](../general/attributes.md) | int | Server port number. [8] | `80`; `8080`; `443` | Conditionally Required: [9] |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the database host. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`server.port`](../attributes-registry/server.md) | int | Server port number. [8] | `80`; `8080`; `443` | Conditionally Required: [9] |
| [`url.full`](../attributes-registry/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [10] | `https://localhost:9200/index/_search?q=user.id:kimchy` | Required |
**[1]:** When communicating with an Elastic Cloud deployment, this should be collected from the "X-Found-Handling-Cluster" HTTP response header.
diff --git a/docs/general/attributes.md b/docs/general/attributes.md
index 5f2e6a3280..e9f9dddad7 100644
--- a/docs/general/attributes.md
+++ b/docs/general/attributes.md
@@ -66,11 +66,11 @@ identify the transport, then setting [`network.transport`](#other-network-attrib
Once the HTTP semantic conventions are declared stable, changes to the attributes in this section will only be allowed
if they do not cause breaking changes to HTTP semantic conventions.
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `server.address` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| `server.port` | int | Server port number. [2] | `80`; `8080`; `443` | Recommended |
+| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`server.port`](../attributes-registry/server.md) | int | Server port number. [2] | `80`; `8080`; `443` | Recommended |
**[1]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
@@ -103,11 +103,11 @@ For Unix domain socket, `server.address` attribute represents remote endpoint ad
Once the HTTP semantic conventions are declared stable, changes to the attributes in this section will only be allowed
if they do not cause breaking changes to HTTP semantic conventions.
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `client.address` | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| `client.port` | int | Client port number. [2] | `65123` | Recommended |
+| [`client.address`](../attributes-registry/client.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`client.port`](../attributes-registry/client.md) | int | Client port number. [2] | `65123` | Recommended |
**[1]:** 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.
@@ -125,11 +125,11 @@ This also covers unidirectional UDP flows and peer-to-peer communication where t
#### Source
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `source.address` | string | Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `source.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| `source.port` | int | Source port number | `3389`; `2888` | Recommended |
+| [`source.address`](../attributes-registry/source.md) | string | Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `source.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`source.port`](../attributes-registry/source.md) | int | Source port number | `3389`; `2888` | Recommended |
**[1]:** 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.
@@ -138,11 +138,11 @@ This also covers unidirectional UDP flows and peer-to-peer communication where t
Destination fields capture details about the receiver of a network exchange/packet.
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `destination.address` | string | Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `destination.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| `destination.port` | int | Destination port number | `3389`; `2888` | Recommended |
+| [`destination.address`](../attributes-registry/destination.md) | string | Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `destination.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`destination.port`](../attributes-registry/destination.md) | int | Destination port number | `3389`; `2888` | Recommended |
**[1]:** 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.
@@ -364,14 +364,14 @@ a thread that started a span.
Examples of where `thread.id` and `thread.name` can be extracted from:
-| Language or platform | `thread.id` | `thread.name` |
-|-----------------------|----------------------------------------|------------------------------------|
-| JVM | `Thread.currentThread().getId()` | `Thread.currentThread().getName()` |
-| .NET | `Thread.CurrentThread.ManagedThreadId` | `Thread.CurrentThread.Name` |
-| Python | `threading.current_thread().ident` | `threading.current_thread().name` |
-| Ruby | `Thread.current.object_id` | `Thread.current.name` |
-| C++ | `std::this_thread::get_id()` | |
-| Erlang | `erlang:system_info(scheduler_id)` | |
+| Language or platform | `thread.id` | `thread.name` |
+|-----------------------|----------------------------------------|------------------------------------------------|
+| JVM | `Thread.currentThread().getId()` | `Thread.currentThread().getName()` |
+| .NET | `Thread.CurrentThread.ManagedThreadId` | `Thread.CurrentThread.Name` |
+| Python | `threading.current_thread().ident` | `threading.current_thread().name` |
+| Ruby | `Thread.current.object_id` | `Thread.current.name` |
+| C++ | `std::this_thread::get_id()` | |
+| Erlang | `erlang:self()` | `erlang:process_info(self(), registered_name)` |
## Source Code Attributes
@@ -389,6 +389,7 @@ about the span.
| [`code.function`](../attributes-registry/code.md) | string | The method or function name, or equivalent (usually rightmost part of the code unit's name). | `serveRequest` | Recommended |
| [`code.lineno`](../attributes-registry/code.md) | int | The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. | `42` | Recommended |
| [`code.namespace`](../attributes-registry/code.md) | string | 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. | `com.example.MyHttpService` | Recommended |
+| [`code.stacktrace`](../attributes-registry/code.md) | string | 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. | `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)` | Opt-In |
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
diff --git a/docs/http/README.md b/docs/http/README.md
index 1c27a324f4..c76f1367cb 100644
--- a/docs/http/README.md
+++ b/docs/http/README.md
@@ -7,7 +7,7 @@ path_base_for_github_subdir:
# Semantic Conventions for HTTP
-**Status**: [Experimental, Feature-freeze][DocumentStatus]
+**Status**: [Mixed][DocumentStatus]
This document defines semantic conventions for HTTP spans, metrics and logs.
They can be used for http and https schemes
diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md
index d9ee1cc417..f9cde0544c 100644
--- a/docs/http/http-metrics.md
+++ b/docs/http/http-metrics.md
@@ -4,7 +4,7 @@ linkTitle: Metrics
# Semantic Conventions for HTTP Metrics
-**Status**: [Experimental, partial feature-freeze][DocumentStatus]
+**Status**: [Mixed][DocumentStatus]
The conventions described in this section are HTTP specific. When HTTP operations occur,
metric events about those operations will be generated and reported to provide insight into the
@@ -57,7 +57,7 @@ operations. By adding HTTP attributes to metric events it allows for finely tune
### Metric: `http.server.request.duration`
-**Status**: [Experimental, Feature-freeze][DocumentStatus]
+**Status**: [Stable][DocumentStatus]
This metric is required.
@@ -76,14 +76,14 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [3] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: If and only if it's available |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [4] | `http`; `spdy` | Conditionally Required: [5] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [6] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
-| [`server.port`](../general/attributes.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
+| [`server.port`](../attributes-registry/server.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. [9] | `http`; `https` | Required |
**[1]:** If the request fails with an error before response status code was sent or received,
@@ -177,8 +177,8 @@ This metric is optional.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [1] | `GET`; `POST`; `HEAD` | Required |
-| [`server.address`](../general/attributes.md) | string | Name of the local HTTP server that received the request. [2] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
-| [`server.port`](../general/attributes.md) | int | Port of the local HTTP server that received the request. [3] | `80`; `8080`; `443` | Opt-In |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the local HTTP server that received the request. [2] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
+| [`server.port`](../attributes-registry/server.md) | int | Port of the local HTTP server that received the request. [3] | `80`; `8080`; `443` | Opt-In |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | Required |
**[1]:** HTTP request method value SHOULD be "known" to the instrumentation.
@@ -239,14 +239,14 @@ This metric is optional.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [3] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: If and only if it's available |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [4] | `http`; `spdy` | Conditionally Required: [5] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [6] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
-| [`server.port`](../general/attributes.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
+| [`server.port`](../attributes-registry/server.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. [9] | `http`; `https` | Required |
**[1]:** If the request fails with an error before response status code was sent or received,
@@ -341,14 +341,14 @@ This metric is optional.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [3] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: If and only if it's available |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [4] | `http`; `spdy` | Conditionally Required: [5] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [6] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
-| [`server.port`](../general/attributes.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the local HTTP server that received the request. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Opt-In |
+| [`server.port`](../attributes-registry/server.md) | int | Port of the local HTTP server that received the request. [8] | `80`; `8080`; `443` | Opt-In |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. [9] | `http`; `https` | Required |
**[1]:** If the request fails with an error before response status code was sent or received,
@@ -430,7 +430,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
### Metric: `http.client.request.duration`
-**Status**: [Experimental, Feature-freeze][DocumentStatus]
+**Status**: [Stable][DocumentStatus]
This metric is required.
@@ -449,13 +449,13 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [3] | `http`; `spdy` | Conditionally Required: [4] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [5] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
-| [`server.port`](../general/attributes.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
+| [`server.address`](../attributes-registry/server.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
+| [`server.port`](../attributes-registry/server.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | Opt-In |
**[1]:** If the request fails with an error before response status code was sent or received,
@@ -539,13 +539,13 @@ This metric is optional.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [3] | `http`; `spdy` | Conditionally Required: [4] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [5] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
-| [`server.port`](../general/attributes.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
+| [`server.address`](../attributes-registry/server.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
+| [`server.port`](../attributes-registry/server.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | Opt-In |
**[1]:** If the request fails with an error before response status code was sent or received,
@@ -629,13 +629,13 @@ This metric is optional.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.response.status_code`](../attributes-registry/http.md) | int | [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). | `200` | Conditionally Required: If and only if one was received/sent. |
| [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [3] | `http`; `spdy` | Conditionally Required: [4] |
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [5] | `1.0`; `1.1`; `2`; `3` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
-| [`server.port`](../general/attributes.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
+| [`server.address`](../attributes-registry/server.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
+| [`server.port`](../attributes-registry/server.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [7] | `80`; `8080`; `443` | Required |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | Opt-In |
**[1]:** If the request fails with an error before response status code was sent or received,
diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md
index ac682e6b4c..a991bf0984 100644
--- a/docs/http/http-spans.md
+++ b/docs/http/http-spans.md
@@ -4,7 +4,7 @@ linkTitle: Spans
# Semantic Conventions for HTTP Spans
-**Status**: [Experimental, Feature-freeze][DocumentStatus]
+**Status**: [Stable][DocumentStatus]
This document defines semantic conventions for HTTP client and server Spans.
They can be used for http and https schemes
@@ -118,7 +118,7 @@ sections below.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `error.type` | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
+| [`error.type`](../attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | Conditionally Required: If request has ended with an error. |
| [`http.request.method`](../attributes-registry/http.md) | string | HTTP request method. [2] | `GET`; `POST`; `HEAD` | Required |
| [`http.request.method_original`](../attributes-registry/http.md) | string | Original HTTP method sent by the client in the request line. | `GeT`; `ACL`; `foo` | Conditionally Required: [3] |
| [`http.response.header.`](../attributes-registry/http.md) | string[] | HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [4] | `http.response.header.content-type=["application/json"]`; `http.response.header.my-custom-header=["abc", "def"]` | Opt-In |
@@ -229,8 +229,8 @@ For an HTTP client span, `SpanKind` MUST be `Client`.
|---|---|---|---|---|
| [`http.request.header.`](../attributes-registry/http.md) | string[] | HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [1] | `http.request.header.content-type=["application/json"]`; `http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]` | Opt-In |
| [`http.request.resend_count`](../attributes-registry/http.md) | int | The ordinal number of request resending attempt (for any reason, including redirects). [2] | `3` | Recommended: if and only if request was retried. |
-| [`server.address`](../general/attributes.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
-| [`server.port`](../general/attributes.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [4] | `80`; `8080`; `443` | Required |
+| [`server.address`](../attributes-registry/server.md) | string | Host identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [3] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
+| [`server.port`](../attributes-registry/server.md) | int | Port identifier of the ["URI origin"](https://www.rfc-editor.org/rfc/rfc9110.html#name-uri-origin) HTTP request is sent to. [4] | `80`; `8080`; `443` | Required |
| [`url.full`](../attributes-registry/url.md) | string | Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) [5] | `https://www.foo.bar/search?q=OpenTelemetry#SemConv`; `//localhost` | Required |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | Opt-In |
| [`user_agent.original`](../attributes-registry/user-agent.md) | string | Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client. | `CERN-LineMode/2.15 libwww/2.17b3`; `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` | Opt-In |
@@ -251,8 +251,8 @@ The attribute value MUST consist of either multiple header values as an array of
The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all):
-* [`server.address`](../general/attributes.md)
-* [`server.port`](../general/attributes.md)
+* [`server.address`](../attributes-registry/server.md)
+* [`server.port`](../attributes-registry/server.md)
* [`url.full`](../attributes-registry/url.md)
@@ -339,14 +339,14 @@ For an HTTP server span, `SpanKind` MUST be `Server`.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| [`client.address`](../general/attributes.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `83.164.160.102` | Recommended |
-| [`client.port`](../general/attributes.md) | int | The port of whichever client was captured in `client.address`. [2] | `65123` | Opt-In |
+| [`client.address`](../attributes-registry/client.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `83.164.160.102` | Recommended |
+| [`client.port`](../attributes-registry/client.md) | int | The port of whichever client was captured in `client.address`. [2] | `65123` | Opt-In |
| [`http.request.header.`](../attributes-registry/http.md) | string[] | HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. [3] | `http.request.header.content-type=["application/json"]`; `http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]` | Opt-In |
| [`http.route`](../attributes-registry/http.md) | string | The matched route, that is, the path template in the format used by the respective server framework. [4] | `/users/:userID?`; `{controller}/{action}/{id?}` | Conditionally Required: If and only if it's available |
| [`network.local.address`](../attributes-registry/network.md) | string | Local socket address. Useful in case of a multi-IP host. | `10.1.2.80`; `/tmp/my.sock` | Opt-In |
| [`network.local.port`](../attributes-registry/network.md) | int | Local socket port. Useful in case of a multi-port host. | `65123` | Opt-In |
-| [`server.address`](../general/attributes.md) | string | Name of the local HTTP server that received the request. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| [`server.port`](../general/attributes.md) | int | Port of the local HTTP server that received the request. [6] | `80`; `8080`; `443` | Conditionally Required: If `server.address` is set. |
+| [`server.address`](../attributes-registry/server.md) | string | Name of the local HTTP server that received the request. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`server.port`](../attributes-registry/server.md) | int | Port of the local HTTP server that received the request. [6] | `80`; `8080`; `443` | Conditionally Required: If `server.address` is set. |
| [`url.path`](../attributes-registry/url.md) | string | The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component | `/search` | Required |
| [`url.query`](../attributes-registry/url.md) | string | The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component [7] | `q=OpenTelemetry` | Conditionally Required: If and only if one was received/sent. |
| [`url.scheme`](../attributes-registry/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. [8] | `http`; `https` | Required |
@@ -373,10 +373,10 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all):
-* [`client.address`](../general/attributes.md)
+* [`client.address`](../attributes-registry/client.md)
* [`http.request.header.`](../attributes-registry/http.md)
-* [`server.address`](../general/attributes.md)
-* [`server.port`](../general/attributes.md)
+* [`server.address`](../attributes-registry/server.md)
+* [`server.port`](../attributes-registry/server.md)
* [`url.path`](../attributes-registry/url.md)
* [`url.query`](../attributes-registry/url.md)
* [`url.scheme`](../attributes-registry/url.md)
diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md
index 594787a799..fa95e8c3b2 100644
--- a/docs/messaging/messaging-spans.md
+++ b/docs/messaging/messaging-spans.md
@@ -294,7 +294,7 @@ messages were received). For each message it accounts for, the "Deliver" or
| [`network.protocol.version`](../attributes-registry/network.md) | string | Version of the protocol specified in `network.protocol.name`. [17] | `3.1.1` | Recommended |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [18] | `tcp`; `udp` | Recommended |
| [`network.type`](../attributes-registry/network.md) | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [19] | `ipv4`; `ipv6` | Recommended |
-| [`server.address`](../general/attributes.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [20] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Conditionally Required: If available. |
+| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [20] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Conditionally Required: If available. |
**[1]:** Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs.
diff --git a/docs/resource/deployment-environment.md b/docs/resource/deployment-environment.md
index e9ff217754..faba4a47d9 100644
--- a/docs/resource/deployment-environment.md
+++ b/docs/resource/deployment-environment.md
@@ -9,7 +9,15 @@
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `deployment.environment` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). | `staging`; `production` | Recommended |
+| `deployment.environment` | string | Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). [1] | `staging`; `production` | Recommended |
+
+**[1]:** `deployment.environment` does not affect the uniqueness constraints defined through
+the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
+This implies that resources carrying the following attribute combinations MUST be
+considered to be identifying the same service:
+
+* `service.name=frontend`, `deployment.environment=production`
+* `service.name=frontend`, `deployment.environment=staging`.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
diff --git a/docs/resource/device.md b/docs/resource/device.md
index cfbaf9d82d..57bd6dea97 100644
--- a/docs/resource/device.md
+++ b/docs/resource/device.md
@@ -9,18 +9,18 @@
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `device.id` | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | Recommended |
-| `device.manufacturer` | string | The name of the device manufacturer [2] | `Apple`; `Samsung` | Recommended |
-| `device.model.identifier` | string | The model identifier for the device [3] | `iPhone3,4`; `SM-G920F` | Recommended |
-| `device.model.name` | string | The marketing name for the device model [4] | `iPhone 6s Plus`; `Samsung Galaxy S6` | Recommended |
+| [`device.id`](../attributes-registry/device.md) | string | A unique identifier representing the device [1] | `2ab2916d-a51f-4ac8-80ee-45ac31a28092` | Recommended |
+| [`device.manufacturer`](../attributes-registry/device.md) | string | The name of the device manufacturer [2] | `Apple`; `Samsung` | Recommended |
+| [`device.model.identifier`](../attributes-registry/device.md) | string | The model identifier for the device [3] | `iPhone3,4`; `SM-G920F` | Recommended |
+| [`device.model.name`](../attributes-registry/device.md) | string | The marketing name for the device model [4] | `iPhone 6s Plus`; `Samsung Galaxy S6` | Recommended |
**[1]:** The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence.
**[2]:** The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
-**[3]:** It's recommended this value represents a machine readable version of the model identifier rather than the market or consumer-friendly name of the device.
+**[3]:** It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device.
-**[4]:** It's recommended this value represents a human readable version of the device model rather than a machine readable alternative.
+**[4]:** It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/document-status.md
diff --git a/docs/resource/host.md b/docs/resource/host.md
index f7e2286af5..a11c735b86 100644
--- a/docs/resource/host.md
+++ b/docs/resource/host.md
@@ -9,18 +9,18 @@
The `host.*` namespace SHOULD be exclusively used to capture resource attributes.
To report host metrics, the `system.*` namespace SHOULD be used.
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `host.arch` | string | The CPU architecture the host system is running on. | `amd64` | Recommended |
-| `host.id` | string | 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. | `fdbf79e8af94cb7f9e8df36789187052` | Recommended |
-| `host.image.id` | string | VM image ID or host OS image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` | Recommended |
-| `host.image.name` | string | Name of the VM image or OS install the host was instantiated from. | `infra-ami-eks-worker-node-7d4ec78312`; `CentOS-8-x86_64-1905` | Recommended |
-| `host.image.version` | string | The version string of the VM image or host OS as defined in [Version Attributes](README.md#version-attributes). | `0.1` | Recommended |
-| `host.ip` | string[] | Available IP addresses of the host, excluding loopback interfaces. [1] | `[192.168.1.140, fe80::abc2:4a28:737a:609e]` | Opt-In |
-| `host.mac` | string[] | Available MAC addresses of the host, excluding loopback interfaces. [2] | `[AC-DE-48-23-45-67, AC-DE-48-23-45-67-01-9F]` | Opt-In |
-| `host.name` | string | 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. | `opentelemetry-test` | Recommended |
-| `host.type` | string | Type of host. For Cloud, this must be the machine type. | `n1-standard-1` | Recommended |
+| [`host.arch`](../attributes-registry/host.md) | string | The CPU architecture the host system is running on. | `amd64` | Recommended |
+| [`host.id`](../attributes-registry/host.md) | string | 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. | `fdbf79e8af94cb7f9e8df36789187052` | Recommended |
+| [`host.image.id`](../attributes-registry/host.md) | string | VM image ID or host OS image ID. For Cloud, this value is from the provider. | `ami-07b06b442921831e5` | Recommended |
+| [`host.image.name`](../attributes-registry/host.md) | string | Name of the VM image or OS install the host was instantiated from. | `infra-ami-eks-worker-node-7d4ec78312`; `CentOS-8-x86_64-1905` | Recommended |
+| [`host.image.version`](../attributes-registry/host.md) | string | The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `0.1` | Recommended |
+| [`host.ip`](../attributes-registry/host.md) | string[] | Available IP addresses of the host, excluding loopback interfaces. [1] | `[192.168.1.140, fe80::abc2:4a28:737a:609e]` | Opt-In |
+| [`host.mac`](../attributes-registry/host.md) | string[] | Available MAC addresses of the host, excluding loopback interfaces. [2] | `[AC-DE-48-23-45-67, AC-DE-48-23-45-67-01-9F]` | Opt-In |
+| [`host.name`](../attributes-registry/host.md) | string | 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. | `opentelemetry-test` | Recommended |
+| [`host.type`](../attributes-registry/host.md) | string | Type of host. For Cloud, this must be the machine type. | `n1-standard-1` | Recommended |
**[1]:** IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format.
@@ -45,12 +45,12 @@ To report host metrics, the `system.*` namespace SHOULD be used.
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `host.cpu.cache.l2.size` | int | The amount of level 2 memory cache available to the processor (in Bytes). | `12288000` | Opt-In |
-| `host.cpu.family` | int | Numeric value specifying the family or generation of the CPU. | `6` | Opt-In |
-| `host.cpu.model.id` | int | Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. | `6` | Opt-In |
-| `host.cpu.model.name` | string | Model designation of the processor. | `11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz` | Opt-In |
-| `host.cpu.stepping` | int | Stepping or core revisions. | `1` | Opt-In |
-| `host.cpu.vendor.id` | string | Processor manufacturer identifier. A maximum 12-character string. [1] | `GenuineIntel` | Opt-In |
+| [`host.cpu.cache.l2.size`](../attributes-registry/host.md) | int | The amount of level 2 memory cache available to the processor (in Bytes). | `12288000` | Opt-In |
+| [`host.cpu.family`](../attributes-registry/host.md) | string | Family or generation of the CPU. | `6`; `PA-RISC 1.1e` | Opt-In |
+| [`host.cpu.model.id`](../attributes-registry/host.md) | string | Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. | `6`; `9000/778/B180L` | Opt-In |
+| [`host.cpu.model.name`](../attributes-registry/host.md) | string | Model designation of the processor. | `11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz` | Opt-In |
+| [`host.cpu.stepping`](../attributes-registry/host.md) | int | Stepping or core revisions. | `1` | Opt-In |
+| [`host.cpu.vendor.id`](../attributes-registry/host.md) | string | Processor manufacturer identifier. A maximum 12-character string. [1] | `GenuineIntel` | Opt-In |
**[1]:** [CPUID](https://wiki.osdev.org/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.
diff --git a/docs/resource/os.md b/docs/resource/os.md
index 542b61ad2a..4b681018d9 100644
--- a/docs/resource/os.md
+++ b/docs/resource/os.md
@@ -8,14 +8,14 @@
In case of virtualized environments, this is the operating system as it is observed by the process, i.e., the virtualized guest rather than the underlying host.
-
+
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `os.build_id` | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | Recommended |
-| `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | Recommended |
-| `os.name` | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | Recommended |
-| `os.type` | string | The operating system type. | `windows` | Required |
-| `os.version` | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | Recommended |
+| [`os.build_id`](../attributes-registry/os.md) | string | Unique identifier for a particular build or compilation of the operating system. | `TQ3C.230805.001.B2`; `20E247`; `22621` | Recommended |
+| [`os.description`](../attributes-registry/os.md) | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | Recommended |
+| [`os.name`](../attributes-registry/os.md) | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | Recommended |
+| [`os.type`](../attributes-registry/os.md) | string | The operating system type. | `windows` | Required |
+| [`os.version`](../attributes-registry/os.md) | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | Recommended |
`os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
diff --git a/docs/resource/process.md b/docs/resource/process.md
index 737c4aca68..e2c77194e9 100644
--- a/docs/resource/process.md
+++ b/docs/resource/process.md
@@ -27,22 +27,22 @@
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `process.command` | string | 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`. | `cmd/otelcol` | Conditionally Required: See alternative attributes below. |
-| `process.command_args` | string[] | All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`. | `[cmd/otecol, --config=config.yaml]` | Conditionally Required: See alternative attributes below. |
-| `process.command_line` | string | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. | `C:\cmd\otecol --config="my directory\config.yaml"` | Conditionally Required: See alternative attributes below. |
-| `process.executable.name` | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` | Conditionally Required: See alternative attributes below. |
-| `process.executable.path` | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` | Conditionally Required: See alternative attributes below. |
-| `process.owner` | string | The username of the user that owns the process. | `root` | Recommended |
-| `process.parent_pid` | int | Parent Process identifier (PID). | `111` | Recommended |
-| `process.pid` | int | Process identifier (PID). | `1234` | Recommended |
+| [`process.command`](../attributes-registry/process.md) | string | 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`. | `cmd/otelcol` | Conditionally Required: See alternative attributes below. |
+| [`process.command_args`](../attributes-registry/process.md) | string[] | All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`. | `[cmd/otecol, --config=config.yaml]` | Conditionally Required: See alternative attributes below. |
+| [`process.command_line`](../attributes-registry/process.md) | string | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. | `C:\cmd\otecol --config="my directory\config.yaml"` | Conditionally Required: See alternative attributes below. |
+| [`process.executable.name`](../attributes-registry/process.md) | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` | Conditionally Required: See alternative attributes below. |
+| [`process.executable.path`](../attributes-registry/process.md) | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` | Conditionally Required: See alternative attributes below. |
+| [`process.owner`](../attributes-registry/process.md) | string | The username of the user that owns the process. | `root` | Recommended |
+| [`process.parent_pid`](../attributes-registry/process.md) | int | Parent Process identifier (PID). | `111` | Recommended |
+| [`process.pid`](../attributes-registry/process.md) | int | Process identifier (PID). | `1234` | Recommended |
**Additional attribute requirements:** At least one of the following sets of attributes is required:
-* `process.executable.name`
-* `process.executable.path`
-* `process.command`
-* `process.command_line`
-* `process.command_args`
+* [`process.executable.name`](../attributes-registry/process.md)
+* [`process.executable.path`](../attributes-registry/process.md)
+* [`process.command`](../attributes-registry/process.md)
+* [`process.command_line`](../attributes-registry/process.md)
+* [`process.command_args`](../attributes-registry/process.md)
Between `process.command_args` and `process.command_line`, usually `process.command_args` should be preferred.
diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md
index 4821b500e7..5e28b81bdc 100644
--- a/docs/rpc/rpc-metrics.md
+++ b/docs/rpc/rpc-metrics.md
@@ -225,8 +225,8 @@ measurements.
| [`rpc.method`](../attributes-registry/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [3] | `exampleMethod` | Recommended |
| [`rpc.service`](../attributes-registry/rpc.md) | string | The full (logical) name of the service being called, including its package name, if applicable. [4] | `myservice.EchoService` | Recommended |
| [`rpc.system`](../attributes-registry/rpc.md) | string | A string identifying the remoting system. See below for a list of well-known identifiers. | `grpc` | Required |
-| [`server.address`](../general/attributes.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| [`server.port`](../general/attributes.md) | int | Server port number. [6] | `80`; `8080`; `443` | Recommended |
+| [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`server.port`](../attributes-registry/server.md) | int | Server port number. [6] | `80`; `8080`; `443` | Recommended |
**[1]:** The value SHOULD be normalized to lowercase.
diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md
index e65c6844ed..7e50888583 100644
--- a/docs/rpc/rpc-spans.md
+++ b/docs/rpc/rpc-spans.md
@@ -90,8 +90,8 @@ Examples of span names:
| [`rpc.method`](../attributes-registry/rpc.md) | string | The name of the (logical) method being called, must be equal to the $method part in the span name. [3] | `exampleMethod` | Recommended |
| [`rpc.service`](../attributes-registry/rpc.md) | string | The full (logical) name of the service being called, including its package name, if applicable. [4] | `myservice.EchoService` | Recommended |
| [`rpc.system`](../attributes-registry/rpc.md) | string | A string identifying the remoting system. See below for a list of well-known identifiers. | `grpc` | Required |
-| [`server.address`](../general/attributes.md) | string | RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
-| [`server.port`](../general/attributes.md) | int | Server port number. [6] | `80`; `8080`; `443` | Conditionally Required: [7] |
+| [`server.address`](../attributes-registry/server.md) | string | RPC server [host name](https://grpc.github.io/grpc/core/md_doc_naming.html). [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Required |
+| [`server.port`](../attributes-registry/server.md) | int | Server port number. [6] | `80`; `8080`; `443` | Conditionally Required: [7] |
**[1]:** The value SHOULD be normalized to lowercase.
@@ -166,8 +166,8 @@ Generally, a user SHOULD NOT set `peer.service` to a fully qualified RPC service
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| [`client.address`](../general/attributes.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
-| [`client.port`](../general/attributes.md) | int | Client port number. [2] | `65123` | Recommended |
+| [`client.address`](../attributes-registry/client.md) | string | Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1] | `client.example.com`; `10.1.2.80`; `/tmp/my.sock` | Recommended |
+| [`client.port`](../attributes-registry/client.md) | int | Client port number. [2] | `65123` | Recommended |
| [`network.peer.address`](../attributes-registry/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. | `10.1.2.80`; `/tmp/my.sock` | Recommended |
| [`network.peer.port`](../attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | Recommended: If `network.peer.address` is set. |
| [`network.transport`](../attributes-registry/network.md) | string | [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). [3] | `tcp`; `udp` | Recommended |
diff --git a/docs/runtime/jvm-metrics.md b/docs/runtime/jvm-metrics.md
index f36246c653..4e7825c857 100644
--- a/docs/runtime/jvm-metrics.md
+++ b/docs/runtime/jvm-metrics.md
@@ -163,7 +163,7 @@ This metric is obtained by subscribing to
This metric SHOULD be specified with
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.26.0/specification/metrics/api.md#instrument-advisory-parameters)
-of `[]` (single bucket histogram capturing count, sum, min, max).
+of `[ 0.01, 0.1, 1, 10 ]`.
| Name | Instrument Type | Unit (UCUM) | Description |
diff --git a/model/general.yaml b/model/general.yaml
index cfcce21cef..e3bad3d46a 100644
--- a/model/general.yaml
+++ b/model/general.yaml
@@ -1,4 +1,32 @@
groups:
+ - id: general.client
+ type: attribute_group
+ brief: >
+ General client attributes.
+ attributes:
+ - ref: client.address
+ - ref: client.port
+ - id: general.server
+ type: attribute_group
+ brief: >
+ General server attributes.
+ attributes:
+ - ref: server.address
+ - ref: server.port
+ - id: general.source
+ type: attribute_group
+ brief: >
+ General source attributes.
+ attributes:
+ - ref: source.address
+ - ref: source.port
+ - id: general.destination
+ type: attribute_group
+ brief: >
+ General destination attributes.
+ attributes:
+ - ref: destination.address
+ - ref: destination.port
- id: peer
prefix: peer
type: span
@@ -53,3 +81,5 @@ groups:
- ref: code.filepath
- ref: code.lineno
- ref: code.column
+ - ref: code.stacktrace
+ requirement_level: opt_in
diff --git a/model/client.yaml b/model/registry/client.yaml
similarity index 96%
rename from model/client.yaml
rename to model/registry/client.yaml
index 0e133f0e4c..bd214a1708 100644
--- a/model/client.yaml
+++ b/model/registry/client.yaml
@@ -11,6 +11,7 @@ groups:
This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
attributes:
- id: address
+ stability: stable
type: string
brief: "Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name."
note: >
@@ -18,6 +19,7 @@ groups:
the client address behind any intermediaries, for example proxies, if it's available.
examples: ['client.example.com', '10.1.2.80', '/tmp/my.sock']
- id: port
+ stability: stable
type: int
brief: Client port number.
examples: [65123]
diff --git a/model/registry/code.yaml b/model/registry/code.yaml
index 373a4bc6c3..d5afceeaed 100644
--- a/model/registry/code.yaml
+++ b/model/registry/code.yaml
@@ -31,3 +31,11 @@ groups:
brief: >
The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`.
examples: 16
+ - id: stacktrace
+ type: string
+ brief: >
+ 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.
+ examples: '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)'
diff --git a/model/registry/deprecated/http.yaml b/model/registry/deprecated/http.yaml
index de45180bbd..9150328629 100644
--- a/model/registry/deprecated/http.yaml
+++ b/model/registry/deprecated/http.yaml
@@ -39,3 +39,33 @@ groups:
brief: 'Deprecated, use `http.response.header.content-length` instead.'
stability: deprecated
examples: 3495
+ - id: flavor
+ type:
+ allow_custom_values: true
+ members:
+ - id: http_1_0
+ value: '1.0'
+ brief: 'HTTP/1.0'
+ - id: http_1_1
+ value: '1.1'
+ brief: 'HTTP/1.1'
+ - id: http_2_0
+ value: '2.0'
+ brief: 'HTTP/2'
+ - id: http_3_0
+ value: '3.0'
+ brief: 'HTTP/3'
+ - id: spdy
+ value: 'SPDY'
+ brief: 'SPDY protocol.'
+ - id: quic
+ value: 'QUIC'
+ brief: 'QUIC protocol.'
+ brief: 'Deprecated, use `network.protocol.name` instead.'
+ stability: deprecated
+ - id: user_agent
+ type: string
+ brief: 'Deprecated, use `user_agent.original` instead.'
+ examples: ['CERN-LineMode/2.15 libwww/2.17b3',
+ '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']
+ stability: deprecated
diff --git a/model/destination.yaml b/model/registry/destination.yaml
similarity index 90%
rename from model/destination.yaml
rename to model/registry/destination.yaml
index 30d155ce56..595a1c67f9 100644
--- a/model/destination.yaml
+++ b/model/registry/destination.yaml
@@ -2,7 +2,8 @@ groups:
- id: destination
prefix: destination
type: attribute_group
- brief: These attributes may be used to describe the receiver of a network exchange/packet. These should be used
+ brief: >
+ These attributes may be used to describe the receiver of a network exchange/packet. These should be used
when there is no client/server relationship between the two sides, or when that relationship is unknown.
This covers low-level network interactions (e.g. packet tracing) where you don't know if
there was a connection or which side initiated it.
diff --git a/model/registry/device.yaml b/model/registry/device.yaml
new file mode 100644
index 0000000000..c109981f11
--- /dev/null
+++ b/model/registry/device.yaml
@@ -0,0 +1,46 @@
+groups:
+ - id: registry.device
+ prefix: device
+ type: attribute_group
+ brief: >
+ Describes device attributes.
+ attributes:
+ - id: id
+ type: string
+ brief: >
+ A unique identifier representing the device
+ note: >
+ The device identifier MUST only be defined using the values outlined below. This value is not an advertising
+ identifier and MUST NOT be used as such.
+ On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
+ On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique
+ UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids)
+ on best practices and exact implementation details.
+ Caution should be taken when storing personal data or anything which can identify a user. GDPR and
+ data protection laws may apply, ensure you do your own due diligence.
+ examples: ['2ab2916d-a51f-4ac8-80ee-45ac31a28092']
+ - id: manufacturer
+ type: string
+ brief: >
+ The name of the device manufacturer
+ note: >
+ The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER).
+ iOS apps SHOULD hardcode the value `Apple`.
+ examples: ['Apple', 'Samsung']
+ - id: model.identifier
+ type: string
+ brief: >
+ The model identifier for the device
+ note: >
+ It's recommended this value represents a machine-readable version of
+ the model identifier rather than the market or consumer-friendly name
+ of the device.
+ examples: ['iPhone3,4', 'SM-G920F']
+ - id: model.name
+ type: string
+ brief: >
+ The marketing name for the device model
+ note: >
+ It's recommended this value represents a human-readable version of the
+ device model rather than a machine-readable alternative.
+ examples: ['iPhone 6s Plus', 'Samsung Galaxy S6']
diff --git a/model/error.yaml b/model/registry/error.yaml
similarity index 67%
rename from model/error.yaml
rename to model/registry/error.yaml
index a86b33408a..683012e361 100644
--- a/model/error.yaml
+++ b/model/registry/error.yaml
@@ -1,19 +1,21 @@
groups:
- - id: error
+ - id: registry.error
type: attribute_group
prefix: error
brief: >
- This document defines the shared attributes used to
- report an error.
+ This document defines the shared attributes used to report an error.
attributes:
- id: type
- brief: 'Describes a class of error the operation ended with.'
+ stability: stable
+ brief: >
+ Describes a class of error the operation ended with.
type:
allow_custom_values: true
members:
- id: other
value: "_OTHER"
- brief: "A fallback error value to be used when the instrumentation doesn't define a custom value."
+ brief: >
+ A fallback error value to be used when the instrumentation doesn't define a custom value.
examples: ['timeout', 'java.net.UnknownHostException', 'server_certificate_invalid', '500']
note: |
The `error.type` SHOULD be predictable and SHOULD have low cardinality.
@@ -28,5 +30,6 @@ groups:
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.
+
+ * 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.
diff --git a/model/registry/host.yaml b/model/registry/host.yaml
new file mode 100644
index 0000000000..fed665548e
--- /dev/null
+++ b/model/registry/host.yaml
@@ -0,0 +1,122 @@
+groups:
+ - id: registry.host
+ prefix: host
+ type: attribute_group
+ brief: >
+ A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
+ attributes:
+ - id: id
+ type: string
+ brief: >
+ 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.
+ examples: ['fdbf79e8af94cb7f9e8df36789187052']
+ - id: name
+ type: string
+ brief: >
+ 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.
+ examples: ['opentelemetry-test']
+ - id: type
+ type: string
+ brief: >
+ Type of host. For Cloud, this must be the machine type.
+ examples: ['n1-standard-1']
+ - id: arch
+ type:
+ allow_custom_values: true
+ members:
+ - id: amd64
+ value: 'amd64'
+ brief: "AMD64"
+ - id: arm32
+ value: 'arm32'
+ brief: "ARM32"
+ - id: arm64
+ value: 'arm64'
+ brief: "ARM64"
+ - id: ia64
+ value: 'ia64'
+ brief: "Itanium"
+ - id: ppc32
+ value: 'ppc32'
+ brief: "32-bit PowerPC"
+ - id: ppc64
+ value: 'ppc64'
+ brief: "64-bit PowerPC"
+ - id: s390x
+ value: 's390x'
+ brief: "IBM z/Architecture"
+ - id: x86
+ value: 'x86'
+ brief: "32-bit x86"
+ brief: >
+ The CPU architecture the host system is running on.
+ - id: image.name
+ type: string
+ brief: >
+ Name of the VM image or OS install the host was instantiated from.
+ examples: ['infra-ami-eks-worker-node-7d4ec78312', 'CentOS-8-x86_64-1905']
+ - id: image.id
+ type: string
+ brief: >
+ VM image ID or host OS image ID. For Cloud, this value is from the provider.
+ examples: ['ami-07b06b442921831e5']
+ - id: image.version
+ type: string
+ brief: >
+ The version string of the VM image or host OS as defined in
+ [Version Attributes](/docs/resource/README.md#version-attributes).
+ examples: ['0.1']
+ - id: ip
+ type: string[]
+ brief: >
+ Available IP addresses of the host, excluding loopback interfaces.
+ note: >
+ IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses
+ MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format.
+ examples: ["192.168.1.140", "fe80::abc2:4a28:737a:609e"]
+ - id: mac
+ type: string[]
+ brief: >
+ Available MAC addresses of the host, excluding loopback interfaces.
+ note: >
+ MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf):
+ as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
+ examples: ['AC-DE-48-23-45-67', 'AC-DE-48-23-45-67-01-9F']
+ - id: cpu.vendor.id
+ type: string
+ brief: >
+ Processor manufacturer identifier. A maximum 12-character string.
+ note: >
+ [CPUID](https://wiki.osdev.org/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.
+ examples: [ 'GenuineIntel' ]
+ - id: cpu.family
+ type: string
+ brief: >
+ Family or generation of the CPU.
+ examples: [ '6', 'PA-RISC 1.1e' ]
+ - id: cpu.model.id
+ type: string
+ brief: >
+ Model identifier. It provides more granular information about the CPU, distinguishing it from
+ other CPUs within the same family.
+ examples: [ '6', '9000/778/B180L' ]
+ - id: cpu.model.name
+ type: string
+ brief: >
+ Model designation of the processor.
+ examples: [ '11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz' ]
+ - id: cpu.stepping
+ type: int
+ brief: >
+ Stepping or core revisions.
+ examples: [ 1 ]
+ - id: cpu.cache.l2.size
+ type: int
+ brief: >
+ The amount of level 2 memory cache available to the processor (in Bytes).
+ examples: [ 12288000 ]
diff --git a/model/registry/http.yaml b/model/registry/http.yaml
index 57a7de3ce7..2cb8e8b894 100644
--- a/model/registry/http.yaml
+++ b/model/registry/http.yaml
@@ -13,6 +13,7 @@ groups:
examples: 3495
stability: experimental # this should not be marked stable with other HTTP attributes
- id: request.header
+ stability: stable
type: template[string[]]
brief: >
HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values.
@@ -28,6 +29,7 @@ groups:
the HTTP library provides access to headers.
examples: ['http.request.header.content-type=["application/json"]', 'http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"]']
- id: request.method
+ stability: stable
type:
allow_custom_values: true
members:
@@ -79,10 +81,12 @@ groups:
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.
- id: request.method_original
+ stability: stable
type: string
brief: Original HTTP method sent by the client in the request line.
examples: ["GeT", "ACL", "foo"]
- id: request.resend_count
+ stability: stable
type: int
brief: >
The ordinal number of request resending attempt (for any reason, including redirects).
@@ -100,6 +104,7 @@ groups:
examples: 3495
stability: experimental # this should not be marked stable with other HTTP attributes
- id: response.header
+ stability: stable
type: template[string[]]
brief: >
HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values.
@@ -114,10 +119,12 @@ groups:
the HTTP library provides access to headers.
examples: ['http.response.header.content-type=["application/json"]', 'http.response.header.my-custom-header=["abc", "def"]']
- id: response.status_code
+ stability: stable
type: int
brief: '[HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6).'
examples: [200]
- id: route
+ stability: stable
type: string
brief: >
The matched route, that is, the path template in the format used by the respective server framework.
diff --git a/model/registry/network.yaml b/model/registry/network.yaml
index b5ecb1efb8..27b072a08c 100644
--- a/model/registry/network.yaml
+++ b/model/registry/network.yaml
@@ -107,27 +107,33 @@ groups:
brief: 'The internet connection type.'
examples: 'wifi'
- id: local.address
+ stability: stable
type: string
brief: Local address of the network connection - IP address or Unix domain socket name.
examples: ['10.1.2.80', '/tmp/my.sock']
- id: local.port
+ stability: stable
type: int
brief: Local port number of the network connection.
examples: [65123]
- id: peer.address
+ stability: stable
type: string
brief: Peer address of the network connection - IP address or Unix domain socket name.
examples: ['10.1.2.80', '/tmp/my.sock']
- id: peer.port
+ stability: stable
type: int
brief: Peer port number of the network connection.
examples: [65123]
- id: protocol.name
+ stability: stable
type: string
brief: '[OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent.'
note: The value SHOULD be normalized to lowercase.
examples: ['amqp', 'http', 'mqtt']
- id: protocol.version
+ stability: stable
type: string
brief: Version of the protocol specified in `network.protocol.name`.
examples: '3.1.1'
@@ -136,6 +142,7 @@ groups:
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`.
- id: transport
+ stability: stable
type:
allow_custom_values: true
members:
@@ -162,6 +169,7 @@ groups:
different processes could be listening on TCP port 12345 and UDP port 12345.
examples: ['tcp', 'udp']
- id: type
+ stability: stable
type:
allow_custom_values: true
members:
diff --git a/model/registry/os.yaml b/model/registry/os.yaml
new file mode 100644
index 0000000000..af8dbfcd2a
--- /dev/null
+++ b/model/registry/os.yaml
@@ -0,0 +1,69 @@
+groups:
+ - id: registry.os
+ prefix: os
+ type: attribute_group
+ brief: >
+ The operating system (OS) on which the process represented by this resource is running.
+ note: >
+ In case of virtualized environments, this is the operating system as it is observed by
+ the process, i.e., the virtualized guest rather than the underlying host.
+ attributes:
+ - id: type
+ type:
+ allow_custom_values: true
+ members:
+ - id: windows
+ value: 'windows'
+ brief: "Microsoft Windows"
+ - id: linux
+ value: 'linux'
+ brief: "Linux"
+ - id: darwin
+ value: 'darwin'
+ brief: "Apple Darwin"
+ - id: freebsd
+ value: 'freebsd'
+ brief: "FreeBSD"
+ - id: netbsd
+ value: 'netbsd'
+ brief: "NetBSD"
+ - id: openbsd
+ value: 'openbsd'
+ brief: "OpenBSD"
+ - id: dragonflybsd
+ value: 'dragonflybsd'
+ brief: "DragonFly BSD"
+ - id: hpux
+ value: 'hpux'
+ brief: "HP-UX (Hewlett Packard Unix)"
+ - id: aix
+ value: 'aix'
+ brief: "AIX (Advanced Interactive eXecutive)"
+ - id: solaris
+ value: 'solaris'
+ brief: "SunOS, Oracle Solaris"
+ - id: z_os
+ value: 'z_os'
+ brief: "IBM z/OS"
+ brief: >
+ The operating system type.
+ - id: description
+ type: string
+ brief: >
+ Human readable (not intended to be parsed) OS version information,
+ like e.g. reported by `ver` or `lsb_release -a` commands.
+ examples: ['Microsoft Windows [Version 10.0.18363.778]', 'Ubuntu 18.04.1 LTS']
+ - id: name
+ type: string
+ brief: 'Human readable operating system name.'
+ examples: ['iOS', 'Android', 'Ubuntu']
+ - id: version
+ type: string
+ brief: >
+ The version string of the operating system as defined in
+ [Version Attributes](/docs/resource/README.md#version-attributes).
+ examples: ['14.2.1', '18.04.1']
+ - id: build_id
+ type: string
+ brief: 'Unique identifier for a particular build or compilation of the operating system.'
+ examples: ['TQ3C.230805.001.B2', '20E247', '22621']
diff --git a/model/registry/process.yaml b/model/registry/process.yaml
new file mode 100644
index 0000000000..894d09899e
--- /dev/null
+++ b/model/registry/process.yaml
@@ -0,0 +1,60 @@
+groups:
+ - id: registry.process
+ prefix: process
+ type: attribute_group
+ brief: >
+ An operating system process.
+ attributes:
+ - id: pid
+ type: int
+ brief: >
+ Process identifier (PID).
+ examples: [1234]
+ - id: parent_pid
+ type: int
+ brief: >
+ Parent Process identifier (PID).
+ examples: [111]
+ - id: executable.name
+ type: string
+ brief: >
+ The name of the process executable. On Linux based systems, can be set
+ to the `Name` in `proc/[pid]/status`. On Windows, can be set to the
+ base name of `GetProcessImageFileNameW`.
+ examples: ['otelcol']
+ - id: executable.path
+ type: string
+ brief: >
+ The full path to the process executable. On Linux based systems, can
+ be set to the target of `proc/[pid]/exe`. On Windows, can be set to the
+ result of `GetProcessImageFileNameW`.
+ examples: ['/usr/bin/cmd/otelcol']
+ - id: command
+ type: string
+ brief: >
+ 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`.
+ examples: ['cmd/otelcol']
+ - id: command_line
+ type: string
+ brief: >
+ The full command used to launch the process as a single string representing
+ the full command. On Windows, can be set to the result of `GetCommandLineW`.
+ Do not set this if you have to assemble it just for monitoring; use
+ `process.command_args` instead.
+ examples: ['C:\cmd\otecol --config="my directory\config.yaml"']
+ - id: command_args
+ type: string[]
+ brief: >
+ All the command arguments (including the command/executable itself) as
+ received by the process. On Linux-based systems (and some other Unixoid
+ systems supporting procfs), can be set according to the list of
+ null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based
+ executables, this would be the full argv vector passed to `main`.
+ examples: ['cmd/otecol', '--config=config.yaml']
+ - id: owner
+ type: string
+ brief: >
+ The username of the user that owns the process.
+ examples: 'root'
diff --git a/model/server.yaml b/model/registry/server.yaml
similarity index 96%
rename from model/server.yaml
rename to model/registry/server.yaml
index eecdc7c8db..f47174dda2 100644
--- a/model/server.yaml
+++ b/model/registry/server.yaml
@@ -11,6 +11,7 @@ groups:
This also covers UDP network interactions where one side initiates the interaction, e.g. QUIC (HTTP/3) and DNS.
attributes:
- id: address
+ stability: stable
type: string
brief: "Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name."
note: >
@@ -18,6 +19,7 @@ groups:
the server address behind any intermediaries, for example proxies, if it's available.
examples: ['example.com', '10.1.2.80', '/tmp/my.sock']
- id: port
+ stability: stable
type: int
brief: Server port number.
note: >
diff --git a/model/source.yaml b/model/registry/source.yaml
similarity index 90%
rename from model/source.yaml
rename to model/registry/source.yaml
index c142eaffec..263a491cab 100644
--- a/model/source.yaml
+++ b/model/registry/source.yaml
@@ -2,7 +2,8 @@ groups:
- id: source
prefix: source
type: attribute_group
- brief: These attributes may be used to describe the sender of a network exchange/packet. These should be used
+ brief: >
+ These attributes may be used to describe the sender of a network exchange/packet. These should be used
when there is no client/server relationship between the two sides, or when that relationship is unknown.
This covers low-level network interactions (e.g. packet tracing) where you don't know if
there was a connection or which side initiated it.
diff --git a/model/registry/tls.yaml b/model/registry/tls.yaml
new file mode 100644
index 0000000000..421479d18a
--- /dev/null
+++ b/model/registry/tls.yaml
@@ -0,0 +1,165 @@
+groups:
+ - id: registry.tls
+ prefix: tls
+ type: attribute_group
+ brief: "This document defines semantic convention attributes in the TLS namespace."
+ attributes:
+ - id: cipher
+ brief: >
+ String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection.
+ type: string
+ note: >
+ The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the
+ [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4).
+ examples:
+ [
+ "TLS_RSA_WITH_3DES_EDE_CBC_SHA",
+ "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
+ ]
+ - id: client.certificate
+ type: string
+ brief: >
+ PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list.
+ examples: ["MII..."]
+ - id: client.certificate_chain
+ type: string[]
+ brief: >
+ Array of PEM-encoded certificates that make up the certificate chain offered by the client.
+ This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain.
+ examples: ["MII...", "MI..."]
+ - id: client.hash.md5
+ type: string
+ brief: >
+ Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples: ["0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC"]
+ - id: client.hash.sha1
+ type: string
+ brief: >
+ Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples: ["9E393D93138888D288266C2D915214D1D1CCEB2A"]
+ - id: client.hash.sha256
+ type: string
+ brief: >
+ Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples:
+ ["0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0"]
+ - id: client.issuer
+ type: string
+ brief: "Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client."
+ examples:
+ ["CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com"]
+ - id: client.ja3
+ type: string
+ brief: "A hash that identifies clients based on how they perform an SSL/TLS handshake."
+ examples: ["d4e5b18d6b55c71272893221c96ba240"]
+ - id: client.not_after
+ type: string
+ brief: "Date/Time indicating when client certificate is no longer considered valid."
+ examples: ["2021-01-01T00:00:00.000Z"]
+ - id: client.not_before
+ type: string
+ brief: "Date/Time indicating when client certificate is first considered valid."
+ examples: ["1970-01-01T00:00:00.000Z"]
+ - id: client.server_name
+ type: string
+ brief: "Also called an SNI, this tells the server which hostname to which the client is attempting to connect to."
+ examples: ["opentelemetry.io"]
+ - id: client.subject
+ type: string
+ brief: "Distinguished name of subject of the x.509 certificate presented by the client."
+ examples: ["CN=myclient, OU=Documentation Team, DC=example, DC=com"]
+ - id: client.supported_ciphers
+ type: string[]
+ brief: Array of ciphers offered by the client during the client hello.
+ examples:
+ [
+ '"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "..."',
+ ]
+ - id: curve
+ brief: "String indicating the curve used for the given cipher, when applicable"
+ type: string
+ examples: ["secp256r1"]
+ - id: established
+ brief: "Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel."
+ type: boolean
+ examples: [true]
+ - id: next_protocol
+ brief: >
+ String indicating the protocol being tunneled.
+ Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids),
+ this string should be lower case.
+ type: string
+ examples: ["http/1.1"]
+ - id: protocol.name
+ brief: >
+ Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES)
+ type:
+ allow_custom_values: true
+ members:
+ - id: ssl
+ value: ssl
+ - id: tls
+ value: tls
+ - id: protocol.version
+ brief: >
+ Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES)
+ type: string
+ examples: ["1.2", "3"]
+ - id: resumed
+ brief: "Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation."
+ type: boolean
+ examples: [true]
+ - id: server.certificate
+ type: string
+ brief: >
+ PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list.
+ examples: ["MII..."]
+ - id: server.certificate_chain
+ type: string[]
+ brief: >
+ Array of PEM-encoded certificates that make up the certificate chain offered by the server.
+ This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain.
+ examples: ["MII...", "MI..."]
+ - id: server.hash.md5
+ type: string
+ brief: >
+ Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples: ["0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC"]
+ - id: server.hash.sha1
+ type: string
+ brief: >
+ Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples: ["9E393D93138888D288266C2D915214D1D1CCEB2A"]
+ - id: server.hash.sha256
+ type: string
+ brief: >
+ Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server.
+ For consistency with other hash values, this value should be formatted as an uppercase hash.
+ examples:
+ ["0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0"]
+ - id: server.issuer
+ type: string
+ brief: "Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client."
+ examples:
+ ["CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com"]
+ - id: server.ja3s
+ type: string
+ brief: "A hash that identifies servers based on how they perform an SSL/TLS handshake."
+ examples: ["d4e5b18d6b55c71272893221c96ba240"]
+ - id: server.not_after
+ type: string
+ brief: "Date/Time indicating when server certificate is no longer considered valid."
+ examples: ["2021-01-01T00:00:00.000Z"]
+ - id: server.not_before
+ type: string
+ brief: "Date/Time indicating when server certificate is first considered valid."
+ examples: ["1970-01-01T00:00:00.000Z"]
+ - id: server.subject
+ type: string
+ brief: "Distinguished name of subject of the x.509 certificate presented by the server."
+ examples: ["CN=myserver, OU=Documentation Team, DC=example, DC=com"]
diff --git a/model/registry/url.yaml b/model/registry/url.yaml
index 0e0d202720..985ca9123f 100644
--- a/model/registry/url.yaml
+++ b/model/registry/url.yaml
@@ -5,10 +5,12 @@ groups:
prefix: url
attributes:
- id: scheme
+ stability: stable
type: string
brief: 'The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.'
examples: ["https", "ftp", "telnet"]
- id: full
+ stability: stable
type: string
brief: Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
note: >
@@ -22,15 +24,18 @@ groups:
and SHOULD NOT be validated or modified except for sanitizing purposes.
examples: ['https://www.foo.bar/search?q=OpenTelemetry#SemConv', '//localhost']
- id: path
+ stability: stable
type: string
brief: 'The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component'
examples: ['/search']
- id: query
+ stability: stable
type: string
brief: 'The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component'
examples: ["q=OpenTelemetry"]
note: Sensitive content provided in query string SHOULD be scrubbed when instrumentations can identify it.
- id: fragment
+ stability: stable
type: string
brief: 'The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component'
examples: ["SemConv"]
diff --git a/model/registry/user-agent.yaml b/model/registry/user-agent.yaml
index 2b93ac114d..0fbc5c9f2a 100644
--- a/model/registry/user-agent.yaml
+++ b/model/registry/user-agent.yaml
@@ -5,6 +5,7 @@ groups:
brief: "Describes user-agent attributes."
attributes:
- id: original
+ stability: stable
type: string
brief: >
Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
diff --git a/model/resource/deployment_environment.yaml b/model/resource/deployment_environment.yaml
index 9109f6f7cb..7ada3f9798 100644
--- a/model/resource/deployment_environment.yaml
+++ b/model/resource/deployment_environment.yaml
@@ -10,4 +10,12 @@ groups:
brief: >
Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment)
(aka deployment tier).
+ note: |
+ `deployment.environment` does not affect the uniqueness constraints defined through
+ the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
+ This implies that resources carrying the following attribute combinations MUST be
+ considered to be identifying the same service:
+
+ * `service.name=frontend`, `deployment.environment=production`
+ * `service.name=frontend`, `deployment.environment=staging`.
examples: ['staging', 'production']
diff --git a/model/resource/device.yaml b/model/resource/device.yaml
index 3df0a4d6a8..8fab02a8e4 100644
--- a/model/resource/device.yaml
+++ b/model/resource/device.yaml
@@ -5,37 +5,7 @@ groups:
brief: >
The device on which the process represented by this resource is running.
attributes:
- - id: id
- type: string
- brief: 'A unique identifier representing the device'
- note: >
- The device identifier MUST only be defined using the values outlined below. This value is not an advertising
- identifier and MUST NOT be used as such.
- On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor).
- On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique
- UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids)
- on best practices and exact implementation details.
- Caution should be taken when storing personal data or anything which can identify a user. GDPR and
- data protection laws may apply, ensure you do your own due diligence.
- examples: ['2ab2916d-a51f-4ac8-80ee-45ac31a28092']
- - id: model.identifier
- type: string
- brief: 'The model identifier for the device'
- note: >
- It's recommended this value represents a machine readable version of
- the model identifier rather than the market or consumer-friendly name
- of the device.
- examples: ['iPhone3,4', 'SM-G920F']
- - id: model.name
- type: string
- brief: 'The marketing name for the device model'
- note: >
- It's recommended this value represents a human readable version of the
- device model rather than a machine readable alternative.
- examples: ['iPhone 6s Plus', 'Samsung Galaxy S6']
- - id: manufacturer
- type: string
- brief: 'The name of the device manufacturer'
- note: >
- The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
- examples: ['Apple', 'Samsung']
+ - ref: device.id
+ - ref: device.manufacturer
+ - ref: device.model.identifier
+ - ref: device.model.name
diff --git a/model/resource/host.yaml b/model/resource/host.yaml
index 9b63976db5..b90b90dcf7 100644
--- a/model/resource/host.yaml
+++ b/model/resource/host.yaml
@@ -5,89 +5,17 @@ groups:
brief: >
A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
attributes:
- - id: id
- type: string
- brief: >
- 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.
- examples: ['fdbf79e8af94cb7f9e8df36789187052']
- - id: name
- type: string
- brief: >
- 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.
- examples: ['opentelemetry-test']
- - id: type
- type: string
- brief: >
- Type of host. For Cloud, this must be the machine type.
- examples: ['n1-standard-1']
- - id: arch
- type:
- allow_custom_values: true
- members:
- - id: amd64
- value: 'amd64'
- brief: "AMD64"
- - id: arm32
- value: 'arm32'
- brief: "ARM32"
- - id: arm64
- value: 'arm64'
- brief: "ARM64"
- - id: ia64
- value: 'ia64'
- brief: "Itanium"
- - id: ppc32
- value: 'ppc32'
- brief: "32-bit PowerPC"
- - id: ppc64
- value: 'ppc64'
- brief: "64-bit PowerPC"
- - id: s390x
- value: 's390x'
- brief: "IBM z/Architecture"
- - id: x86
- value: 'x86'
- brief: "32-bit x86"
- brief: >
- The CPU architecture the host system is running on.
- - id: image.name
- type: string
- brief: >
- Name of the VM image or OS install the host was instantiated from.
- examples: ['infra-ami-eks-worker-node-7d4ec78312', 'CentOS-8-x86_64-1905']
- - id: image.id
- type: string
- brief: >
- VM image ID or host OS image ID. For Cloud, this value is from the provider.
- examples: ['ami-07b06b442921831e5']
- - id: image.version
- type: string
- brief: >
- The version string of the VM image or host OS as defined in
- [Version Attributes](README.md#version-attributes).
- examples: ['0.1']
- - id: ip
- type: string[]
+ - ref: host.id
+ - ref: host.name
+ - ref: host.type
+ - ref: host.arch
+ - ref: host.image.name
+ - ref: host.image.id
+ - ref: host.image.version
+ - ref: host.ip
requirement_level: opt_in
- brief: >
- Available IP addresses of the host, excluding loopback interfaces.
- note: >
- IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses
- MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format.
- examples: ["192.168.1.140", "fe80::abc2:4a28:737a:609e"]
- - id: mac
- type: string[]
+ - ref: host.mac
requirement_level: opt_in
- brief: >
- Available MAC addresses of the host, excluding loopback interfaces.
- note: >
- MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf):
- as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
- examples: ['AC-DE-48-23-45-67', 'AC-DE-48-23-45-67-01-9F']
- id: host.cpu
prefix: host.cpu
@@ -95,43 +23,15 @@ groups:
brief: >
A host's CPU information
attributes:
- - id: vendor.id
+ - ref: host.cpu.vendor.id
requirement_level: opt_in
- type: string
- brief: >
- Processor manufacturer identifier. A maximum 12-character string.
- note: >
- [CPUID](https://wiki.osdev.org/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.
- examples: [ 'GenuineIntel' ]
- - id: family
+ - ref: host.cpu.family
requirement_level: opt_in
- type: int
- brief: >
- Numeric value specifying the family or generation of the CPU.
- examples: [ 6 ]
- - id: model.id
+ - ref: host.cpu.model.id
requirement_level: opt_in
- type: int
- brief: >
- Model identifier. It provides more granular information about the CPU, distinguishing it from
- other CPUs within the same family.
- examples: [ 6 ]
- - id: model.name
+ - ref: host.cpu.model.name
requirement_level: opt_in
- type: string
- brief: >
- Model designation of the processor.
- examples: [ '11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz' ]
- - id: stepping
+ - ref: host.cpu.stepping
requirement_level: opt_in
- type: int
- brief: >
- Stepping or core revisions.
- examples: [ 1 ]
- - id: cache.l2.size
+ - ref: host.cpu.cache.l2.size
requirement_level: opt_in
- type: int
- brief: >
- The amount of level 2 memory cache available to the processor (in Bytes).
- examples: [ 12288000 ]
diff --git a/model/resource/os.yaml b/model/resource/os.yaml
index 78636f8461..772fdde3a0 100644
--- a/model/resource/os.yaml
+++ b/model/resource/os.yaml
@@ -8,62 +8,9 @@ groups:
In case of virtualized environments, this is the operating system as it is observed by
the process, i.e., the virtualized guest rather than the underlying host.
attributes:
- - id: type
- type:
- allow_custom_values: true
- members:
- - id: windows
- value: 'windows'
- brief: "Microsoft Windows"
- - id: linux
- value: 'linux'
- brief: "Linux"
- - id: darwin
- value: 'darwin'
- brief: "Apple Darwin"
- - id: freebsd
- value: 'freebsd'
- brief: "FreeBSD"
- - id: netbsd
- value: 'netbsd'
- brief: "NetBSD"
- - id: openbsd
- value: 'openbsd'
- brief: "OpenBSD"
- - id: dragonflybsd
- value: 'dragonflybsd'
- brief: "DragonFly BSD"
- - id: hpux
- value: 'hpux'
- brief: "HP-UX (Hewlett Packard Unix)"
- - id: aix
- value: 'aix'
- brief: "AIX (Advanced Interactive eXecutive)"
- - id: solaris
- value: 'solaris'
- brief: "SunOS, Oracle Solaris"
- - id: z_os
- value: 'z_os'
- brief: "IBM z/OS"
+ - ref: os.type
requirement_level: required
- brief: 'The operating system type.'
- - id: description
- type: string
- brief: >
- Human readable (not intended to be parsed) OS version information,
- like e.g. reported by `ver` or `lsb_release -a` commands.
- examples: ['Microsoft Windows [Version 10.0.18363.778]', 'Ubuntu 18.04.1 LTS']
- - id: name
- type: string
- brief: 'Human readable operating system name.'
- examples: ['iOS', 'Android', 'Ubuntu']
- - id: version
- type: string
- brief: >
- The version string of the operating system as defined in
- [Version Attributes](/docs/resource/README.md#version-attributes).
- examples: ['14.2.1', '18.04.1']
- - id: build_id
- type: string
- brief: 'Unique identifier for a particular build or compilation of the operating system.'
- examples: ['TQ3C.230805.001.B2', '20E247', '22621']
+ - ref: os.description
+ - ref: os.name
+ - ref: os.version
+ - ref: os.build_id
diff --git a/model/resource/process.yaml b/model/resource/process.yaml
index d7d3b25b56..54b141cc6d 100644
--- a/model/resource/process.yaml
+++ b/model/resource/process.yaml
@@ -5,69 +5,24 @@ groups:
brief: >
An operating system process.
attributes:
- - id: pid
- type: int
- brief: >
- Process identifier (PID).
- examples: [1234]
- - id: parent_pid
- type: int
- brief: >
- Parent Process identifier (PID).
- examples: [111]
- - id: executable.name
- type: string
+ - ref: process.pid
+ - ref: process.parent_pid
+ - ref: process.executable.name
requirement_level:
conditionally_required: See alternative attributes below.
- brief: >
- The name of the process executable. On Linux based systems, can be set
- to the `Name` in `proc/[pid]/status`. On Windows, can be set to the
- base name of `GetProcessImageFileNameW`.
- examples: ['otelcol']
- - id: executable.path
- type: string
+ - ref: process.executable.path
requirement_level:
conditionally_required: See alternative attributes below.
- brief: >
- The full path to the process executable. On Linux based systems, can
- be set to the target of `proc/[pid]/exe`. On Windows, can be set to the
- result of `GetProcessImageFileNameW`.
- examples: ['/usr/bin/cmd/otelcol']
- - id: command
- type: string
+ - ref: process.command
requirement_level:
conditionally_required: See alternative attributes below.
- brief: >
- 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`.
- examples: ['cmd/otelcol']
- - id: command_line
- type: string
+ - ref: process.command_line
requirement_level:
conditionally_required: See alternative attributes below.
- brief: >
- The full command used to launch the process as a single string representing
- the full command. On Windows, can be set to the result of `GetCommandLineW`.
- Do not set this if you have to assemble it just for monitoring; use
- `process.command_args` instead.
- examples: ['C:\cmd\otecol --config="my directory\config.yaml"']
- - id: command_args
- type: string[]
+ - ref: process.command_args
requirement_level:
conditionally_required: See alternative attributes below.
- brief: >
- All the command arguments (including the command/executable itself) as
- received by the process. On Linux-based systems (and some other Unixoid
- systems supporting procfs), can be set according to the list of
- null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based
- executables, this would be the full argv vector passed to `main`.
- examples: ['cmd/otecol', '--config=config.yaml']
- - id: owner
- type: string
- brief: >
- The username of the user that owns the process.
- examples: 'root'
+ - ref: process.owner
constraints:
- any_of:
- process.executable.name
diff --git a/schema-next.yaml b/schema-next.yaml
index 4c3647ce4d..4f618de046 100644
--- a/schema-next.yaml
+++ b/schema-next.yaml
@@ -2,6 +2,7 @@ file_format: 1.1.0
schema_url: https://opentelemetry.io/schemas/next
versions:
next:
+ 1.23.0:
metrics:
changes:
# https://github.com/open-telemetry/semantic-conventions/pull/20
diff --git a/schemas/1.23.0 b/schemas/1.23.0
new file mode 100644
index 0000000000..a6e29937d0
--- /dev/null
+++ b/schemas/1.23.0
@@ -0,0 +1,293 @@
+file_format: 1.1.0
+schema_url: https://opentelemetry.io/schemas/1.23.0
+versions:
+ 1.23.0:
+ metrics:
+ changes:
+ # https://github.com/open-telemetry/semantic-conventions/pull/20
+ - rename_attributes:
+ attribute_map:
+ thread.daemon: jvm.thread.daemon
+ apply_to_metrics:
+ - jvm.thread.count
+ 1.22.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/semantic-conventions/pull/229
+ - rename_attributes:
+ attribute_map:
+ messaging.message.payload_size_bytes: messaging.message.body.size
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/374
+ - rename_attributes:
+ attribute_map:
+ http.resend_count: http.request.resend_count
+ metrics:
+ changes:
+ # https://github.com/open-telemetry/semantic-conventions/pull/224
+ - rename_metrics:
+ http.client.duration: http.client.request.duration
+ http.server.duration: http.server.request.duration
+ # https://github.com/open-telemetry/semantic-conventions/pull/241
+ - rename_metrics:
+ process.runtime.jvm.memory.usage: jvm.memory.usage
+ process.runtime.jvm.memory.committed: jvm.memory.committed
+ process.runtime.jvm.memory.limit: jvm.memory.limit
+ process.runtime.jvm.memory.usage_after_last_gc: jvm.memory.usage_after_last_gc
+ process.runtime.jvm.gc.duration: jvm.gc.duration
+ # also https://github.com/open-telemetry/semantic-conventions/pull/252
+ process.runtime.jvm.threads.count: jvm.thread.count
+ # also https://github.com/open-telemetry/semantic-conventions/pull/252
+ process.runtime.jvm.classes.loaded: jvm.class.loaded
+ # also https://github.com/open-telemetry/semantic-conventions/pull/252
+ process.runtime.jvm.classes.unloaded: jvm.class.unloaded
+ # also https://github.com/open-telemetry/semantic-conventions/pull/252
+ # and https://github.com/open-telemetry/semantic-conventions/pull/60
+ process.runtime.jvm.classes.current_loaded: jvm.class.count
+ process.runtime.jvm.cpu.time: jvm.cpu.time
+ process.runtime.jvm.cpu.recent_utilization: jvm.cpu.recent_utilization
+ process.runtime.jvm.memory.init: jvm.memory.init
+ process.runtime.jvm.system.cpu.utilization: jvm.system.cpu.utilization
+ process.runtime.jvm.system.cpu.load_1m: jvm.system.cpu.load_1m
+ # https://github.com/open-telemetry/semantic-conventions/pull/253
+ process.runtime.jvm.buffer.usage: jvm.buffer.memory.usage
+ # https://github.com/open-telemetry/semantic-conventions/pull/253
+ process.runtime.jvm.buffer.limit: jvm.buffer.memory.limit
+ process.runtime.jvm.buffer.count: jvm.buffer.count
+ # https://github.com/open-telemetry/semantic-conventions/pull/20
+ - rename_attributes:
+ attribute_map:
+ type: jvm.memory.type
+ pool: jvm.memory.pool.name
+ apply_to_metrics:
+ - jvm.memory.usage
+ - jvm.memory.committed
+ - jvm.memory.limit
+ - jvm.memory.usage_after_last_gc
+ - jvm.memory.init
+ - rename_attributes:
+ attribute_map:
+ name: jvm.gc.name
+ action: jvm.gc.action
+ apply_to_metrics:
+ - jvm.gc.duration
+ - rename_attributes:
+ attribute_map:
+ daemon: thread.daemon
+ apply_to_metrics:
+ - jvm.threads.count
+ - rename_attributes:
+ attribute_map:
+ pool: jvm.buffer.pool.name
+ apply_to_metrics:
+ - jvm.buffer.usage
+ - jvm.buffer.limit
+ - jvm.buffer.count
+ # https://github.com/open-telemetry/semantic-conventions/pull/89
+ - rename_attributes:
+ attribute_map:
+ state: system.cpu.state
+ cpu: system.cpu.logical_number
+ apply_to_metrics:
+ - system.cpu.time
+ - system.cpu.utilization
+ - rename_attributes:
+ attribute_map:
+ state: system.memory.state
+ apply_to_metrics:
+ - system.memory.usage
+ - system.memory.utilization
+ - rename_attributes:
+ attribute_map:
+ state: system.paging.state
+ apply_to_metrics:
+ - system.paging.usage
+ - system.paging.utilization
+ - rename_attributes:
+ attribute_map:
+ type: system.paging.type
+ direction: system.paging.direction
+ apply_to_metrics:
+ - system.paging.faults
+ - system.paging.operations
+ - rename_attributes:
+ attribute_map:
+ device: system.device
+ direction: system.disk.direction
+ apply_to_metrics:
+ - system.disk.io
+ - system.disk.operations
+ - system.disk.io_time
+ - system.disk.operation_time
+ - system.disk.merged
+ - rename_attributes:
+ attribute_map:
+ device: system.device
+ state: system.filesystem.state
+ type: system.filesystem.type
+ mode: system.filesystem.mode
+ mountpoint: system.filesystem.mountpoint
+ apply_to_metrics:
+ - system.filesystem.usage
+ - system.filesystem.utilization
+ - rename_attributes:
+ attribute_map:
+ device: system.device
+ direction: system.network.direction
+ protocol: network.protocol
+ state: system.network.state
+ apply_to_metrics:
+ - system.network.dropped
+ - system.network.packets
+ - system.network.errors
+ - system.network.io
+ - system.network.connections
+ - rename_attributes:
+ attribute_map:
+ status: system.processes.status
+ apply_to_metrics:
+ - system.processes.count
+ # https://github.com/open-telemetry/semantic-conventions/pull/247
+ - rename_metrics:
+ http.server.request.size: http.server.request.body.size
+ http.server.response.size: http.server.response.body.size
+ resources:
+ changes:
+ # https://github.com/open-telemetry/semantic-conventions/pull/178
+ - rename_attributes:
+ attribute_map:
+ telemetry.auto.version: telemetry.distro.version
+ 1.21.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3336
+ - rename_attributes:
+ attribute_map:
+ messaging.kafka.client_id: messaging.client_id
+ messaging.rocketmq.client_id: messaging.client_id
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3402
+ - rename_attributes:
+ attribute_map:
+ # net.peer.(name|port) attributes were usually populated on client side
+ # so they should be usually translated to server.(address|port)
+ # net.host.* attributes were only populated on server side
+ net.host.name: server.address
+ net.host.port: server.port
+ # was only populated on client side
+ net.sock.peer.name: server.socket.domain
+ # net.sock.peer.(addr|port) mapping is not possible
+ # since they applied to both client and server side
+ # were only populated on server side
+ net.sock.host.addr: server.socket.address
+ net.sock.host.port: server.socket.port
+ http.client_ip: client.address
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3426
+ - rename_attributes:
+ attribute_map:
+ net.protocol.name: network.protocol.name
+ net.protocol.version: network.protocol.version
+ net.host.connection.type: network.connection.type
+ net.host.connection.subtype: network.connection.subtype
+ net.host.carrier.name: network.carrier.name
+ net.host.carrier.mcc: network.carrier.mcc
+ net.host.carrier.mnc: network.carrier.mnc
+ net.host.carrier.icc: network.carrier.icc
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3355
+ - rename_attributes:
+ attribute_map:
+ http.method: http.request.method
+ http.status_code: http.response.status_code
+ http.scheme: url.scheme
+ http.url: url.full
+ http.request_content_length: http.request.body.size
+ http.response_content_length: http.response.body.size
+ metrics:
+ changes:
+ # https://github.com/open-telemetry/semantic-conventions/pull/53
+ - rename_metrics:
+ process.runtime.jvm.cpu.utilization: process.runtime.jvm.cpu.recent_utilization
+ 1.20.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3272
+ - rename_attributes:
+ attribute_map:
+ net.app.protocol.name: net.protocol.name
+ net.app.protocol.version: net.protocol.version
+ 1.19.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3209
+ - rename_attributes:
+ attribute_map:
+ faas.execution: faas.invocation_id
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3188
+ - rename_attributes:
+ attribute_map:
+ faas.id: cloud.resource_id
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3190
+ - rename_attributes:
+ attribute_map:
+ http.user_agent: user_agent.original
+ resources:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/3190
+ - rename_attributes:
+ attribute_map:
+ browser.user_agent: user_agent.original
+ 1.18.0:
+ 1.17.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/2957
+ - rename_attributes:
+ attribute_map:
+ messaging.consumer_id: messaging.consumer.id
+ messaging.protocol: net.app.protocol.name
+ messaging.protocol_version: net.app.protocol.version
+ messaging.destination: messaging.destination.name
+ messaging.temp_destination: messaging.destination.temporary
+ messaging.destination_kind: messaging.destination.kind
+ messaging.message_id: messaging.message.id
+ messaging.conversation_id: messaging.message.conversation_id
+ messaging.message_payload_size_bytes: messaging.message.payload_size_bytes
+ messaging.message_payload_compressed_size_bytes: messaging.message.payload_compressed_size_bytes
+ messaging.rabbitmq.routing_key: messaging.rabbitmq.destination.routing_key
+ messaging.kafka.message_key: messaging.kafka.message.key
+ messaging.kafka.partition: messaging.kafka.destination.partition
+ messaging.kafka.tombstone: messaging.kafka.message.tombstone
+ messaging.rocketmq.message_type: messaging.rocketmq.message.type
+ messaging.rocketmq.message_tag: messaging.rocketmq.message.tag
+ messaging.rocketmq.message_keys: messaging.rocketmq.message.keys
+ messaging.kafka.consumer_group: messaging.kafka.consumer.group
+ 1.16.0:
+ 1.15.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/2743
+ - rename_attributes:
+ attribute_map:
+ http.retry_count: http.resend_count
+ 1.14.0:
+ 1.13.0:
+ spans:
+ changes:
+ # https://github.com/open-telemetry/opentelemetry-specification/pull/2614
+ - rename_attributes:
+ attribute_map:
+ net.peer.ip: net.sock.peer.addr
+ net.host.ip: net.sock.host.addr
+ 1.12.0:
+ 1.11.0:
+ 1.10.0:
+ 1.9.0:
+ 1.8.0:
+ spans:
+ changes:
+ - rename_attributes:
+ attribute_map:
+ db.cassandra.keyspace: db.name
+ db.hbase.namespace: db.name
+ 1.7.0:
+ 1.6.1:
+ 1.5.0:
+ 1.4.0: