View Source OpenTelemetry.SemConv.NetworkAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Network attributes.

Summary

Types

network_transport_values()

OSI transport layer or inter-process communication method.

network_type_values()

OSI network layer or non-OSI equivalent.

Functions

network_local_address()

Local address of the network connection - IP address or Unix domain socket name.

network_local_port()

Local port number of the network connection.

network_peer_address()

Peer address of the network connection - IP address or Unix domain socket name.

network_peer_port()

Peer port number of the network connection.

network_protocol_name()

OSI application layer or non-OSI equivalent.

network_protocol_version()

The actual version of the protocol used for network communication.

network_transport()

OSI transport layer or inter-process communication method.

network_transport_values()

network_type()

OSI network layer or non-OSI equivalent.

network_type_values()

Types

network_transport_values()

@type network_transport_values() :: %{
  tcp: :tcp,
  udp: :udp,
  pipe: :pipe,
  unix: :unix,
  quic: :quic
}

OSI transport layer or inter-process communication method.

Enum Values

:tcp - TCP
:udp - UDP
:pipe - Named or anonymous pipe.
:unix - Unix domain socket
:quic ^e - QUIC

network_type_values()

@type network_type_values() :: %{ipv4: :ipv4, ipv6: :ipv6}

OSI network layer or non-OSI equivalent.

Enum Values

:ipv4 - IPv4
:ipv6 - IPv6

Functions

network_local_address()

@spec network_local_address() :: :"network.local.address"

Local address of the network connection - IP address or Unix domain socket name.

Value type

Value must be of type atom() | String.t().

Examples

["10.1.2.80", "/tmp/my.sock"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_local_address()
:"network.local.address"

?NETWORK_LOCAL_ADDRESS.
'network.local.address'

network_local_port()

@spec network_local_port() :: :"network.local.port"

Local port number of the network connection.

Value type

Value must be of type integer().

Examples

[65123]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_local_port()
:"network.local.port"

?NETWORK_LOCAL_PORT.
'network.local.port'

network_peer_address()

@spec network_peer_address() :: :"network.peer.address"

Peer address of the network connection - IP address or Unix domain socket name.

Value type

Value must be of type atom() | String.t().

Examples

["10.1.2.80", "/tmp/my.sock"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_peer_address()
:"network.peer.address"

?NETWORK_PEER_ADDRESS.
'network.peer.address'

network_peer_port()

@spec network_peer_port() :: :"network.peer.port"

Peer port number of the network connection.

Value type

Value must be of type integer().

Examples

[65123]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_peer_port()
:"network.peer.port"

?NETWORK_PEER_PORT.
'network.peer.port'

network_protocol_name()

@spec network_protocol_name() :: :"network.protocol.name"

OSI application layer or non-OSI equivalent.

Value type

Value must be of type atom() | String.t().

Notes

The value SHOULD be normalized to lowercase.

Examples

["amqp", "http", "mqtt"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_protocol_name()
:"network.protocol.name"

?NETWORK_PROTOCOL_NAME.
'network.protocol.name'

network_protocol_version()

@spec network_protocol_version() :: :"network.protocol.version"

The actual version of the protocol used for network communication.

Value type

Value must be of type atom() | String.t().

Notes

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.

Examples

["1.1", "2"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_protocol_version()
:"network.protocol.version"

?NETWORK_PROTOCOL_VERSION.
'network.protocol.version'

network_transport()

@spec network_transport() :: :"network.transport"

OSI transport layer or inter-process communication method.

Notes

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.

Examples

["tcp", "udp"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_transport()
:"network.transport"

iex> OpenTelemetry.SemConv.NetworkAttributes.network_transport_values().tcp
:tcp

iex> %{OpenTelemetry.SemConv.NetworkAttributes.network_transport() => OpenTelemetry.SemConv.NetworkAttributes.network_transport_values().tcp}
%{:"network.transport" => :tcp}

?NETWORK_TRANSPORT.
'network.transport'

?NETWORK_TRANSPORT_VALUES_TCP.
'tcp'

#{?NETWORK_TRANSPORT => ?NETWORK_TRANSPORT_VALUES_TCP}.
#{'network.transport' => 'tcp'}

network_transport_values()

@spec network_transport_values() :: network_transport_values()

network_type()

@spec network_type() :: :"network.type"

OSI network layer or non-OSI equivalent.

Notes

The value SHOULD be normalized to lowercase.

Examples

["ipv4", "ipv6"]

iex> OpenTelemetry.SemConv.NetworkAttributes.network_type()
:"network.type"

iex> OpenTelemetry.SemConv.NetworkAttributes.network_type_values().ipv4
:ipv4

iex> %{OpenTelemetry.SemConv.NetworkAttributes.network_type() => OpenTelemetry.SemConv.NetworkAttributes.network_type_values().ipv4}
%{:"network.type" => :ipv4}

?NETWORK_TYPE.
'network.type'

?NETWORK_TYPE_VALUES_IPV4.
'ipv4'

#{?NETWORK_TYPE => ?NETWORK_TYPE_VALUES_IPV4}.
#{'network.type' => 'ipv4'}

network_type_values()

@spec network_type_values() :: network_type_values()