open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/attributes-registry/network.md

19 KiB
Raw Blame History

Network

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
network.carrier.mcc string The mobile carrier country code. 310 Experimental
network.carrier.mnc string The mobile carrier network code. 001 Experimental
network.carrier.name string The name of the mobile carrier. sprint Experimental
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
network.connection.type string The internet connection type. wifi Experimental
network.io.direction string The network IO operation direction. transmit Experimental
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
network.local.port int Local port number of the network connection. 65123 Stable
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
network.peer.port int Peer port number of the network connection. 65123 Stable
network.protocol.name string OSI application layer or non-OSI equivalent. [1] amqp; http; mqtt Stable
network.protocol.version string The actual version of the protocol used for network communication. [2] 1.1; 2 Stable
network.transport string OSI transport layer or inter-process communication method. [3] tcp; udp Stable
network.type string OSI network layer or non-OSI equivalent. [4] ipv4; ipv6 Stable

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

[2]: If protocol version is subject to negotiation (for example using ALPN), 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
cdma2000_1xrtt CDMA2000 1XRTT Experimental
edge EDGE Experimental
ehrpd EHRPD Experimental
evdo_0 EVDO Rel. 0 Experimental
evdo_a EVDO Rev. A Experimental
evdo_b EVDO Rev. B Experimental
gprs GPRS Experimental
gsm GSM Experimental
hsdpa HSDPA Experimental
hspa HSPA Experimental
hspap HSPAP Experimental
hsupa HSUPA Experimental
iden IDEN Experimental
iwlan IWLAN Experimental
lte LTE Experimental
lte_ca LTE CA Experimental
nr 5G NR (New Radio) Experimental
nrnsa 5G NRNSA (New Radio Non-Standalone) Experimental
td_scdma TD-SCDMA Experimental
umts UMTS Experimental

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
unavailable unavailable Experimental
unknown unknown Experimental
wifi wifi Experimental
wired wired Experimental

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
transmit transmit Experimental

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
quic QUIC Experimental
tcp TCP Stable
udp UDP Stable
unix Unix domain socket Stable

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
ipv6 IPv6 Stable

Deprecated Network 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
Replaced by network.local.address.
net.host.name string Deprecated, use server.address. example.com Deprecated
Replaced by server.address.
net.host.port int Deprecated, use server.port. 8080 Deprecated
Replaced by server.port.
net.peer.ip string Deprecated, use network.peer.address. 127.0.0.1 Deprecated
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
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
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
Replaced by network.protocol.name.
net.protocol.version string Deprecated, use network.protocol.version. 3.1.1 Deprecated
Replaced by network.protocol.version.
net.sock.family string Deprecated, use network.transport and network.type. inet; inet6; unix Deprecated
Split to network.transport and network.type.
net.sock.host.addr string Deprecated, use network.local.address. /var/my.sock Deprecated
Replaced by network.local.address.
net.sock.host.port int Deprecated, use network.local.port. 8080 Deprecated
Replaced by network.local.port.
net.sock.peer.addr string Deprecated, use network.peer.address. 192.168.0.1 Deprecated
Replaced by network.peer.address.
net.sock.peer.name string Deprecated, no replacement at this time. /var/my.sock Deprecated
Removed.
net.sock.peer.port int Deprecated, use network.peer.port. 65531 Deprecated
Replaced by network.peer.port.
net.transport string Deprecated, use network.transport. ip_tcp; ip_udp; pipe Deprecated
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
inet6 IPv6 address Experimental
unix Unix domain socket path Experimental

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
ip_tcp ip_tcp Experimental
ip_udp ip_udp Experimental
other Something else (non IP-based). Experimental
pipe Named or anonymous pipe. Experimental

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