<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Network

- [Network](#network-attributes)
- [Network Deprecated](#network-deprecated-attributes)

## Network Attributes

These attributes may be used for any network related operation.

| Attribute                    | Type   | Description                                                                                                                                                                       | Examples                    | Stability                                                        |
| ---------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ---------------------------------------------------------------- |
| `network.carrier.icc`        | string | The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network.                                                                                       | `DE`                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.carrier.mcc`        | string | The mobile carrier country code.                                                                                                                                                  | `310`                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.carrier.mnc`        | string | The mobile carrier network code.                                                                                                                                                  | `001`                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.carrier.name`       | string | The name of the mobile carrier.                                                                                                                                                   | `sprint`                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `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`                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.connection.type`    | string | The internet connection type.                                                                                                                                                     | `wifi`                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.io.direction`       | string | The network IO operation direction.                                                                                                                                               | `transmit`                  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network.local.address`      | string | Local address of the network connection - IP address or Unix domain socket name.                                                                                                  | `10.1.2.80`; `/tmp/my.sock` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.local.port`         | int    | Local port number of the network connection.                                                                                                                                      | `65123`                     | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.peer.address`       | string | Peer address of the network connection - IP address or Unix domain socket name.                                                                                                   | `10.1.2.80`; `/tmp/my.sock` | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.peer.port`          | int    | Peer port number of the network connection.                                                                                                                                       | `65123`                     | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.protocol.name`      | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [1]                                                                                      | `amqp`; `http`; `mqtt`      | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.protocol.version`   | string | The actual version of the protocol used for network communication. [2]                                                                                                            | `1.1`; `2`                  | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `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`                | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |
| `network.type`               | string | [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. [4]                                                                                              | `ipv4`; `ipv6`              | ![Stable](https://img.shields.io/badge/-stable-lightgreen)       |

**[1]:** The value SHOULD be normalized to lowercase.

**[2]:** If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

**[3]:** The value SHOULD be normalized to lowercase.

Consider always setting the transport when setting a port number, since
a port number is ambiguous without knowing the transport. For example
different processes could be listening on TCP port 12345 and UDP port 12345.

**[4]:** The value SHOULD be normalized to lowercase.

`network.connection.subtype` 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                         | Stability                                                        |
| ---------------- | ----------------------------------- | ---------------------------------------------------------------- |
| `cdma`           | CDMA                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cdma2000_1xrtt` | CDMA2000 1XRTT                      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `edge`           | EDGE                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ehrpd`          | EHRPD                               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `evdo_0`         | EVDO Rel. 0                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `evdo_a`         | EVDO Rev. A                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `evdo_b`         | EVDO Rev. B                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `gprs`           | GPRS                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `gsm`            | GSM                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hsdpa`          | HSDPA                               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hspa`           | HSPA                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hspap`          | HSPAP                               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hsupa`          | HSUPA                               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `iden`           | IDEN                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `iwlan`          | IWLAN                               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `lte`            | LTE                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `lte_ca`         | LTE CA                              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `nr`             | 5G NR (New Radio)                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `nrnsa`          | 5G NRNSA (New Radio Non-Standalone) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `td_scdma`       | TD-SCDMA                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `umts`           | UMTS                                | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`network.connection.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 | Stability                                                        |
| ------------- | ----------- | ---------------------------------------------------------------- |
| `cell`        | cell        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unavailable` | unavailable | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unknown`     | unknown     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `wifi`        | wifi        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `wired`       | wired       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`network.io.direction` 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 | Stability                                                        |
| ---------- | ----------- | ---------------------------------------------------------------- |
| `receive`  | receive     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `transmit` | transmit    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`network.transport` 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              | Stability                                                  |
| ------ | ------------------------ | ---------------------------------------------------------- |
| `pipe` | Named or anonymous pipe. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `tcp`  | TCP                      | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `udp`  | UDP                      | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `unix` | Unix domain socket       | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

`network.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 | Stability                                                  |
| ------ | ----------- | ---------------------------------------------------------- |
| `ipv4` | IPv4        | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
| `ipv6` | IPv6        | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

## Network Deprecated Attributes

These attributes may be used for any network related operation.

| Attribute              | Type   | Description                                                                            | Examples                   | Stability                                                                                                                                         |
| ---------------------- | ------ | -------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `net.host.ip`          | string | Deprecated, use `network.local.address`.                                               | `192.168.0.1`              | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.local.address`.                                               |
| `net.host.name`        | string | Deprecated, use `server.address`.                                                      | `example.com`              | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `server.address`.                                                      |
| `net.host.port`        | int    | Deprecated, use `server.port`.                                                         | `8080`                     | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `server.port`.                                                         |
| `net.peer.ip`          | string | Deprecated, use `network.peer.address`.                                                | `127.0.0.1`                | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.peer.address`.                                                |
| `net.peer.name`        | string | Deprecated, use `server.address` on client spans and `client.address` on server spans. | `example.com`              | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `server.address` on client spans and `client.address` on server spans. |
| `net.peer.port`        | int    | Deprecated, use `server.port` on client spans and `client.port` on server spans.       | `8080`                     | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `server.port` on client spans and `client.port` on server spans.       |
| `net.protocol.name`    | string | Deprecated, use `network.protocol.name`.                                               | `amqp`; `http`; `mqtt`     | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.protocol.name`.                                               |
| `net.protocol.version` | string | Deprecated, use `network.protocol.version`.                                            | `3.1.1`                    | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.protocol.version`.                                            |
| `net.sock.family`      | string | Deprecated, use `network.transport` and `network.type`.                                | `inet`; `inet6`; `unix`    | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Split to `network.transport` and `network.type`.                                   |
| `net.sock.host.addr`   | string | Deprecated, use `network.local.address`.                                               | `/var/my.sock`             | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.local.address`.                                               |
| `net.sock.host.port`   | int    | Deprecated, use `network.local.port`.                                                  | `8080`                     | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.local.port`.                                                  |
| `net.sock.peer.addr`   | string | Deprecated, use `network.peer.address`.                                                | `192.168.0.1`              | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.peer.address`.                                                |
| `net.sock.peer.name`   | string | Deprecated, no replacement at this time.                                               | `/var/my.sock`             | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed.                                                                           |
| `net.sock.peer.port`   | int    | Deprecated, use `network.peer.port`.                                                   | `65531`                    | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.peer.port`.                                                   |
| `net.transport`        | string | Deprecated, use `network.transport`.                                                   | `ip_tcp`; `ip_udp`; `pipe` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `network.transport`.                                                   |

`net.sock.family` 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             | Stability                                                        |
| ------- | ----------------------- | ---------------------------------------------------------------- |
| `inet`  | IPv4 address            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `inet6` | IPv6 address            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `unix`  | Unix domain socket path | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`net.transport` 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                    | Stability                                                        |
| -------- | ------------------------------ | ---------------------------------------------------------------- |
| `inproc` | In-process communication. [5]  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ip_tcp` | ip_tcp                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ip_udp` | ip_udp                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `other`  | Something else (non IP-based). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `pipe`   | Named or anonymous pipe.       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[5]:** Signals that there is only in-process communication not using a "real" network protocol in cases where network attributes would normally be expected. Usually all other network attributes can be left out in that case.
